Package com.inductiveautomation.ignition.common.user

Record Class SimpleAuthChallenge

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.user.SimpleAuthChallenge
Record Components:
username - The cleartext representation of a username.
password - The cleartext representation of a password.
All Implemented Interfaces:
AuthChallenge, Serializable
public record SimpleAuthChallenge(@Nonnull String username, @Nonnull String password) extends Record implements AuthChallenge
A simple username and password pair.
See Also:

  • Constructor Details

    • SimpleAuthChallenge

      public SimpleAuthChallenge(@Nonnull String username, @Nonnull String password)
      Creates an instance of a SimpleAuthChallenge record class.
      Parameters:
      username - the value for the username record component
      password - the value for the password record component

  • Method Details

    • getActor

      public String getActor()
      Description copied from interface: AuthChallenge
      A human-presentable string representation of the "actor" behind this auth challenge.
      Specified by:
      getActor in interface AuthChallenge

    • toString

      public 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • username

      @Nonnull public String username()
      Returns the value of the username record component.
      Returns:
      the value of the username record component

    • password

      @Nonnull public String password()
      Returns the value of the password record component.
      Returns:
      the value of the password record component