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

Class OAuth2AuthorizationCodeRequestAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

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

All Implemented Interfaces:

java.io.Serializable, java.security.Principal, org.springframework.security.core.Authentication, org.springframework.security.core.CredentialsContainer

public final class OAuth2AuthorizationCodeRequestAuthenticationToken
extends org.springframework.security.authentication.AbstractAuthenticationToken

An Authentication implementation for the OAuth 2.0 Authorization Request (and Consent) used in the Authorization Code Grant.

Since:

0.1.2

See Also:

OAuth2AuthorizationCodeRequestAuthenticationProvider, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuth2AuthorizationCodeRequestAuthenticationToken.Builder A builder for OAuth2AuthorizationCodeRequestAuthenticationToken.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalParameters() Returns the additional parameters.
OAuth2AuthorizationCode	getAuthorizationCode() Returns the OAuth2AuthorizationCode.
java.lang.String	getAuthorizationUri() Returns the authorization URI.
java.lang.String	getClientId() Returns the client identifier.
java.lang.Object	getCredentials()
java.lang.Object	getPrincipal()
java.lang.String	getRedirectUri() Returns the redirect uri.
java.util.Set<java.lang.String>	getScopes() Returns the requested (or authorized) scope(s).
java.lang.String	getState() Returns the state.
boolean	isConsent() Returns true if this Authentication represents an authorization consent request, false otherwise.
boolean	isConsentRequired() Returns true if authorization consent is required, false otherwise.
static OAuth2AuthorizationCodeRequestAuthenticationToken.Builder	with(java.lang.String clientId, org.springframework.security.core.Authentication principal) Returns a new OAuth2AuthorizationCodeRequestAuthenticationToken.Builder, initialized with the given client identifier and Principal (Resource Owner).

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 java.security.Principal

implies

Method Detail

getPrincipal

public java.lang.Object getPrincipal()

getCredentials

public java.lang.Object getCredentials()

getAuthorizationUri

public java.lang.String getAuthorizationUri()

Returns the authorization URI.

Returns:

the authorization URI

getClientId

public java.lang.String getClientId()

Returns the client identifier.

Returns:

the client identifier

getRedirectUri

@Nullable
public java.lang.String getRedirectUri()

Returns the redirect uri.

Returns:

the redirect uri

getScopes

public java.util.Set<java.lang.String> getScopes()

Returns the requested (or authorized) scope(s).

Returns:

the requested (or authorized) scope(s), or an empty Set if not available

getState

@Nullable
public java.lang.String getState()

Returns the state.

Returns:

the state

getAdditionalParameters

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalParameters()

Returns the additional parameters.

Returns:

the additional parameters

isConsentRequired

public boolean isConsentRequired()

Returns true if authorization consent is required, false otherwise.

Returns:

true if authorization consent is required, false otherwise

isConsent

public boolean isConsent()

Returns true if this Authentication represents an authorization consent request, false otherwise.

Returns:

true if this Authentication represents an authorization consent request, false otherwise

getAuthorizationCode

@Nullable
public OAuth2AuthorizationCode getAuthorizationCode()

Returns the OAuth2AuthorizationCode.

Returns:

the OAuth2AuthorizationCode

with

public static OAuth2AuthorizationCodeRequestAuthenticationToken.Builder with(@NonNull
                                                                             java.lang.String clientId,
                                                                             @NonNull
                                                                             org.springframework.security.core.Authentication principal)

Returns a new OAuth2AuthorizationCodeRequestAuthenticationToken.Builder, initialized with the given client identifier and Principal (Resource Owner).

Parameters:

clientId - the client identifier

principal - the Principal (Resource Owner)

Returns:

the OAuth2AuthorizationCodeRequestAuthenticationToken.Builder