com.here.account.oauth2

Class AccessTokenResponse

java.lang.Object

com.here.account.oauth2.AccessTokenResponse

All Implemented Interfaces:

OlpHttpMessage, RefreshableResponseProvider.ExpiringResponse

Direct Known Subclasses:

FileAccessTokenResponse

public class AccessTokenResponse
extends Object
implements RefreshableResponseProvider.ExpiringResponse, OlpHttpMessage

Represents a parsed response received from an OAuth2.0 token endpoint. See the OAuth2.0 Successful Response section for details.

Author:

kmccrack

Field Summary

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

X_CORRELATION_ID

Constructor Summary

Constructors

Constructor and Description
AccessTokenResponse()
AccessTokenResponse(String accessToken, String tokenType, Long expiresIn, String refreshToken, String idToken) Deprecated.
AccessTokenResponse(String accessToken, String tokenType, Long expiresIn, String refreshToken, String idToken, String scope)

Method Summary

Modifier and Type	Method and Description
String	getAccessToken() HERE Access Token.
String	getCorrelationId() Get the correlationId (the unique value for tracking a request across services and within a service).
Long	getExpiresIn() Seconds until expiration, at time of receipt of this object.
String	getIdToken()
String	getRefreshToken() If non-null, the refreshToken allows you to re-authorize and get a new fresh accessToken.
String	getScope() Scope the token has access to.
Long	getStartTimeMilliseconds() Current time milliseconds UTC at the time of construction of this object.
String	getTokenType() The returned type of the token.
AccessTokenResponse	setCorrelationId(String correlationId) Set the correlationId (the unique value for tracking a request across services and within a service).

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessTokenResponse

public AccessTokenResponse()

AccessTokenResponse

@Deprecated
public AccessTokenResponse(String accessToken,
                                       String tokenType,
                                       Long expiresIn,
                                       String refreshToken,
                                       String idToken)

Deprecated.

AccessTokenResponse

public AccessTokenResponse(String accessToken,
                           String tokenType,
                           Long expiresIn,
                           String refreshToken,
                           String idToken,
                           String scope)

Method Detail

getAccessToken

public String getAccessToken()

HERE Access Token.

From OAuth2.0 access_token REQUIRED. The access token issued by the authorization server.

Returns:

the access_token

getTokenType

public String getTokenType()

The returned type of the token.

From OAuth2.0 token_type REQUIRED. The type of the token issued as described in Section 7.1. Value is case insensitive.

Returns:

the token_type

getExpiresIn

public Long getExpiresIn()

Seconds until expiration, at time of receipt of this object.

From OAuth2.0 expires_in RECOMMENDED. The lifetime in seconds of the access token. For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated. If omitted, the authorization server SHOULD provide the expiration time via other means or document the default value.

Specified by:

getExpiresIn in interface RefreshableResponseProvider.ExpiringResponse

Returns:

the expires_in

getRefreshToken

public String getRefreshToken()

If non-null, the refreshToken allows you to re-authorize and get a new fresh accessToken. Remember, client_credentials grants never return a refresh token. Resource owner password grants, and refresh token grants, sometimes do.

From OAuth2.0 refresh_token OPTIONAL. The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in Section 6.

Returns:

the refresh_token

getStartTimeMilliseconds

public Long getStartTimeMilliseconds()

Current time milliseconds UTC at the time of construction of this object. In practice, this can generally be considered to be close to the time of receipt of the object from the server.

Specified by:

getStartTimeMilliseconds in interface RefreshableResponseProvider.ExpiringResponse

Returns:

the start time in milliseconds UTC when this object was received.

getIdToken

public String getIdToken()

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 AccessTokenResponse 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()

getScope

public String getScope()

Scope the token has access to.

Returns:

null, openId or project scope