com.here.account.oauth2

Class FileAccessTokenResponse

java.lang.Object

com.here.account.oauth2.AccessTokenResponse

com.here.account.oauth2.FileAccessTokenResponse

All Implemented Interfaces:

OlpHttpMessage, RefreshableResponseProvider.ExpiringResponse

public class FileAccessTokenResponse
extends AccessTokenResponse

A FileAccessTokenResponse provides access to an Access Token read from a File. Because Files may have been written in the past, the method getExp() gives you the proper expiration time, and getExpiresIn() is dynamically computed to behave as though you just got the response from a server.

Author:

kmccrack

Field Summary

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

X_CORRELATION_ID

Constructor Summary

Constructors

Constructor and Description
FileAccessTokenResponse()
FileAccessTokenResponse(String accessToken, String tokenType, Long expiresIn, String refreshToken, String idToken, Long exp) Deprecated.
FileAccessTokenResponse(String accessToken, String tokenType, Long expiresIn, String refreshToken, String idToken, Long exp, String scope) Construct a FileAccessTokenResponse with the specified values.

Method Summary

Modifier and Type	Method and Description
Long	getExp() exp The "exp" (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing.
Long	getExpiresIn() In a File-based Access Token Response, the access_token may have been written long ago, and the appropriate expiresIn value is derived from the fixed quantity "exp" seconds minus the time of this object creation in seconds.

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

getAccessToken, getCorrelationId, getIdToken, getRefreshToken, getScope, getStartTimeMilliseconds, getTokenType, setCorrelationId

Methods inherited from class java.lang.Object

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

Constructor Detail

FileAccessTokenResponse

public FileAccessTokenResponse()

FileAccessTokenResponse

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

Deprecated.

Please use FileAccessTokenResponse(String, String, Long, String, String, Long, String).

Parameters:

accessToken - the accessToken

tokenType - the tokenType, for example "bearer"

expiresIn - the expiresIn, in seconds to expiration

refreshToken - the refreshToken

idToken - the idToken

exp - the expiration time in UTC seconds

FileAccessTokenResponse

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

Construct a FileAccessTokenResponse with the specified values.

Parameters:

accessToken - the accessToken

tokenType - the tokenType, for example "bearer"

expiresIn - the expiresIn, in seconds to expiration

refreshToken - the refreshToken

idToken - the idToken

exp - the expiration time in UTC seconds

scope - the scope of the accessToken, if applicable

Method Detail

getExpiresIn

public Long getExpiresIn()

In a File-based Access Token Response, the access_token may have been written long ago, and the appropriate expiresIn value is derived from the fixed quantity "exp" seconds minus the time of this object creation in seconds.

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

Overrides:

getExpiresIn in class AccessTokenResponse

Returns:

the expires_in

getExp

public Long getExp()

exp The "exp" (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing.

See also JSON Web Token (JWT): "exp" (Expiration Time) Claim.

It is of type "NumericDate": A JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds.

See also JSON Web Token (JWT): Terminology.

Returns:

the exp