Package com.inductiveautomation.ignition.gateway.auth.apitoken

Record Class ApiTokenManager.ApiTokenContext

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.auth.apitoken.ApiTokenManager.ApiTokenContext
Record Components:
tokenName - the token name
securityLevels - the security levels granted to the token
Enclosing interface:
ApiTokenManager
public static record ApiTokenManager.ApiTokenContext(String tokenName, com.google.common.collect.ImmutableCollection<SecurityLevelConfig> securityLevels) extends Record
Context object contains the name of the token associated with an HTTP Request as well as which security levels are granted to the token

  • Constructor Details

    • ApiTokenContext

      public ApiTokenContext(String tokenName, com.google.common.collect.ImmutableCollection<SecurityLevelConfig> securityLevels)
      Creates an instance of a ApiTokenContext record class.
      Parameters:
      tokenName - the value for the tokenName record component
      securityLevels - the value for the securityLevels 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. 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.

    • tokenName

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

    • securityLevels

      public com.google.common.collect.ImmutableCollection<SecurityLevelConfig> securityLevels()
      Returns the value of the securityLevels record component.
      Returns:
      the value of the securityLevels record component