Package com.inductiveautomation.ignition.common.user

Record Class ADSSOAuthChallenge

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.user.ADSSOAuthChallenge
All Implemented Interfaces:
AuthChallenge, Serializable
public record ADSSOAuthChallenge(@Nonnull String username, @Nonnull String domain) extends Record implements AuthChallenge
Auth challenge that contains a username and AD domain to attempt an SSO login
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DOMAIN_KEY
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ADSSOAuthChallenge(String username, String domain)
    Creates an instance of a ADSSOAuthChallenge record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    domain()
    Returns the value of the domain record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    getActor()
    A human-presentable string representation of the "actor" behind this auth challenge.
    final int
    hashCode()
    Returns a hash code value for this object.
    static ADSSOAuthChallenge
    ofLocalSystem()
    Utility method to grab the current active directory username and domain name.
    final String
    toString()
    Returns a string representation of this record class.
    String
    username()
    Returns the value of the username record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • ADSSOAuthChallenge

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

    • ofLocalSystem

      @Nullable public static ADSSOAuthChallenge ofLocalSystem()
      Utility method to grab the current active directory username and domain name. Will fail on anything but Windows, of course.

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

    • username

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

    • domain

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