Package com.inductiveautomation.ignition.common.user

Record Class BadgeAuthChallenge

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.user.BadgeAuthChallenge
Record Components:
badge - The value of the badge.
secret - Optional - a cleartext secret value associated with this badge, such as a PIN.
All Implemented Interfaces:
AuthChallenge, Serializable
public record BadgeAuthChallenge(@Nonnull String badge, @Nullable String secret) extends Record implements AuthChallenge
An encoded representation of a badge auth challenge.
See Also:

  • Constructor Details

    • BadgeAuthChallenge

      public BadgeAuthChallenge(@Nonnull String badge, @Nullable String secret)
      Creates an instance of a BadgeAuthChallenge record class.
      Parameters:
      badge - the value for the badge record component
      secret - the value for the secret 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

    • hasSecret

      public boolean hasSecret()

    • 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. 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.

    • badge

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

    • secret

      @Nullable public String secret()
      Returns the value of the secret record component.
      Returns:
      the value of the secret record component