Package org.atmosphere.auth

Record Class TokenValidator.Valid

java.lang.Object
java.lang.Record
org.atmosphere.auth.TokenValidator.Valid
Record Components:
principal - the authenticated identity
claims - arbitrary key-value claims extracted from the token (may be empty)
All Implemented Interfaces:
TokenValidator.Result
Enclosing interface:
TokenValidator
public static record TokenValidator.Valid(Principal principal, Map<String,Object> claims) extends Record implements TokenValidator.Result
The token is valid. Carries the authenticated principal and optional claims.

  • Constructor Details

    • Valid

      public Valid(String name, Map<String,Object> claims)
      Convenience constructor using a simple name string as the principal.
      Parameters:
      name - the principal name
      claims - arbitrary claims

    • Valid

      public Valid(String name)
      Convenience constructor with just a name and no claims.
      Parameters:
      name - the principal name

    • Valid

      public Valid(Principal principal, Map<String,Object> claims)
      Creates an instance of a Valid record class.
      Parameters:
      principal - the value for the principal record component
      claims - the value for the claims 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.

    • principal

      public Principal principal()
      Returns the value of the principal record component.
      Returns:
      the value of the principal record component

    • claims

      public Map<String,Object> claims()
      Returns the value of the claims record component.
      Returns:
      the value of the claims record component