com.nimbusds.oauth2.sdk

Class TokenRequest

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

com.nimbusds.oauth2.sdk.AbstractOptionallyAuthenticatedRequest

com.nimbusds.oauth2.sdk.AbstractOptionallyIdentifiedRequest

com.nimbusds.oauth2.sdk.TokenRequest

All Implemented Interfaces:

Message, Request

@Immutable
public class TokenRequest
extends AbstractOptionallyIdentifiedRequest

Token request. Used to obtain an access token and an optional refresh token at the Token endpoint of the authorisation server. Supports custom request parameters.

Example token request with an authorisation code grant:

 POST /token HTTP/1.1
 Host: server.example.com
 Content-Type: application/x-www-form-URIencoded
 Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW

 grant_type=authorization_code
 &code=SplxlOBeZQQYbYS6WxSbIA
 &redirect_uri=https%3A%2F%2Fclient.example.org%2Fcb
 

Related specifications:

• OAuth 2.0 (RFC 6749), sections 4.1.3, 4.3.2, 4.4.2 and 6.

Constructor Summary

Constructors

Constructor and Description
TokenRequest(java.net.URI uri, AuthorizationGrant authzGrant) Creates a new token request, without client authentication and a specified client identifier.
TokenRequest(java.net.URI uri, AuthorizationGrant authzGrant, Scope scope) Creates a new token request, without client authentication and a specified client identifier.
TokenRequest(java.net.URI uri, ClientAuthentication clientAuth, AuthorizationGrant authzGrant) Creates a new token request with the specified client authentication.
TokenRequest(java.net.URI uri, ClientAuthentication clientAuth, AuthorizationGrant authzGrant, Scope scope) Creates a new token request with the specified client authentication.
TokenRequest(java.net.URI uri, ClientAuthentication clientAuth, AuthorizationGrant authzGrant, Scope scope, java.util.Map<java.lang.String,java.lang.String> customParams) Creates a new token request with the specified client authentication and additional custom parameters.
TokenRequest(java.net.URI uri, ClientID clientID, AuthorizationGrant authzGrant) Creates a new token request, with no explicit client authentication (may be present in the grant depending on its type).
TokenRequest(java.net.URI uri, ClientID clientID, AuthorizationGrant authzGrant, Scope scope) Creates a new token request, with no explicit client authentication (may be present in the grant depending on its type).
TokenRequest(java.net.URI uri, ClientID clientID, AuthorizationGrant authzGrant, Scope scope, java.util.Map<java.lang.String,java.lang.String> customParams) Creates a new token request, with no explicit client authentication (may be present in the grant depending on its type) and additional custom parameters.

Method Summary

Modifier and Type	Method and Description
AuthorizationGrant	getAuthorizationGrant() Gets the authorisation grant.
java.lang.String	getCustomParameter(java.lang.String name) Returns the specified custom parameter included in the request body.
java.util.Map<java.lang.String,java.lang.String>	getCustomParameters() Returns the additional custom parameters included in the request body.
Scope	getScope() Gets the requested scope.
static TokenRequest	parse(HTTPRequest httpRequest) Parses a token request from the specified HTTP request.
HTTPRequest	toHTTPRequest() Returns the matching HTTP request.

Methods inherited from class com.nimbusds.oauth2.sdk.AbstractOptionallyIdentifiedRequest

getClientID

Methods inherited from class com.nimbusds.oauth2.sdk.AbstractOptionallyAuthenticatedRequest

getClientAuthentication

Methods inherited from class com.nimbusds.oauth2.sdk.AbstractRequest

getEndpointURI

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenRequest

public TokenRequest(java.net.URI uri,
                    ClientAuthentication clientAuth,
                    AuthorizationGrant authzGrant,
                    Scope scope)

Creates a new token request with the specified client authentication.

Parameters:

uri - The URI of the token endpoint. May be null if the toHTTPRequest() method will not be used.

clientAuth - The client authentication. Must not be null.

authzGrant - The authorisation grant. Must not be null.

scope - The requested scope, null if not specified.

TokenRequest

public TokenRequest(java.net.URI uri,
                    ClientAuthentication clientAuth,
                    AuthorizationGrant authzGrant,
                    Scope scope,
                    java.util.Map<java.lang.String,java.lang.String> customParams)

