net.openid.appauth

Class TokenRequest

java.lang.Object

net.openid.appauth.TokenRequest

public class TokenRequest
extends java.lang.Object

An OAuth2 token request. These are used to exchange codes for tokens, or exchange a refresh token for updated tokens.

See Also:

The OAuth 2.0 Authorization Framework (RFC 6749), Section 4.1.3

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,java.lang.String>	additionalParameters Additional parameters to be passed as part of the request.
java.lang.String	authorizationCode An authorization code to be exchanged for one or more tokens.
java.lang.String	clientId The client identifier.
java.lang.String	codeVerifier The code verifier that was used to generate the challenge in the original authorization request, if one was used.
AuthorizationServiceConfiguration	configuration The service’s configuration.
static java.lang.String	GRANT_TYPE_CLIENT_CREDENTIALS The grant type used when requesting an access token using client credentials, typically TLS client certificates.
static java.lang.String	GRANT_TYPE_PASSWORD The grant type used when requesting an access token using a username and password.
java.lang.String	grantType The type of token being sent to the token endpoint.
static java.lang.String	PARAM_CLIENT_ID
android.net.Uri	redirectUri The client’s redirect URI.
java.lang.String	refreshToken A refresh token to be exchanged for a new token.
java.lang.String	scope A space-delimited set of scopes used to determine the scope of any returned tokens.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getRequestParameters() Produces the set of request parameters for this query, which can be further processed into a request body.
java.util.Set<java.lang.String>	getScopeSet() Derives the set of scopes from the consolidated, space-delimited scopes in the scope field.
static TokenRequest	jsonDeserialize(org.json.JSONObject json) Reads a token request from a JSON string representation produced by jsonSerialize().
static TokenRequest	jsonDeserialize(java.lang.String json) Reads a token request from a JSON string representation produced by jsonSerializeString().
org.json.JSONObject	jsonSerialize() Produces a JSON string representation of the token request for persistent storage or local transmission (e.g.
java.lang.String	jsonSerializeString() Produces a JSON string representation of the token request for persistent storage or local transmission (e.g.

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_CLIENT_ID

public static final java.lang.String PARAM_CLIENT_ID

See Also:

Constant Field Values

GRANT_TYPE_PASSWORD

public static final java.lang.String GRANT_TYPE_PASSWORD

The grant type used when requesting an access token using a username and password. This grant type is not directly supported by this library.

See Also:

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

GRANT_TYPE_CLIENT_CREDENTIALS

public static final java.lang.String GRANT_TYPE_CLIENT_CREDENTIALS

The grant type used when requesting an access token using client credentials, typically TLS client certificates. This grant type is not directly supported by this library.

See Also:

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

configuration

@NonNull
public final AuthorizationServiceConfiguration configuration

The service’s configuration. This configuration specifies how to connect to a particular OAuth provider. Configurations may be created manually, or via an OpenID Connect Discovery Document.

clientId

@NonNull
public final java.lang.String clientId

The client identifier.

See Also:

The OAuth 2.0 Authorization Framework (RFC 6749), Section 4, The OAuth 2.0 Authorization Framework (RFC 6749), Section 4.1.1

grantType

@NonNull
public final java.lang.String grantType

The type of token being sent to the token endpoint.

See Also:

The OAuth 2.0 Authorization Framework (RFC 6749), Section 4.1.3

redirectUri

@Nullable
public final android.net.Uri redirectUri

The client’s redirect URI. Required if this token request is to exchange an authorization code for one or more tokens, and must be identical to the value specified in the original authorization request.

See Also:

The OAuth 2.0 Authorization Framework (RFC 6749), Section 3.1.2, The OAuth 2.0 Authorization Framework (RFC 6749), Section 4.1.3

authorizationCode

@Nullable
public final java.lang.String authorizationCode

An authorization code to be exchanged for one or more tokens.

See Also:

The OAuth 2.0 Authorization Framework (RFC 6749), Section 4.1.3

scope

@Nullable
public final java.lang.String scope

A space-delimited set of scopes used to determine the scope of any returned tokens.

See Also:

The OAuth 2.0 Authorization Framework (RFC 6749), Section 3.3, The OAuth 2.0 Authorization Framework (RFC 6749), Section 6

refreshToken

@Nullable
public final java.lang.String refreshToken

A refresh token to be exchanged for a new token.

See Also:

The OAuth 2.0 Authorization Framework (RFC 6749), Section 6

codeVerifier

@Nullable
public final java.lang.String codeVerifier

The code verifier that was used to generate the challenge in the original authorization request, if one was used.

See Also:

Proof Key for Code Exchange by OAuth Public Clients (RFC 7636), Section 4

additionalParameters

@NonNull
public final java.util.Map<java.lang.String,java.lang.String> additionalParameters

Additional parameters to be passed as part of the request.

Method Detail

getScopeSet

@Nullable
public java.util.Set<java.lang.String> getScopeSet()

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

getRequestParameters

@NonNull
public java.util.Map<java.lang.String,java.lang.String> getRequestParameters()

Produces the set of request parameters for this query, which can be further processed into a request body.

jsonSerialize

@NonNull
public org.json.JSONObject jsonSerialize()

Produces a JSON string representation of the token request for persistent storage or local transmission (e.g. between activities).

jsonSerializeString

@NonNull
public java.lang.String jsonSerializeString()

Produces a JSON string representation of the token request for persistent storage or local transmission (e.g. between activities). This method is just a convenience wrapper for jsonSerialize(), converting the JSON object to its string form.

jsonDeserialize

@NonNull
public static TokenRequest jsonDeserialize(org.json.JSONObject json)
                                             throws org.json.JSONException

Reads a token request from a JSON string representation produced by jsonSerialize().

Throws:

org.json.JSONException - if the provided JSON does not match the expected structure.

jsonDeserialize

@NonNull
public static TokenRequest jsonDeserialize(@NonNull
                                                    java.lang.String json)
                                             throws org.json.JSONException

Reads a token request from a JSON string representation produced by jsonSerializeString(). This method is just a convenience wrapper for jsonDeserialize(JSONObject), converting the JSON string to its JSON object form.

Throws:

org.json.JSONException - if the provided JSON does not match the expected structure.