Package com.nimbusds.oauth2.sdk

Class AuthorizationGrant

java.lang.Object

com.nimbusds.oauth2.sdk.AuthorizationGrant

Direct Known Subclasses:

AssertionGrant, AuthorizationCodeGrant, CIBAGrant, ClientCredentialsGrant, DeviceCodeGrant, RefreshTokenGrant, ResourceOwnerPasswordCredentialsGrant, TokenExchangeGrant

public abstract class AuthorizationGrant
extends Object

Authorisation grant. Extending classes should be immutable.

Supported authorisation grant types:

• Authorisation code
• Resource owner password credentials
• Client credentials
• Refresh token
• GrantType.JWT_BEARER
• GrantType.SAML2_BEARER
• GrantType.DEVICE_CODE
• GrantType.CIBA
• GrantType.TOKEN_EXCHANGE

Related specifications:

• OAuth 2.0 (RFC 6749), sections 1.3.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AuthorizationGrant(GrantType type)	Creates a new authorisation grant.

Method Summary

Modifier and Type	Method	Description
GrantType	getType()	Gets the authorisation grant type.
static AuthorizationGrant	parse(Map<String,List<String>> params)	Parses an authorisation grant from the specified request body parameters.
abstract Map<String,List<String>>	toParameters()	Returns the request body parameters for the authorisation grant.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthorizationGrant

protected AuthorizationGrant(GrantType type)

Creates a new authorisation grant.

Parameters:

type - The authorisation grant type. Must not be null.

Method Details

getType

public GrantType getType()

Gets the authorisation grant type.

Returns:

The authorisation grant type.

toParameters

public abstract Map<String,List<String>> toParameters()

Returns the request body parameters for the authorisation grant.

Returns:

The parameters.

parse

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

Parses an authorisation grant from the specified request body parameters.

Parameters:

params - The request body parameters. Must not be null.

Returns:

The authorisation grant.

Throws:

ParseException - If parsing failed or the grant type is not supported.