Package org.springframework.security.oauth2.core.endpoint

Class OAuth2AuthorizationRequest

java.lang.Object

org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

All Implemented Interfaces:

Serializable

public final class OAuth2AuthorizationRequest
extends Object
implements Serializable

A representation of an OAuth 2.0 Authorization Request for the authorization code grant type or implicit grant type.

Since:

5.0

See Also:

• AuthorizationGrantType
• OAuth2AuthorizationResponseType
• Section 4.1.1 Authorization Code Grant Request
• Section 4.2.1 Implicit Grant Request
• Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OAuth2AuthorizationRequest.Builder	authorizationCode()	Returns a new OAuth2AuthorizationRequest.Builder, initialized with the authorization code grant type.
static OAuth2AuthorizationRequest.Builder	from(OAuth2AuthorizationRequest authorizationRequest)	Returns a new OAuth2AuthorizationRequest.Builder, initialized with the values from the provided authorizationRequest.
Map<String,Object>	getAdditionalParameters()	Returns the additional parameter(s) used in the request.
<T> T	getAttribute(String name)	Returns the value of an attribute associated to the request.
Map<String,Object>	getAttributes()	Returns the attribute(s) associated to the request.
String	getAuthorizationRequestUri()	Returns the URI string representation of the OAuth 2.0 Authorization Request.
String	getAuthorizationUri()	Returns the uri for the authorization endpoint.
String	getClientId()	Returns the client identifier.
AuthorizationGrantType	getGrantType()	Returns the grant type.
String	getRedirectUri()	Returns the uri for the redirection endpoint.
OAuth2AuthorizationResponseType	getResponseType()	Returns the response type.
Set<String>	getScopes()	Returns the scope(s).
String	getState()	Returns the state.
static OAuth2AuthorizationRequest.Builder	implicit()	Deprecated. It is not recommended to use the implicit flow due to the inherent risks of returning access tokens in an HTTP redirect without any confirmation that it has been received by the client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getAuthorizationUri

public String getAuthorizationUri()

Returns the uri for the authorization endpoint.

Returns:

the uri for the authorization endpoint

getGrantType

public AuthorizationGrantType getGrantType()

Returns the grant type.

Returns:

the AuthorizationGrantType

getResponseType

public OAuth2AuthorizationResponseType getResponseType()

Returns the response type.

Returns:

the OAuth2AuthorizationResponseType

getClientId

public String getClientId()

Returns the client identifier.

Returns:

the client identifier

getRedirectUri

public String getRedirectUri()

Returns the uri for the redirection endpoint.

Returns:

the uri for the redirection endpoint

getScopes

public Set<String> getScopes()

Returns the scope(s).

Returns:

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

getState

public String getState()

Returns the state.

Returns:

the state

getAdditionalParameters

public Map<String,Object> getAdditionalParameters()

Returns the additional parameter(s) used in the request.

Returns:

a Map of the additional parameter(s), or an empty Map if not available

getAttributes

public Map<String,Object> getAttributes()

Returns the attribute(s) associated to the request.

Returns:

a Map of the attribute(s), or an empty Map if not available

Since:

5.2

getAttribute

public <T> T getAttribute(String name)

Returns the value of an attribute associated to the request.

Type Parameters:

T - the type of the attribute

Parameters:

name - the name of the attribute

Returns:

the value of the attribute associated to the request, or null if not available

Since:

5.2

getAuthorizationRequestUri

public String getAuthorizationRequestUri()

Returns the URI string representation of the OAuth 2.0 Authorization Request.

NOTE: The URI string is encoded in the application/x-www-form-urlencoded MIME format.

Returns:

the URI string representation of the OAuth 2.0 Authorization Request

Since:

5.1

authorizationCode

public static OAuth2AuthorizationRequest.Builder authorizationCode()

Returns a new OAuth2AuthorizationRequest.Builder, initialized with the authorization code grant type.

Returns:

the OAuth2AuthorizationRequest.Builder

implicit

@Deprecated
public static OAuth2AuthorizationRequest.Builder implicit()

Deprecated.

It is not recommended to use the implicit flow due to the inherent risks of returning access tokens in an HTTP redirect without any confirmation that it has been received by the client.

Returns a new OAuth2AuthorizationRequest.Builder, initialized with the implicit grant type.

Returns:

the OAuth2AuthorizationRequest.Builder

See Also:

• OAuth 2.0 Implicit Grant

from

public static OAuth2AuthorizationRequest.Builder from(OAuth2AuthorizationRequest authorizationRequest)

Returns a new OAuth2AuthorizationRequest.Builder, initialized with the values from the provided authorizationRequest.

Parameters:

authorizationRequest - the authorization request used for initializing the OAuth2AuthorizationRequest.Builder

Returns:

the OAuth2AuthorizationRequest.Builder

Since:

5.1