com.nimbusds.openid.connect.provider.spi.grants

Class GrantAuthorization

java.lang.Object

com.nimbusds.openid.connect.provider.spi.grants.GrantAuthorization

Direct Known Subclasses:

PasswordGrantAuthorization

public class GrantAuthorization
extends Object

Authorisation response from a grant handler.

Constructor Summary

Constructors

Constructor and Description
GrantAuthorization(com.nimbusds.oauth2.sdk.Scope scope, List<com.nimbusds.oauth2.sdk.id.Audience> audList, long accessTokenLifetime, com.nimbusds.oauth2.sdk.token.TokenEncoding accessTokenEncoding) Creates a new authorisation response from a grant handler.

Method Summary

Methods

Modifier and Type	Method and Description
com.nimbusds.oauth2.sdk.token.TokenEncoding	getAccessTokenEncoding() Returns the access token encoding.
long	getAccessTokenLifetime() Returns the access token lifetime.
List<com.nimbusds.oauth2.sdk.id.Audience>	getAudience() Returns the explicit list of audiences for the access token.
com.nimbusds.oauth2.sdk.Scope	getScope() Returns the authorised scope values.
static GrantAuthorization	parse(net.minidev.json.JSONObject jsonObject) Parses an authorisation response from the specified JSON object representation.
net.minidev.json.JSONObject	toJSONObject() Returns a JSON object representation of this authorisation response.

Methods inherited from class java.lang.Object

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

Constructor Detail

GrantAuthorization

public GrantAuthorization(com.nimbusds.oauth2.sdk.Scope scope,
                  List<com.nimbusds.oauth2.sdk.id.Audience> audList,
                  long accessTokenLifetime,
                  com.nimbusds.oauth2.sdk.token.TokenEncoding accessTokenEncoding)

Creates a new authorisation response from a grant handler.

Parameters:

scope - The authorised scope values. Must not be null.

audList - Explicit list of audiences for the access token, null if not specified.

accessTokenLifetime - The access token lifetime, in seconds, zero if not specified.

accessTokenEncoding - The access token encoding, null if not specified.

Method Detail

getScope

public com.nimbusds.oauth2.sdk.Scope getScope()

Returns the authorised scope values.

Returns:

The authorised scope values.

getAudience

public List<com.nimbusds.oauth2.sdk.id.Audience> getAudience()

Returns the explicit list of audiences for the access token.

Returns:

The explicit list of audiences for the access token, null if not specified.

getAccessTokenLifetime

public long getAccessTokenLifetime()

Returns the access token lifetime.

Returns:

The access token lifetime, in seconds, zero if not specified.

getAccessTokenEncoding

public com.nimbusds.oauth2.sdk.token.TokenEncoding getAccessTokenEncoding()

Returns the access token encoding.

Returns:

The access token encoding, null if not specified.

toJSONObject

public net.minidev.json.JSONObject toJSONObject()

Returns a JSON object representation of this authorisation response.

Returns:

The JSON object representation.

parse

public static GrantAuthorization parse(net.minidev.json.JSONObject jsonObject)
                                throws com.nimbusds.oauth2.sdk.ParseException

Parses an authorisation response from the specified JSON object representation.

Parameters:

jsonObject - The JSON object to parse. Must not be null.

Returns:

The authorisation response.

Throws:

com.nimbusds.oauth2.sdk.ParseException