Creates a new token request with the specified client authentication and additional custom parameters.

Parameters:

uri - The URI of the token endpoint. May be null if the toHTTPRequest() method will not be used.

clientAuth - The client authentication. Must not be null.

authzGrant - The authorisation grant. Must not be null.

scope - The requested scope, null if not specified.

customParams - Additional custom parameters to be included in the request body, empty map or null if none.

TokenRequest

public TokenRequest(java.net.URI uri,
                    ClientAuthentication clientAuth,
                    AuthorizationGrant authzGrant)

Creates a new token request with the specified client authentication.

Parameters:

uri - The URI of the token endpoint. May be null if the toHTTPRequest() method will not be used.

clientAuth - The client authentication. Must not be null.

authzGrant - The authorisation grant. Must not be null.

TokenRequest

public TokenRequest(java.net.URI uri,
                    ClientID clientID,
                    AuthorizationGrant authzGrant,
                    Scope scope)

Creates a new token request, with no explicit client authentication (may be present in the grant depending on its type).

Parameters:

uri - The URI of the token endpoint. May be null if the toHTTPRequest() method will not be used.

clientID - The client identifier, null if not specified.

authzGrant - The authorisation grant. Must not be null.

scope - The requested scope, null if not specified.

TokenRequest

public TokenRequest(java.net.URI uri,
                    ClientID clientID,
                    AuthorizationGrant authzGrant,
                    Scope scope,
                    java.util.Map<java.lang.String,java.lang.String> customParams)

Creates a new token request, with no explicit client authentication (may be present in the grant depending on its type) and additional custom parameters.

Parameters:

uri - The URI of the token endpoint. May be null if the toHTTPRequest() method will not be used.

clientID - The client identifier, null if not specified.

authzGrant - The authorisation grant. Must not be null.

scope - The requested scope, null if not specified.

customParams - Additional custom parameters to be included in the request body, empty map or null if none.

TokenRequest

public TokenRequest(java.net.URI uri,
                    ClientID clientID,
                    AuthorizationGrant authzGrant)

Creates a new token request, with no explicit client authentication (may be present in the grant depending on its type).

Parameters:

uri - The URI of the token endpoint. May be null if the toHTTPRequest() method will not be used.

clientID - The client identifier, null if not specified.

authzGrant - The authorisation grant. Must not be null.

TokenRequest

public TokenRequest(java.net.URI uri,
                    AuthorizationGrant authzGrant,
                    Scope scope)

Creates a new token request, without client authentication and a specified client identifier.

Parameters:

uri - The URI of the token endpoint. May be null if the toHTTPRequest() method will not be used.

authzGrant - The authorisation grant. Must not be null.

scope - The requested scope, null if not specified.

TokenRequest

public TokenRequest(java.net.URI uri,
                    AuthorizationGrant authzGrant)

Creates a new token request, without client authentication and a specified client identifier.

Parameters:

uri - The URI of the token endpoint. May be null if the toHTTPRequest() method will not be used.

authzGrant - The authorisation grant. Must not be null.

Method Detail

getAuthorizationGrant

public AuthorizationGrant getAuthorizationGrant()

Gets the authorisation grant.

Returns:

The authorisation grant.

getScope

public Scope getScope()

Gets the requested scope.

Returns:

The requested scope, null if not specified.

getCustomParameters

public java.util.Map<java.lang.String,java.lang.String> getCustomParameters()

Returns the additional custom parameters included in the request body.

Example:

 resource=http://xxxxxx/PartyOData
 

Returns:

The additional custom parameters as a unmodifiable map, empty map if none.

getCustomParameter

public java.lang.String getCustomParameter(java.lang.String name)

Returns the specified custom parameter included in the request body.

Parameters:

name - The parameter name. Must not be null.

Returns:

The parameter value, null if not specified.

toHTTPRequest

public HTTPRequest toHTTPRequest()

Description copied from interface: Request

Returns the matching HTTP request.

Returns:

The HTTP request.

parse

public static TokenRequest parse(HTTPRequest httpRequest)
                          throws ParseException

Parses a token request from the specified HTTP request.

Parameters:

httpRequest - The HTTP request. Must not be null.

Returns:

The token request.

Throws:

ParseException - If the HTTP request couldn't be parsed to a token request.