com.here.account.oauth2

Class ClientCredentialsGrantRequest

java.lang.Object

com.here.account.oauth2.AccessTokenRequest

com.here.account.oauth2.ClientCredentialsGrantRequest

All Implemented Interfaces:

OlpHttpMessage

public class ClientCredentialsGrantRequest
extends AccessTokenRequest

An AccessTokenRequest for grant_type=client_credentials.

Author:

kmccrack

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_CREDENTIALS_GRANT_TYPE

Fields inherited from class com.here.account.oauth2.AccessTokenRequest

EXPIRES_IN_FORM, GRANT_TYPE_FORM, GRANT_TYPE_JSON, SCOPE_FORM, SCOPE_JSON

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

X_CORRELATION_ID

Constructor Summary

Constructors

Constructor and Description
ClientCredentialsGrantRequest()

Method Summary

Modifier and Type	Method and Description
ClientCredentialsGrantRequest	setExpiresIn(Long expiresIn) Optionally set the lifetime in seconds of the access token returned by this request.

Methods inherited from class com.here.account.oauth2.AccessTokenRequest

addFormParam, getAdditionalHeaders, getCorrelationId, getExpiresIn, getGrantType, getScope, setAdditionalHeaders, setCorrelationId, setScope, toFormParams, toJson

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_CREDENTIALS_GRANT_TYPE

public static final String CLIENT_CREDENTIALS_GRANT_TYPE

See Also:

Constant Field Values

Constructor Detail

ClientCredentialsGrantRequest

public ClientCredentialsGrantRequest()

Method Detail

setExpiresIn

public ClientCredentialsGrantRequest 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.

Overrides:

setExpiresIn in class AccessTokenRequest

Parameters:

expiresIn - desired lifetime in seconds of the access token

Returns:

this

See Also:

AccessTokenResponse.getExpiresIn(), AccessTokenRequest.getExpiresIn()