com.nimbusds.oauth2.sdk

Class TokenRequest

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

com.nimbusds.oauth2.sdk.TokenRequest

All Implemented Interfaces:

Message, Request

@Immutable
public class TokenRequest
extends AbstractRequest

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

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(URI uri, AuthorizationGrant authzGrant) Creates a new token request, without client authentication and a specified client identifier.
TokenRequest(URI uri, AuthorizationGrant authzGrant, Scope scope) Creates a new token request, without client authentication and a specified client identifier.
TokenRequest(URI uri, ClientAuthentication clientAuth, AuthorizationGrant authzGrant) Creates a new token request with the specified client authentication.
TokenRequest(URI uri, ClientAuthentication clientAuth, AuthorizationGrant authzGrant, Scope scope) Creates a new token request with the specified client authentication.
TokenRequest(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(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).

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationGrant	getAuthorizationGrant() Gets the authorisation grant.
ClientAuthentication	getClientAuthentication() Gets the client authentication.
ClientID	getClientID() Gets the client identifier (for a token request without explicit client authentication).
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.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(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(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(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(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(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(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

getClientAuthentication

public ClientAuthentication getClientAuthentication()

Gets the client authentication.

Returns:

The client authentication, null if none.

See Also:

getClientID()

getClientID

public ClientID getClientID()

Gets the client identifier (for a token request without explicit client authentication).

Returns:

The client identifier, null if not specified.

See Also:

getClientAuthentication()

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.

toHTTPRequest

public HTTPRequest toHTTPRequest()
                          throws SerializeException

Description copied from interface: Request

Returns the matching HTTP request.

Returns:

The HTTP request.

Throws:

SerializeException - If the request message couldn't be serialised to an 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.