com.nimbusds.oauth2.sdk

Class AuthorizationGrant

java.lang.Object

com.nimbusds.oauth2.sdk.AuthorizationGrant

Direct Known Subclasses:

AssertionGrant, AuthorizationCodeGrant, ClientCredentialsGrant, RefreshTokenGrant, ResourceOwnerPasswordCredentialsGrant

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

Related specifications:

• OAuth 2.0 (RFC 6749), sections 1.3.

Constructor Summary

Constructors

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

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationGrant

protected AuthorizationGrant(GrantType type)

Creates a new authorisation grant.

Parameters:

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

Method Detail

getType

public GrantType getType()

Gets the authorisation grant type.

Returns:

The authorisation grant type.

toParameters

public abstract Map<String,String> toParameters()

Return the parameters for the authorisation grant.

Returns:

The parameters.

parse

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

Parses an authorisation grant from the specified parameters.

Parameters:

params - The parameters. Must not be null.

Returns:

The authorisation grant.

Throws:

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