net.openid.appauth

Class TokenResponse

java.lang.Object

net.openid.appauth.TokenResponse

public class TokenResponse
extends Object

A response to a token request.

See Also:

TokenRequest, "The OAuth 2.0 Authorization Framework" (RFC 6749), Section 4.1.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenResponse.Builder Creates instances of TokenResponse.

Field Summary

Fields

Modifier and Type	Field and Description
String	accessToken The access token, if provided.
Long	accessTokenExpirationTime The expiration time of the access token, if provided.
Map<String,String>	additionalParameters Additional, non-standard parameters in the response.
String	idToken The ID token describing the authenticated user, if provided.
String	refreshToken The refresh token, if provided.
TokenRequest	request The token request associated with this response.
String	scope The scope of the access token.
static String	TOKEN_TYPE_BEARER Indicates that a provided access token is a bearer token.
String	tokenType The type of the token returned.

Method Summary

Modifier and Type	Method and Description
static TokenResponse	fromJson(JSONObject json) Reads a token response from a JSON string produced by toJson().
static TokenResponse	fromJson(String jsonStr) Reads a token response from a JSON string produced by toJsonString().
static TokenResponse	fromJson(TokenRequest request, JSONObject json) Reads a token response from a JSON string, and associates it with the provided request.
static TokenResponse	fromJson(TokenRequest request, String jsonStr) Reads a token response from a JSON string, and associates it with the provided request.
Set<String>	getScopeSet() Derives the set of scopes from the consolidated, space-delimited scopes in the scope field.
JSONObject	toJson() Converts the token response to a JSON object, for storage or transmission.
String	toJsonString() Converts the token response to a JSON string, for storage or transmission.

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_TYPE_BEARER

public static final String TOKEN_TYPE_BEARER

Indicates that a provided access token is a bearer token.

See Also:

""The OAuth 2.0 Authorization Framework" (RFC 6749), Section 7.1, Constant Field Values

request

@NonNull
public final TokenRequest request

The token request associated with this response.

tokenType

@Nullable
public final String tokenType

The type of the token returned. Typically this is TOKEN_TYPE_BEARER, or some other token type that the client has negotiated with the authorization service.

See Also:

"The OAuth 2.0 Authorization Framework" (RFC 6749), Section 4.1.4, "The OAuth 2.0 Authorization Framework" (RFC 6749), Section 5.1

accessToken

@Nullable
public final String accessToken

The access token, if provided.

See Also:

"The OAuth 2.0 Authorization Framework" (RFC 6749), Section 5.1

accessTokenExpirationTime

@Nullable
public final Long accessTokenExpirationTime

The expiration time of the access token, if provided. If an access token is provided but the expiration time is not, then the expiration time is typically some default value specified by the identity provider through some other means, such as documentation or an additional non-standard field.

idToken

@Nullable
public final String idToken

The ID token describing the authenticated user, if provided.

See Also:

"OpenID Connect Core 1.0", Section 2

refreshToken

@Nullable
public final String refreshToken

The refresh token, if provided.

See Also:

"The OAuth 2.0 Authorization Framework" (RFC 6749), Section 5.1

scope

@Nullable
public final String scope

The scope of the access token. If the scope is identical to that originally requested, then this value is optional.

See Also:

"The OAuth 2.0 Authorization Framework" (RFC 6749), Section 5.1

additionalParameters

@NonNull
public final Map<String,String> additionalParameters

Additional, non-standard parameters in the response.

Method Detail

getScopeSet

@Nullable
public Set<String> getScopeSet()

Derives the set of scopes from the consolidated, space-delimited scopes in the scope field. If no scopes were specified on this response, the method will return null.

toJson

public JSONObject toJson()

Converts the token response to a JSON object, for storage or transmission.

toJsonString

public String toJsonString()

Converts the token response to a JSON string, for storage or transmission.

fromJson

@NonNull
public static TokenResponse fromJson(@NonNull
                                              String jsonStr)
                                       throws JSONException

Reads a token response from a JSON string produced by toJsonString().

Throws:

JSONException - if the JSON is malformed or missing required fields.

fromJson

@NonNull
public static TokenResponse fromJson(@NonNull
                                              JSONObject json)
                                       throws JSONException

Reads a token response from a JSON string produced by toJson().

Throws:

JSONException - if the JSON is malformed or missing required fields.

fromJson

@NonNull
public static TokenResponse fromJson(@Nullable
                                              TokenRequest request,
                                              @NonNull
                                              String jsonStr)
                                       throws JSONException

Reads a token response from a JSON string, and associates it with the provided request. If a request is not provided, its serialized form is expected to be found in the JSON (as if produced by a prior call to toJsonString().

Throws:

JSONException - if the JSON is malformed or missing required fields.

fromJson

@NonNull
public static TokenResponse fromJson(@Nullable
                                              TokenRequest request,
                                              @NonNull
                                              JSONObject json)
                                       throws JSONException

Reads a token response from a JSON string, and associates it with the provided request. If a request is not provided, its serialized form is expected to be found in the JSON (as if produced by a prior call to toJson().

Throws:

JSONException - if the JSON is malformed or missing required fields.