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

Class GrantAuthorization

java.lang.Object

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

Direct Known Subclasses:

SubjectAuthorization

@Immutable
public class GrantAuthorization
extends Object

Basic OAuth 2.0 authorisation produced by a GrantHandler.

Required authorisation details:

• The authorised scope.

All other parameters are optional or have suitable defaults.

Constructor Summary

Constructors

Constructor and Description
GrantAuthorization(com.nimbusds.oauth2.sdk.Scope scope) Creates a new basic authorisation.
GrantAuthorization(com.nimbusds.oauth2.sdk.Scope scope, AccessTokenSpec accessTokenSpec, net.minidev.json.JSONObject data) Creates a new basic authorisation.
GrantAuthorization(com.nimbusds.oauth2.sdk.Scope scope, List<com.nimbusds.oauth2.sdk.id.Audience> audList, AccessTokenSpec accessTokenSpec, net.minidev.json.JSONObject data) Creates a new basic authorisation.

Method Summary

Modifier and Type	Method and Description
AccessTokenSpec	getAccessTokenSpec() Returns the access token specification.
List<com.nimbusds.oauth2.sdk.id.Audience>	getAudience() Returns the explicit list of audiences for the access token.
net.minidev.json.JSONObject	getData() Returns the additional data as a JSON object.
com.nimbusds.oauth2.sdk.Scope	getScope() Returns the authorised scope values.
static GrantAuthorization	parse(net.minidev.json.JSONObject jsonObject) Parses a basic authorisation from the specified JSON object.
static GrantAuthorization	parse(String json) Parses a basic authorisation from the specified JSON object string.
net.minidev.json.JSONObject	toJSONObject() Returns a JSON object representation of this authorisation.

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)

Creates a new basic authorisation.

Parameters:

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

GrantAuthorization

public GrantAuthorization(com.nimbusds.oauth2.sdk.Scope scope,
                          AccessTokenSpec accessTokenSpec,
                          net.minidev.json.JSONObject data)

Creates a new basic authorisation.

Parameters:

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

accessTokenSpec - The access token specification. Must not be null.

data - Additional data as a JSON object, null if not specified.

GrantAuthorization

public GrantAuthorization(com.nimbusds.oauth2.sdk.Scope scope,
                          List<com.nimbusds.oauth2.sdk.id.Audience> audList,
                          AccessTokenSpec accessTokenSpec,
                          net.minidev.json.JSONObject data)

Creates a new basic authorisation.

Parameters:

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

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

accessTokenSpec - The access token specification. Must not be null.

data - Additional data as a JSON object, 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.

getAccessTokenSpec

public AccessTokenSpec getAccessTokenSpec()

Returns the access token specification.

Returns:

The access token specification.

getData

public net.minidev.json.JSONObject getData()

Returns the additional data as a JSON object.

Returns:

The additional data, null if not specified.

toJSONObject

public net.minidev.json.JSONObject toJSONObject()

Returns a JSON object representation of this authorisation.

Returns:

The JSON object representation.

parse

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

Parses a basic authorisation from the specified JSON object.

Parameters:

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

Returns:

The basic authorisation.

Throws:

com.nimbusds.oauth2.sdk.ParseException - If parsing failed.

parse

public static GrantAuthorization parse(String json)
                                throws com.nimbusds.oauth2.sdk.ParseException

Parses a basic authorisation from the specified JSON object string.

Parameters:

json - The JSON object string to parse. Must not be null.

Returns:

The basic authorisation.

Throws:

com.nimbusds.oauth2.sdk.ParseException - If parsing failed.