Class RememberMeAuthenticationToken

java.lang.Object
org.springframework.security.authentication.AbstractAuthenticationToken
org.springframework.security.authentication.RememberMeAuthenticationToken
All Implemented Interfaces:
Serializable, Principal, Authentication, CredentialsContainer

public class RememberMeAuthenticationToken extends AbstractAuthenticationToken
Represents a remembered Authentication.

A remembered Authentication must provide a fully valid Authentication, including the GrantedAuthoritys that apply.

See Also:
  • Constructor Details

    • RememberMeAuthenticationToken

      public RememberMeAuthenticationToken(String key, Object principal, Collection<? extends GrantedAuthority> authorities)
      Constructor.
      Parameters:
      key - to identify if this object made by an authorised client
      principal - the principal (typically a UserDetails)
      authorities - the authorities granted to the principal
      Throws:
      IllegalArgumentException - if a null was passed
    • RememberMeAuthenticationToken

      protected RememberMeAuthenticationToken(RememberMeAuthenticationToken.Builder<?> builder)
  • Method Details

    • getCredentials

      public Object getCredentials()
      Always returns an empty String
      Returns:
      an empty String
    • getKeyHash

      public int getKeyHash()
    • getPrincipal

      public Object getPrincipal()
      Description copied from interface: Authentication
      The identity of the principal being authenticated. In the case of an authentication request with username and password, this would be the username. Callers are expected to populate the principal for an authentication request.

      The AuthenticationManager implementation will often return an Authentication containing richer information as the principal for use by the application. Many of the authentication providers will create a UserDetails object as the principal.

      Returns:
      the Principal being authenticated or the authenticated principal after authentication.
    • toBuilder

      Description copied from interface: Authentication
      Return an Authentication.Builder based on this instance. By default, returns a builder that builds a SimpleAuthentication.

      Although a default method, all Authentication implementations should implement this. The reason is to ensure that the Authentication type is preserved when Authentication.Builder.build() is invoked. This is especially important in the event that your authentication implementation contains custom fields.

      This isn't strictly necessary since it is recommended that applications code to the Authentication interface and that custom information is often contained in the Authentication.getPrincipal() value.

      Returns:
      an Authentication.Builder for building a new Authentication based on this instance
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface Principal
      Overrides:
      equals in class AbstractAuthenticationToken
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface Principal
      Overrides:
      hashCode in class AbstractAuthenticationToken