Class UsernamePasswordAuthenticationToken

    • Constructor Detail

      • UsernamePasswordAuthenticationToken

        public UsernamePasswordAuthenticationToken​(java.lang.Object principal,
                                                   java.lang.Object credentials)
        This constructor can be safely used by any code that wishes to create a UsernamePasswordAuthenticationToken, as the AbstractAuthenticationToken.isAuthenticated() will return false.
      • UsernamePasswordAuthenticationToken

        public UsernamePasswordAuthenticationToken​(java.lang.Object principal,
                                                   java.lang.Object credentials,
                                                   java.util.Collection<? extends GrantedAuthority> authorities)
        This constructor should only be used by AuthenticationManager or AuthenticationProvider implementations that are satisfied with producing a trusted (i.e. AbstractAuthenticationToken.isAuthenticated() = true) authentication token.
        principal -
        credentials -
        authorities -
    • Method Detail

      • getCredentials

        public java.lang.Object getCredentials()
        Description copied from interface: Authentication
        The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to the AuthenticationManager. Callers are expected to populate the credentials.
        the credentials that prove the identity of the Principal
      • getPrincipal

        public java.lang.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.

        the Principal being authenticated or the authenticated principal after authentication.
      • setAuthenticated

        public void setAuthenticated​(boolean isAuthenticated)
                              throws java.lang.IllegalArgumentException
        Description copied from interface: Authentication
        See Authentication.isAuthenticated() for a full description.

        Implementations should always allow this method to be called with a false parameter, as this is used by various classes to specify the authentication token should not be trusted. If an implementation wishes to reject an invocation with a true parameter (which would indicate the authentication token is trusted - a potential security risk) the implementation should throw an IllegalArgumentException.

        Specified by:
        setAuthenticated in interface Authentication
        setAuthenticated in class AbstractAuthenticationToken
        isAuthenticated - true if the token should be trusted (which may result in an exception) or false if the token should not be trusted
        java.lang.IllegalArgumentException - if an attempt to make the authentication token trusted (by passing true as the argument) is rejected due to the implementation being immutable or implementing its own alternative approach to Authentication.isAuthenticated()