com.here.account.oauth2

Class HereAccessTokenProvider.Builder

java.lang.Object

com.here.account.oauth2.HereAccessTokenProvider.Builder

Enclosing class:

HereAccessTokenProvider

public static class HereAccessTokenProvider.Builder
extends Object

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
HereAccessTokenProvider	build() Build using builders, builders, and more builders.
HereAccessTokenProvider.Builder	setAlwaysRequestNewToken(boolean alwaysRequestNewToken) Default is false.
HereAccessTokenProvider.Builder	setClientAuthorizationRequestProvider(ClientAuthorizationRequestProvider clientAuthorizationRequestProvider) Optionally set your custom ClientAuthorizationRequestProvider, to override the default.
HereAccessTokenProvider.Builder	setHttpProvider(HttpProvider httpProvider) Optionally set your custom HttpProvider, to override the default.
HereAccessTokenProvider.Builder	setRetryPolicy(RetryPolicy retryPolicy) Optionally override the retry policy.
HereAccessTokenProvider.Builder	setSerializer(Serializer serializer) Optionally override the default JSON Serializer.

Methods inherited from class java.lang.Object

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

Method Detail

setClientAuthorizationRequestProvider

public HereAccessTokenProvider.Builder setClientAuthorizationRequestProvider(ClientAuthorizationRequestProvider clientAuthorizationRequestProvider)

Optionally set your custom ClientAuthorizationRequestProvider, to override the default.

Parameters:

clientAuthorizationRequestProvider - the clientAuthorizationRequestProvider to set

Returns:

this Builder

setHttpProvider

public HereAccessTokenProvider.Builder setHttpProvider(HttpProvider httpProvider)

Optionally set your custom HttpProvider, to override the default.

Parameters:

httpProvider - the HttpProvider to set

Returns:

this Builder

setAlwaysRequestNewToken

public HereAccessTokenProvider.Builder setAlwaysRequestNewToken(boolean alwaysRequestNewToken)

Default is false. It is not recommended to set this value to true, in a long-running application. Optionally set this value to true, to make a remote API call for every call to HereAccessTokenProvider.getAccessToken().

Parameters:

alwaysRequestNewToken - default is false. set to true to make every call to get an Access Token, be a remote API call.

Returns:

this Builder

setSerializer

public HereAccessTokenProvider.Builder setSerializer(Serializer serializer)

Optionally override the default JSON Serializer.

Parameters:

serializer - the serializer to set

Returns:

this Builder

setRetryPolicy

public HereAccessTokenProvider.Builder setRetryPolicy(RetryPolicy retryPolicy)

Optionally override the retry policy. Default behaviour is no retry.

Parameters:

retryPolicy - the RetryPolicy

Returns:

this Builder

build

public HereAccessTokenProvider build()

Build using builders, builders, and more builders.

Returns:

the built HereAccessTokenProvider implementation for getting HERE Access Tokens.