Record Class UserMFA.Held

java.lang.Object
java.lang.Record
com.iizix.server.user.mfa.UserMFA.Held
Record Components:
uid - The user ID of the user whose first factor passed.
userName - The user name.
enrolmentRequired - Whether the user has no second factor and the policy requires one: the sign-in waits for the enrolment, not for a code.
Enclosing class:
UserMFA
public static record UserMFA.Held(long uid, String userName, boolean enrolmentRequired) extends Record
A sign-in that waits for its second factor.
Author:
Christopher Mindus

  • Constructor Details

    • Held

      public Held(long uid, String userName, boolean enrolmentRequired)
      Creates an instance of a Held record class.
      Parameters:
      uid - the value for the uid record component
      userName - the value for the userName record component
      enrolmentRequired - the value for the enrolmentRequired record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • uid

      public long uid()
      Returns the value of the uid record component.
      Returns:
      the value of the uid record component

    • userName

      public String userName()
      Returns the value of the userName record component.
      Returns:
      the value of the userName record component

    • enrolmentRequired

      public boolean enrolmentRequired()
      Returns the value of the enrolmentRequired record component.
      Returns:
      the value of the enrolmentRequired record component