com.here.account.oauth2

Interface TokenEndpoint

public interface TokenEndpoint

A TokenEndpoint directly corresponds to the token endpoint as specified in the OAuth2.0 Specification. See OAuth2.0 Token Endpoint.

Method Summary

Modifier and Type	Method and Description
Fresh<AccessTokenResponse>	requestAutoRefreshingToken(AccessTokenRequest request) POST to the token endpoint to get an always fresh HERE Access Token, for use with HERE Services.
Fresh<AccessTokenResponse>	requestAutoRefreshingToken(Supplier<AccessTokenRequest> requestSupplier) POST to the token endpoint to get an always fresh HERE Access Token, for use with HERE Services.
AccessTokenResponse	requestToken(AccessTokenRequest request) POST to the token endpoint to get a HERE Access Token, for use with HERE Services.

Method Detail

requestToken

AccessTokenResponse requestToken(AccessTokenRequest request)
                          throws AccessTokenException,
                                 RequestExecutionException,
                                 ResponseParsingException

POST to the token endpoint to get a HERE Access Token, for use with HERE Services. Returns just the token, to be used as an Authorization: Bearer token value. See OAuth2.0, and OAuth2.0 Bearer Token Usage for details.

Parameters:

request - the token request

Returns:

the Access Token that can be used as Bearer token for HERE Service requests

Throws:

AccessTokenException - if you had trouble authenticating your request to the authorization server, or the authorization server rejected your request

RequestExecutionException - if trouble processing the request

ResponseParsingException - if trouble parsing the response

requestAutoRefreshingToken

Fresh<AccessTokenResponse> requestAutoRefreshingToken(AccessTokenRequest request)
                                               throws AccessTokenException,
                                                      RequestExecutionException,
                                                      ResponseParsingException

POST to the token endpoint to get an always fresh HERE Access Token, for use with HERE Services. The returned token is wrapped in a Fresh, and is periodically and automatically refreshed before it expires. The token can be used as an Authorization: Bearer token value. See OAuth2.0, and OAuth2.0 Bearer Token Usage for details.

Parameters:

request - the token request

Returns:

a Fresh wrapped Access Token that can be used as Bearer token for HERE Service requests the returned Fresh will always give an unexpired access token on a call to get()

Throws:

AccessTokenException - if you had trouble authenticating your request to the authorization server, or the authorization server rejected your request

RequestExecutionException - if trouble processing the request

ResponseParsingException - if trouble parsing the response

requestAutoRefreshingToken

Fresh<AccessTokenResponse> requestAutoRefreshingToken(Supplier<AccessTokenRequest> requestSupplier)
                                               throws AccessTokenException,
                                                      RequestExecutionException,
                                                      ResponseParsingException

POST to the token endpoint to get an always fresh HERE Access Token, for use with HERE Services. The returned token is wrapped in a Fresh, and is periodically and automatically refreshed before it expires. The token can be used as an Authorization: Bearer token value. See OAuth2.0, and OAuth2.0 Bearer Token Usage for details.

Parameters:

requestSupplier - a Supplier of token requests, to be used for each attempt to get a fresh token.

Returns:

a Fresh wrapped Access Token that can be used as Bearer token for HERE Service requests the returned Fresh will always give an unexpired access token on a call to get()

Throws:

AccessTokenException - if you had trouble authenticating your request to the authorization server, or the authorization server rejected your request

RequestExecutionException - if trouble processing the request

ResponseParsingException - if trouble parsing the response