com.here.account.oauth2

Class HereAccount

java.lang.Object

com.here.account.oauth2.HereAccount

public class HereAccount
extends Object

Static entry point to access HERE Account via the OAuth2.0 API. This class facilitates 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.properties to get a one-time use token:

 
        // use your provided credentials.properties
        TokenEndpoint tokenEndpoint = HereAccount.getTokenEndpoint(
                ApacheHttpClientProvider.builder().build(), 
                new OAuth1ClientCredentialsProvider.FromFile(new File("credentials.properties")));
        
        String hereAccessToken = tokenEndpoint.requestToken(
                new ClientCredentialsGrantRequest()).getAccessToken();
        // use hereAccessToken on requests until expires...
   
 

Specific use cases currently supported include:

• Get a one time use HERE Access Token:

   
          // set up url, accessKeyId, and accessKeySecret.
          TokenEndpoint tokenEndpoint = HereAccount.getTokenEndpoint(
                  ApacheHttpClientProvider.builder().build(), 
                  new OAuth1ClientCredentialsProvider(url, accessKeyId, accessKeySecret));
          
          String hereAccessToken = tokenEndpoint.requestToken(
                  new ClientCredentialsGrantRequest()).getAccessToken();
          // use hereAccessToken on requests until expires...
     
   

• Get an auto refreshing HERE Access Token:

   
          // set up url, accessKeyId, and accessKeySecret.
          TokenEndpoint tokenEndpoint = HereAccount.getTokenEndpoint(
                  ApacheHttpClientProvider.builder().build(), 
                  new OAuth1ClientCredentialsProvider(url, accessKeyId, accessKeySecret));
          // call this once and keep a reference to freshToken, such as in your beans
          Fresh<AccessTokenResponse> freshToken = tokenEndpoint.requestAutoRefreshingToken(
                  new ClientCredentialsGrantRequest());
          
          // using your reference to freshToken, for each request, just ask for the token
          // the same hereAccessToken is returned for most of the valid time; but as it nears 
          // expiry the returned value will change.
          String hereAccessToken = freshToken.get().getAccessToken();
          // use hereAccessToken on your request...
     
   

Convenience ClientCredentialsProvider implementations are also available to automatically pull the url, accessKeyId, and accessKeySecret from a Properties object or properties file:

• Get configuration from properties file:

   
          // setup url, accessKeyId, and accessKeySecret as properties in credentials.properties
          TokenEndpoint tokenEndpoint = HereAccount.getTokenEndpoint(
                  ApacheHttpClientProvider.builder().build(), 
                  new OAuth1ClientCredentialsProvider.FromFile(new File("credentials.properties")));
          // choose 
          //   tokenEndpoint.requestToken(new ClientCredentialsGrantRequest());
          // or 
          //   tokenEndpoint.requestAutoRefreshingToken(new ClientCredentialsGrantRequest());
     
   

The above examples use the JavaHttpProvider. Another example HttpProvider from this project below uses pure-Java.

  
        // create a Java HttpProvider
        HttpProvider httpProvider = JavaHttpProvider.builder().build();
        // use httpProvider
 
 

Method Summary

Modifier and Type	Method and Description
static TokenEndpoint	getTokenEndpoint(HttpProvider httpProvider, ClientAuthorizationRequestProvider clientAuthorizationRequestProvider) Get the ability to run various Token Endpoint API calls to the HERE Account Authorization Server.
static TokenEndpoint	getTokenEndpoint(HttpProvider httpProvider, ClientAuthorizationRequestProvider clientAuthorizationRequestProvider, Serializer serializer) Deprecated. use HereAccessTokenProvider.builder() instead
static TokenEndpoint	getTokenEndpoint(HttpProvider httpProvider, ClientCredentialsProvider clientCredentialsProvider) Deprecated. Use of getTokenEndpoint(HttpProvider httpProvider, ClientAuthorizationRequestProvider clientAuthorizationRequestProvider) is suggested This method is solely for backward compatibility Get the ability to run various Token Endpoint API calls to the HERE Account Authorization Server. See OAuth2.0 Obtaining Authorization. The returned TokenEndpoint exposes an abstraction to make calls against the OAuth2 token endpoint identified by the given client credentials provider. In addition, all calls made against the returned endpoint will automatically be injected with the given client credentials.

Methods inherited from class java.lang.Object

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

Method Detail

getTokenEndpoint

public static TokenEndpoint getTokenEndpoint(HttpProvider httpProvider,
                                             ClientCredentialsProvider clientCredentialsProvider)

Deprecated. Use of getTokenEndpoint(HttpProvider httpProvider, ClientAuthorizationRequestProvider clientAuthorizationRequestProvider) is suggested This method is solely for backward compatibility Get the ability to run various Token Endpoint API calls to the HERE Account Authorization Server. See OAuth2.0 Obtaining Authorization. The returned TokenEndpoint exposes an abstraction to make calls against the OAuth2 token endpoint identified by the given client credentials provider. In addition, all calls made against the returned endpoint will automatically be injected with the given client credentials.

Parameters:

httpProvider - the HTTP-layer provider implementation

clientCredentialsProvider - identifies the token endpoint URL and client credentials to be injected into requests

Returns:

a TokenEndpoint representing access for the provided client

getTokenEndpoint

public static TokenEndpoint getTokenEndpoint(HttpProvider httpProvider,
                                             ClientAuthorizationRequestProvider clientAuthorizationRequestProvider)

Get the ability to run various Token Endpoint API calls to the HERE Account Authorization Server. See OAuth2.0 Obtaining Authorization. The returned TokenEndpoint exposes an abstraction to make calls against the OAuth2 token endpoint identified by the given client credentials provider. In addition, all calls made against the returned endpoint will automatically be injected with the given client credentials.

Parameters:

httpProvider - the HTTP-layer provider implementation

clientAuthorizationRequestProvider - identifies the token endpoint URL and client credentials to be injected into requests

Returns:

a TokenEndpoint representing access for the provided client

getTokenEndpoint

@Deprecated
public static TokenEndpoint getTokenEndpoint(HttpProvider httpProvider,
                                                         ClientAuthorizationRequestProvider clientAuthorizationRequestProvider,
                                                         Serializer serializer)

Deprecated. use HereAccessTokenProvider.builder() instead

Use HereAccessTokenProvider.builder() instead.

Parameters:

httpProvider - the HTTP-layer provider implementation

clientAuthorizationRequestProvider - identifies the token endpoint URL and client credentials to be injected into requests

serializer - the Serializer to use

Returns:

a TokenEndpoint representing access for the provided client