Package com.nimbusds.oauth2.sdk.token

Class AccessTokenParseUtils

java.lang.Object

com.nimbusds.oauth2.sdk.token.AccessTokenParseUtils

public class AccessTokenParseUtils
extends Object

Access token parse utilities.

Method Summary

Modifier and Type	Method	Description
static AccessTokenType	determineAccessTokenTypeFromAuthorizationHeader(String header)	Determines the access token type from an Authorization HTTP request header.
static void	parseAndEnsureTypeFromJSONObject(net.minidev.json.JSONObject jsonObject, AccessTokenType type)	Parses a token_type from a JSON object and ensures it matches the specified.
static List<AuthorizationDetail>	parseAuthorizationDetailsFromJSONObject(net.minidev.json.JSONObject jsonObject)	Parses an authorization_details parameter from a JSON object.
static TokenTypeURI	parseIssuedTokenTypeFromJSONObject(net.minidev.json.JSONObject jsonObject)	Parses an issued_token_type parameter from a JSON object.
static long	parseLifetimeFromJSONObject(net.minidev.json.JSONObject jsonObject)	Parses an access token expires_in parameter from a JSON object.
static Scope	parseScopeFromJSONObject(net.minidev.json.JSONObject jsonObject)	Parses a scope parameter from a JSON object.
static String	parseValueFromAuthorizationHeader(String header, AccessTokenType type)	Parses an access token value from an Authorization HTTP request header.
static String	parseValueFromJSONObject(net.minidev.json.JSONObject params)	Parses an {code access_token} value from a JSON object.
static String	parseValueFromQueryParameters(Map<String,List<String>> parameters)	Parses an access_token value from a query or form parameters.
static String	parseValueFromQueryParameters(Map<String,List<String>> parameters, AccessTokenType type)	Parses an access_token values from a query or form parameters.

Methods inherited from class java.lang.Object

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

Method Details

parseAndEnsureTypeFromJSONObject

public static void parseAndEnsureTypeFromJSONObject(net.minidev.json.JSONObject jsonObject,
 AccessTokenType type)
                                             throws ParseException

Parses a token_type from a JSON object and ensures it matches the specified.

Parameters:

jsonObject - The JSON object. Must not be null.

type - The expected token type. Must not be null.

Throws:

ParseException - If parsing failed.

parseValueFromJSONObject

public static String parseValueFromJSONObject(net.minidev.json.JSONObject params)
                                       throws ParseException

Parses an {code access_token} value from a JSON object.

Parameters:

params - The JSON object. Must not be null.

Returns:

The access token value.

Throws:

ParseException - If parsing failed.

parseLifetimeFromJSONObject

public static long parseLifetimeFromJSONObject(net.minidev.json.JSONObject jsonObject)
                                        throws ParseException

Parses an access token expires_in parameter from a JSON object.

Parameters:

jsonObject - The JSON object. Must not be null.

Returns:

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

Throws:

ParseException - If parsing failed.

parseScopeFromJSONObject

public static Scope parseScopeFromJSONObject(net.minidev.json.JSONObject jsonObject)
                                      throws ParseException

Parses a scope parameter from a JSON object.

Parameters:

jsonObject - The JSON object. Must not be null.

Returns:

The scope, null if not specified.

Throws:

ParseException - If parsing failed.

parseAuthorizationDetailsFromJSONObject

public static List<AuthorizationDetail> parseAuthorizationDetailsFromJSONObject(net.minidev.json.JSONObject jsonObject)
                                                                         throws ParseException

Parses an authorization_details parameter from a JSON object.

Parameters:

jsonObject - The JSON object. Must not be null.

Returns:

The authorisation details, null if not specified.

Throws:

ParseException - If parsing failed.

parseIssuedTokenTypeFromJSONObject

public static TokenTypeURI parseIssuedTokenTypeFromJSONObject(net.minidev.json.JSONObject jsonObject)
                                                       throws ParseException

Parses an issued_token_type parameter from a JSON object.

Parameters:

jsonObject - The JSON object. Must not be null.

Returns:

The issued token type, null if not specified.

Throws:

ParseException - If parsing failed.

parseValueFromAuthorizationHeader

public static String parseValueFromAuthorizationHeader(String header,
 AccessTokenType type)
                                                throws ParseException

Parses an access token value from an Authorization HTTP request header.

Parameters:

header - The Authorization header value, null if not specified.

type - The expected access token type, such as AccessTokenType.BEARER or AccessTokenType.DPOP. Must not be null.

Returns:

The access token value.

Throws:

ParseException - If parsing failed.

parseValueFromQueryParameters

public static String parseValueFromQueryParameters(Map<String,List<String>> parameters,
 AccessTokenType type)
                                            throws ParseException

Parses an access_token values from a query or form parameters.

Parameters:

parameters - The parameters. Must not be null.

type - The expected access token type, such as AccessTokenType.BEARER or AccessTokenType.DPOP. Must not be null.

Returns:

The access token value.

Throws:

ParseException - If parsing failed.

parseValueFromQueryParameters

public static String parseValueFromQueryParameters(Map<String,List<String>> parameters)
                                            throws ParseException

Parses an access_token value from a query or form parameters.

Parameters:

parameters - The query parameters. Must not be null.

Returns:

The access token value.

Throws:

ParseException - If parsing failed.

determineAccessTokenTypeFromAuthorizationHeader

public static AccessTokenType determineAccessTokenTypeFromAuthorizationHeader(String header)
                                                                       throws ParseException

Determines the access token type from an Authorization HTTP request header.

Parameters:

header - The Authorization header value. Must not be null.

Returns:

The access token type.

Throws:

ParseException - If parsing failed.