com.here.account.oauth2

Class HereAccessTokenProvider

java.lang.Object

com.here.account.oauth2.HereAccessTokenProvider

All Implemented Interfaces:

AccessTokenProvider, AccessTokenSupplier, Closeable, AutoCloseable, Supplier<String>

public class HereAccessTokenProvider
extends Object
implements AccessTokenSupplier, Closeable, AccessTokenProvider

An implementation that provides HERE Access Tokens, by accessing HERE Account via the OAuth2.0 API. Instances facilitate getting and maintaining a HERE Access Token to use on requests to HERE Service REST APIs according to The OAuth 2.0 Authorization Framework: Bearer Token Usage. See also the OAuth2.0 Access Token spec.

To use your provided credentials.ini or credentials.properties file to get a token from the always-fresh implementation, do the following:

 
        try (
            // use your provided System properties, ~/.here/credentials.ini, or credentials.properties file
            HereAccessTokenProvider accessTokens = HereAccessTokenProvider.builder().build()
        ) {
            // call accessTokens.getAccessToken(); every time one is needed, it will always be fresh
            String accessToken = accessTokens.getAccessToken();
            // use accessToken on a request...
        }
 
 

To use your provided credentials.ini or credentials.properties file in an OAuth2Authorizer that uses always-fresh tokens, do the following:

 
        try (
            // use your provided System properties, ~/.here/credentials.ini, or credentials.properties file
            HereAccessTokenProvider accessTokens = HereAccessTokenProvider.builder().build()
            ) {
            OAuth2Authorizer authorizer = new OAuth2Authorizer(() -> {
                return accessTokens.getAccessToken();
            });
            // use the always-fresh authorizer on requests...
         }
 
 

The above examples uses the following defaults as supplied by the Builder:

• alwaysRequestNewToken: false, to enable fast access to an "always fresh" Access Token when getAccessToken() is invoked.
• clientAuthorizationRequestProvider: ClientAuthorizationProviderChain.getNewDefaultClientCredentialsProviderChain(Clock), which checks System properties, ~/.here/credentials.ini, or ~/.here/credentials.properties file.
• httpProvider: a new default ApacheHttpClientProvider.

Each of which may be overridden via appropriate Builder methods.

Author:

kmccrack

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HereAccessTokenProvider.Builder By default the Builder uses ClientAuthorizationProviderChain.getNewDefaultClientCredentialsProviderChain(Clock) for credentials, the ApacheHttpClientProvider, and the "always fresh" Access Token.

Method Summary

Modifier and Type	Method and Description
static HereAccessTokenProvider.Builder	builder() Gets a new Builder for a HERE Access Token Provider.
void	close()
String	get() Gets an OAuth2.0 Access Token.
String	getAccessToken() Gets an OAuth2.0 Access Token.
AccessTokenResponse	getAccessTokenResponse()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static HereAccessTokenProvider.Builder builder()

Gets a new Builder for a HERE Access Token Provider.

Returns:

the Builder

See Also:

HereAccessTokenProvider.Builder

get

public String get()

Gets an OAuth2.0 Access Token.

Specified by:

get in interface AccessTokenSupplier

Specified by:

get in interface Supplier<String>

Returns:

the access token

getAccessToken

public String getAccessToken()

Gets an OAuth2.0 Access Token.

Specified by:

getAccessToken in interface AccessTokenProvider

Returns:

the access token

getAccessTokenResponse

public AccessTokenResponse getAccessTokenResponse()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException