Class TestingAuthenticationToken
- All Implemented Interfaces:
Serializable
,Principal
,Authentication
,CredentialsContainer
Authentication
implementation that is
designed for use whilst unit testing.
The corresponding authentication provider is TestingAuthenticationProvider
.
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>
-
Constructor Summary
ConstructorsModifierConstructorDescriptionTestingAuthenticationToken
(Object principal, Object credentials) TestingAuthenticationToken
(Object principal, Object credentials, String... authorities) TestingAuthenticationToken
(Object principal, Object credentials, Collection<? extends GrantedAuthority> authorities) TestingAuthenticationToken
(Object principal, Object credentials, List<? extends GrantedAuthority> authorities) TestingAuthenticationToken
(Object principal, Object credentials, GrantedAuthority... authorities) protected
-
Method Summary
Modifier and TypeMethodDescriptionThe credentials that prove the principal is correct.The identity of the principal being authenticated.Return anAuthentication.Builder
based on this instance.Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString
-
Constructor Details
-
TestingAuthenticationToken
-
TestingAuthenticationToken
-
TestingAuthenticationToken
public TestingAuthenticationToken(Object principal, Object credentials, GrantedAuthority... authorities) -
TestingAuthenticationToken
public TestingAuthenticationToken(Object principal, Object credentials, List<? extends GrantedAuthority> authorities) -
TestingAuthenticationToken
public TestingAuthenticationToken(Object principal, Object credentials, Collection<? extends GrantedAuthority> authorities) -
TestingAuthenticationToken
-
-
Method Details
-
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 theAuthenticationManager
. Callers are expected to populate the credentials.- Returns:
- the credentials that prove the identity of the
Principal
-
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 anAuthentication.Builder
based on this instance. By default, returns a builder that builds aSimpleAuthentication
.Although a
default
method, allAuthentication
implementations should implement this. The reason is to ensure that theAuthentication
type is preserved whenAuthentication.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 theAuthentication.getPrincipal()
value.- Returns:
- an
Authentication.Builder
for building a newAuthentication
based on this instance
-