Package org.alfresco.repo.security.authentication.identityservice

Record Class UserTokenRequest

java.lang.Object
java.lang.Record
org.alfresco.repo.security.authentication.identityservice.UserTokenRequest
public record UserTokenRequest(String username, char[] password) extends Record
Credential pair presented to a UserTokenProvider.

Centralises null-validation of the inputs (mirrors the pattern in IdentityServiceFacade.AuthorizationGrant.password(String, String)) so that every UserTokenProvider implementation can rely on non-null fields. toString() is overridden to suppress the password (the record-default would echo the char[] array's identity hash) and to keep the user name visible for log/diagnostic purposes.

Password lifetime: the supplied char[] reference is held by this record only for the duration of the getUserToken(...) call. Implementations MUST NOT retain a reference to the array (or to the request) past method return.

  • Constructor Summary

    Constructors
    Constructor
    Description
    UserTokenRequest(String username, char[] password)
    Creates an instance of a UserTokenRequest record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    char[]
    password()
    Returns the value of the password record component.
    String
    toString()
    Overrides the record-generated toString() to suppress the password component.
    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

  • Constructor Details

    • UserTokenRequest

      public UserTokenRequest(String username, char[] password)
      Creates an instance of a UserTokenRequest record class.
      Parameters:
      username - the value for the username record component
      password - the value for the password record component

  • Method Details

    • toString

      public String toString()
      Overrides the record-generated toString() to suppress the password component. Only the user name is exposed so accidental log/print statements cannot leak the credential.
      Specified by:
      toString in class Record

    • 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

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

    • password

      public char[] password()
      Returns the value of the password record component.
      Returns:
      the value of the password record component