Package org.springframework.security.oauth2.server.authorization.authentication

Class OAuth2TokenExchangeCompositeAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.oauth2.server.authorization.authentication.OAuth2TokenExchangeCompositeAuthenticationToken

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

public class OAuth2TokenExchangeCompositeAuthenticationToken
extends AbstractAuthenticationToken

An Authentication implementation used for the OAuth 2.0 Token Exchange Grant to represent the principal in a composite token (e.g. the "delegation" use case).

Since:

7.0

See Also:

• OAuth2TokenExchangeAuthenticationToken
• Serialized Form

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface org.springframework.security.core.Authentication

Authentication.Builder<B extends Authentication.Builder<B>>

Constructor Summary

Constructors

Constructor	Description
OAuth2TokenExchangeCompositeAuthenticationToken(Authentication subject, List<OAuth2TokenExchangeActor> actors)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<OAuth2TokenExchangeActor>	getActors()
Object	getCredentials()	The credentials that prove the principal is correct.
Object	getPrincipal()	The identity of the principal being authenticated.
Authentication	getSubject()
int	hashCode()

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

eraseCredentials, getAuthorities, getDetails, getName, 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

toBuilder

Methods inherited from interface java.security.Principal

implies

Constructor Details

OAuth2TokenExchangeCompositeAuthenticationToken

public OAuth2TokenExchangeCompositeAuthenticationToken(Authentication subject,
 List<OAuth2TokenExchangeActor> actors)

Method Details

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.

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.

Returns:

the credentials that prove the identity of the Principal

getSubject

public Authentication getSubject()

getActors

public List<OAuth2TokenExchangeActor> getActors()

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