Package org.springframework.security.authentication

Class TestingAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.authentication.TestingAuthenticationToken

All Implemented Interfaces:

Serializable, Principal, Authentication, BuildableAuthentication, CredentialsContainer

public class TestingAuthenticationToken
extends AbstractAuthenticationToken
implements BuildableAuthentication

An Authentication implementation that is designed for use whilst unit testing.

The corresponding authentication provider is TestingAuthenticationProvider.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TestingAuthenticationToken.Builder<B extends TestingAuthenticationToken.Builder<B>>	A builder of TestingAuthenticationToken instances

Nested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

Constructor Summary

Constructors

Modifier	Constructor	Description
	TestingAuthenticationToken(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	TestingAuthenticationToken(TestingAuthenticationToken.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
Object	getCredentials()	The credentials that prove the principal is correct.
Object	getPrincipal()	The identity of the principal being authenticated.
TestingAuthenticationToken.Builder<?>	toBuilder()	Return an Authentication.Builder based on this instance.

Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.security.core.Authentication

getAuthorities, getDetails, isAuthenticated, setAuthenticated

Methods inherited from interface java.security.Principal

equals, getName, hashCode, implies, toString

Constructor Details

TestingAuthenticationToken

public TestingAuthenticationToken(Object principal,
 Object credentials)

TestingAuthenticationToken

public TestingAuthenticationToken(Object principal,
 Object credentials,
 String... authorities)

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

protected TestingAuthenticationToken(TestingAuthenticationToken.Builder<?> builder)

Method Details

getCredentials

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

Specified by:

getCredentials in interface Authentication

Returns:

the credentials that prove the identity of the Principal

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.

Specified by:

getPrincipal in interface Authentication

Returns:

the Principal being authenticated or the authenticated principal after authentication.

toBuilder

public TestingAuthenticationToken.Builder<?> toBuilder()

Description copied from interface: BuildableAuthentication

Return an Authentication.Builder based on this instance.

Although a default method, all BuildableAuthentication implementations should implement this. The reason is to ensure that the BuildableAuthentication 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.

Specified by:

toBuilder in interface BuildableAuthentication

Returns:

an Authentication.Builder for building a new Authentication based on this instance