net.openid.appauth

Class TokenRequest

java.lang.Object

net.openid.appauth.TokenRequest

public class TokenRequest
extends 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
Map<String,String>	additionalParameters Additional parameters to be passed as part of the request.
String	authorizationCode An authorization code to be exchanged for one or more tokens.
String	clientId The client identifier.
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 String	GRANT_TYPE_AUTHORIZATION_CODE The grant type used for exchanging an authorization code for one or more tokens.
static String	GRANT_TYPE_CLIENT_CREDENTIALS The grant type used when requesting an access token using client credentials, typically TLS client certificates.
static String	GRANT_TYPE_PASSWORD The grant type used when requesting an access token using a username and password.
static String	GRANT_TYPE_REFRESH_TOKEN The grant type used when exchanging a refresh token for a new token.
String	grantType The type of token being sent to the token endpoint.
Uri	redirectUri The client's redirect URI.
String	refreshToken A refresh token to be exchanged for a new token.
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
static TokenRequest	fromJson(JSONObject json) Reads a token request from a JSON representation produced by the toJson() method or some other equivalent producer.
static TokenRequest	fromJson(String json) Reads a token request from a JSON string representation produced by the toJson() method or some other equivalent producer.
Set<String>	getScopeSet() Derives the set of scopes from the consolidated, space-delimited scopes in the scope field.
JSONObject	toJson() Converts the token request to JSON for storage or transmission.
String	toJsonString() Converts the authorization request 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

GRANT_TYPE_AUTHORIZATION_CODE

public static final String GRANT_TYPE_AUTHORIZATION_CODE

The grant type used for exchanging an authorization code for one or more tokens.

See Also:

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

GRANT_TYPE_REFRESH_TOKEN

public static final String GRANT_TYPE_REFRESH_TOKEN

The grant type used when exchanging a refresh token for a new token.

See Also:

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

GRANT_TYPE_PASSWORD

public static final 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 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 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 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 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 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 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 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 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.5

additionalParameters

@NonNull
public final Map<String,String> additionalParameters

Additional parameters to be passed as part of the request.

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 for this request, the method will return null.

toJson

@NonNull
public JSONObject toJson()

Converts the token request to JSON for storage or transmission.

toJsonString

@NonNull
public String toJsonString()

Converts the authorization request to a JSON string for storage or transmission.

fromJson

@NonNull
public static TokenRequest fromJson(@NonNull
                                             String json)
                                      throws JSONException

Reads a token request from a JSON string representation produced by the toJson() method or some other equivalent producer.

Throws:

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

fromJson

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

Reads a token request from a JSON representation produced by the toJson() method or some other equivalent producer.

Throws:

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