Package com.nimbusds.oauth2.sdk.token

Class NAAccessToken

java.lang.Object

com.nimbusds.oauth2.sdk.id.Identifier

com.nimbusds.oauth2.sdk.token.Token

com.nimbusds.oauth2.sdk.token.AccessToken

com.nimbusds.oauth2.sdk.token.NAAccessToken

All Implemented Interfaces:

Serializable, Comparable<Identifier>, net.minidev.json.JSONAware

@Immutable
public class NAAccessToken
extends AccessToken

Access token of type not applicable (N/A), intended for use in OAuth 2.0 token exchange scenarios.

Related specifications:

• OAuth 2.0 Token Exchange (RFC 8693)

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.nimbusds.oauth2.sdk.id.Identifier

DEFAULT_BYTE_LENGTH, secureRandom

Constructor Summary

Constructors

Constructor	Description
NAAccessToken(String value, long lifetime, Scope scope, TokenTypeURI issuedTokenType)	Creates a new N/A access token with the specified value.

Method Summary

Modifier and Type	Method	Description
static NAAccessToken	parse(net.minidev.json.JSONObject jsonObject)	Parses a N/A access token from a JSON object access token response.
String	toAuthorizationHeader()	Returns the Authorization HTTP request header value for this access token.

Methods inherited from class com.nimbusds.oauth2.sdk.token.AccessToken

getAuthorizationDetails, getIssuedTokenType, getLifetime, getParameterNames, getScope, getType, parse, parse, parse, toJSONObject, toJSONString

Methods inherited from class com.nimbusds.oauth2.sdk.token.Token

getCustomParameters

Methods inherited from class com.nimbusds.oauth2.sdk.id.Identifier

compareTo, equals, getValue, hashCode, toString, toStringList

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

NAAccessToken

public NAAccessToken(String value,
 long lifetime,
 Scope scope,
 TokenTypeURI issuedTokenType)

Creates a new N/A access token with the specified value.

Parameters:

value - The access token value. Must not be null or empty string.

lifetime - The lifetime in seconds, 0 if not specified.

scope - The scope, null if not specified.

issuedTokenType - The token type URI, null if not specified.

Method Details

toAuthorizationHeader

public String toAuthorizationHeader()

Description copied from class: AccessToken

Returns the Authorization HTTP request header value for this access token.

Specified by:

toAuthorizationHeader in class AccessToken

Returns:

The Authorization header value.

parse

public static NAAccessToken parse(net.minidev.json.JSONObject jsonObject)
                           throws ParseException

Parses a N/A access token from a JSON object access token response.

Parameters:

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

Returns:

The N/A access token.

Throws:

ParseException - If the JSON object couldn't be parsed to a N/A access token.