com.nimbusds.oauth2.sdk

Class AuthorizationCodeGrant

java.lang.Object

com.nimbusds.oauth2.sdk.AuthorizationGrant

com.nimbusds.oauth2.sdk.AuthorizationCodeGrant

@Immutable
public final class AuthorizationCodeGrant
extends AuthorizationGrant

Authorisation code grant. Used in access token requests with an authorisation code.

Related specifications:

• OAuth 2.0 (RFC 6749), section 4.1.3.

Field Summary

Fields

Modifier and Type	Field and Description
static GrantType	GRANT_TYPE The associated grant type.

Constructor Summary

Constructors

Constructor and Description
AuthorizationCodeGrant(AuthorizationCode code, URL redirectURI) Creates a new authorisation code grant.
AuthorizationCodeGrant(AuthorizationCode code, URL redirectURI, ClientID clientID) Creates a new authorisation code grant.

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationCode	getAuthorizationCode() Gets the authorisation code.
ClientID	getClientID() Gets the client identifier.
URL	getRedirectionURI() Gets the redirection URI of the original authorisation request.
static AuthorizationCodeGrant	parse(Map<String,String> params) Parses an authorisation code grant from the specified parameters.
Map<String,String>	toParameters() Return the parameters for the authorisation grant.

Methods inherited from class com.nimbusds.oauth2.sdk.AuthorizationGrant

getType

Methods inherited from class java.lang.Object

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

Field Detail

GRANT_TYPE

public static final GrantType GRANT_TYPE

The associated grant type.

Constructor Detail

AuthorizationCodeGrant

public AuthorizationCodeGrant(AuthorizationCode code,
                      URL redirectURI)

Creates a new authorisation code grant. This constructor is intended for an authenticated access token requests (doesn't require the client identifier to be specified).

Parameters:

code - The authorisation code. Must not be null.

redirectURI - The redirection URI of the original authorisation request. Required if the {redirect_uri} parameter was included in the authorisation request, else null.

AuthorizationCodeGrant

public AuthorizationCodeGrant(AuthorizationCode code,
                      URL redirectURI,
                      ClientID clientID)

Creates a new authorisation code grant. This constructor is intended for an unauthenticated access token request and requires the client identifier to be specified.

Parameters:

code - The authorisation code. Must not be null.

redirectURI - The redirection URI of the original authorisation request, null if the redirect_uri parameter was not included in the authorisation request.

clientID - The client identifier. Must not be null.

Method Detail

getAuthorizationCode

public AuthorizationCode getAuthorizationCode()

Gets the authorisation code.

Returns:

The authorisation code.

getRedirectionURI

public URL getRedirectionURI()

Gets the redirection URI of the original authorisation request.

Returns:

The redirection URI, null if the redirect_uri parameter was not included in the original authorisation request.

getClientID

public ClientID getClientID()

Gets the client identifier.

Returns:

The client identifier, null if not specified (implies an authenticated access token request).

toParameters

public Map<String,String> toParameters()

Description copied from class: AuthorizationGrant

Return the parameters for the authorisation grant.

Specified by:

toParameters in class AuthorizationGrant

Returns:

The parameters.

parse

public static AuthorizationCodeGrant parse(Map<String,String> params)
                                    throws ParseException

Parses an authorisation code grant from the specified parameters.

Example:

 grant_type=authorization_code
 code=SplxlOBeZQQYbYS6WxSbIA
 redirect_uri=https://Fclient.example.com/cb
 

Parameters:

params - The parameters.

Returns:

The authorisation code grant.

Throws:

ParseException - If parsing failed.