com.here.account.oauth2

Class AccessTokenRequest

java.lang.Object

com.here.account.oauth2.AccessTokenRequest

All Implemented Interfaces:

OlpHttpMessage

Direct Known Subclasses:

ClientCredentialsGrantRequest, IdentityTokenRequest

public abstract class AccessTokenRequest
extends Object
implements OlpHttpMessage

One of the OAuth2.0 Authorization Grant Request types supported by HERE.

Author:

kmccrack

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	EXPIRES_IN_FORM expires_in; the parameter name for "expires in" when conveyed in a form body.
protected static String	GRANT_TYPE_FORM
protected static String	GRANT_TYPE_JSON Deprecated. use JacksonSerializer instead
protected static String	SCOPE_FORM
protected static String	SCOPE_JSON Deprecated. use JacksonSerializer instead

Fields inherited from interface com.here.account.olp.OlpHttpMessage

X_CORRELATION_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AccessTokenRequest(String grantType)

Method Summary

Modifier and Type	Method and Description
protected static void	addFormParam(Map<String,List<String>> formParams, String name, Object value) Adds the specified name and value to the form parameters.
Map<String,String>	getAdditionalHeaders() Get any additional headers that will be added to the token request.
String	getCorrelationId() Get the correlationId (the unique value for tracking a request across services and within a service).
Long	getExpiresIn() Gets the expiresIn value, the desired lifetime in seconds of the access token returned by this request.
String	getGrantType()
String	getScope() Get the scope for the token request.
AccessTokenRequest	setAdditionalHeaders(Map<String,String> additionalHeaders)
AccessTokenRequest	setCorrelationId(String correlationId) Set the correlationId (the unique value for tracking a request across services and within a service).
AccessTokenRequest	setExpiresIn(Long expiresIn) Optionally set the lifetime in seconds of the access token returned by this request.
AccessTokenRequest	setScope(String scope) Set the scope for the token request.
Map<String,List<String>>	toFormParams() Converts this request, to its formParams Map representation.
String	toJson() Deprecated. use JacksonSerializer instead

Methods inherited from class java.lang.Object

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

Field Detail

EXPIRES_IN_FORM

protected static final String EXPIRES_IN_FORM

expires_in; the parameter name for "expires in" when conveyed in a form body.

See Also:

Constant Field Values

GRANT_TYPE_JSON

protected static final String GRANT_TYPE_JSON

Deprecated. use JacksonSerializer instead

grantType; the parameter name for "grant type" when conveyed in a JSON body.

See Also:

Constant Field Values

GRANT_TYPE_FORM

protected static final String GRANT_TYPE_FORM

See Also:

Constant Field Values

SCOPE_JSON

protected static final String SCOPE_JSON

Deprecated. use JacksonSerializer instead

scope; the parameter name for "scope" when conveyed in a JSON body.

See Also:

Constant Field Values

SCOPE_FORM

protected static final String SCOPE_FORM

See Also:

Constant Field Values

Constructor Detail

AccessTokenRequest

protected AccessTokenRequest(String grantType)

Method Detail

getGrantType

public String getGrantType()

setExpiresIn

public AccessTokenRequest setExpiresIn(Long expiresIn)

Optionally set the lifetime in seconds of the access token returned by this request. Must be a positive number. Ignored if greater than the maximum expiration for the client application. Typically you can set this from 1 to 86400, the latter representing 24 hours.

While the OAuth2.0 RFC doesn't list this as a request parameter, we add this so the client can request Access Token expirations within the allowable range. See also the response parameter expires_in.

This property is a HERE extension to RFC6749 providing additional data.

Parameters:

expiresIn - desired lifetime in seconds of the access token

Returns:

this

See Also:

AccessTokenResponse.getExpiresIn(), getExpiresIn()

getExpiresIn

public Long getExpiresIn()

Gets the expiresIn value, the desired lifetime in seconds of the access token returned by this request.

This property is a HERE extension to RFC6749 providing additional data.

Returns:

the expiresIn value, the desired lifetime in seconds of the access token returned by this request.

getScope

public String getScope()

Get the scope for the token request. See also Requesting Claims using Scope Values.

The example values are "openid sdp:GROUP-6bb1bfd9-8bdc-46c2-85cd-754068aa9497, GROUP-84ba52de-f80b-4047-a024-33d81e6153df" openid : Specifies the idToken is expected in the response sdp:[List of groupId separated by ','] or hrn:here:authorization::rlm0000:project/my-project-0000 A projectHRN for a Project-scoped token

Returns:

the scope

setScope

public AccessTokenRequest setScope(String scope)

Set the scope for the token request. See also Requesting Claims using Scope Values.

The example values are "openid sdp:GROUP-6bb1bfd9-8bdc-46c2-85cd-754068aa9497, GROUP-84ba52de-f80b-4047-a024-33d81e6153df". or hrn:here:authorization::rlm0000:project/my-project-0000 A projectHRN for a Project-scoped token

Parameters:

scope - the scope to set

Returns:

this

getAdditionalHeaders

public Map<String,String> getAdditionalHeaders()

Get any additional headers that will be added to the token request.

Returns:

the additional headers

setAdditionalHeaders

public AccessTokenRequest setAdditionalHeaders(Map<String,String> additionalHeaders)

getCorrelationId

public String getCorrelationId()

Get the correlationId (the unique value for tracking a request across services and within a service).

Specified by:

getCorrelationId in interface OlpHttpMessage

Returns:

the correlationId

setCorrelationId

public AccessTokenRequest setCorrelationId(String correlationId)

Set the correlationId (the unique value for tracking a request across services and within a service).

Specified by:

setCorrelationId in interface OlpHttpMessage

Parameters:

correlationId - the correlationId

Returns:

the class implementing this method. Allows chaining methods, e.g. classInstance.setCorrelationId("abc123").setFoo().setBar()

toJson

@Deprecated
public String toJson()

Deprecated. use JacksonSerializer instead

Converts this request, into its JSON body representation.

Returns:

the JSON body, for use with application/json bodies

toFormParams

public Map<String,List<String>> toFormParams()

Converts this request, to its formParams Map representation.

Returns:

the formParams, for use with application/x-www-form-urlencoded bodies.

addFormParam

protected static final void addFormParam(Map<String,List<String>> formParams,
                                         String name,
                                         Object value)

Adds the specified name and value to the form parameters. If the value is non-null, the name and singleton-List of the value.toString() is added to the formParams Map.

Parameters:

formParams - the formParams Map, for use with application/x-www-form-urlencoded bodies

name - the name of the form parameter

value - the value of the form parameter