com.here.account.util

Class RefreshableResponseProvider<T extends RefreshableResponseProvider.ExpiringResponse>

java.lang.Object

com.here.account.util.RefreshableResponseProvider<T>

public class RefreshableResponseProvider<T extends RefreshableResponseProvider.ExpiringResponse>
extends Object

Use this class if you want to always have an unexpired view of an expiring response object (within reason we expect that each request calls getUnexpiredResponse() which is intended to execute quickly). Strategy is to use a dedicated thread-scheduled executor service, to retrieve and set your ExpiringResponse to be always up-to-date.

Token provider which handles refreshing tokens on a configurable interval.

Note that this implementation does not incur any synchronization; rather it is assumed the refresh interval is less than the maximum time for token so that while the token is refreshing the current token continues to be valid.

Adapted from HERE DG class RefreshableTokenAuthenticationProvider.

Author:

kmccrack, ramsden, Adam Stuenkel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RefreshableResponseProvider.ExpiringResponse Various tokens and keys might be set up in the system to be expiring.
static interface	RefreshableResponseProvider.ResponseRefresher<T extends RefreshableResponseProvider.ExpiringResponse> You can call a response refresher to refresh a previous ExpiringResponse, to keep it unexpired.

Constructor Summary

Constructors

Constructor and Description
RefreshableResponseProvider(Clock clock, Long refreshIntervalMillis, T initialResponse, RefreshableResponseProvider.ResponseRefresher<T> refreshResponseFunction, ScheduledExecutorService scheduledExecutorService)
RefreshableResponseProvider(Long refreshIntervalMillis, T initialResponse, RefreshableResponseProvider.ResponseRefresher<T> refreshResponseFunction) Create a RefreshableResponseProvider with optional refreshIntervalMillis, initialResponse, and refreshResponseFunction.

Method Summary

Modifier and Type	Method and Description
static ScheduledExecutorService	getScheduledExecutorServiceSize1() Gets a here-auth-refresh ScheduledExecutorService with 1 core pool thread.
T	getUnexpiredResponse() Gets the current unexpired response.
protected void	scheduleTokenRefresh(long millis) Schedule the next refresh with the specified timeout duration
void	shutdown() Shutdown the background threads

Methods inherited from class java.lang.Object

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

Constructor Detail

RefreshableResponseProvider

public RefreshableResponseProvider(Long refreshIntervalMillis,
                                   T initialResponse,
                                   RefreshableResponseProvider.ResponseRefresher<T> refreshResponseFunction)

Create a RefreshableResponseProvider with optional refreshIntervalMillis, initialResponse, and refreshResponseFunction.

Parameters:

refreshIntervalMillis - optional. only specify during tests, not in real code. if you want to ignore the normal response expires_in, and instead refresh on a fixed interval not set by the HERE authorization server, specify this value in milliseconds.

initialResponse - the initial value of an active response

refreshResponseFunction - the ability to refresh and get a new response prior to the previous one expiring.

RefreshableResponseProvider

public RefreshableResponseProvider(Clock clock,
                                   Long refreshIntervalMillis,
                                   T initialResponse,
                                   RefreshableResponseProvider.ResponseRefresher<T> refreshResponseFunction,
                                   ScheduledExecutorService scheduledExecutorService)

Method Detail

getScheduledExecutorServiceSize1

public static ScheduledExecutorService getScheduledExecutorServiceSize1()

Gets a here-auth-refresh ScheduledExecutorService with 1 core pool thread.

Returns:

the ScheduledExecutorService size 1

shutdown

public void shutdown()

Shutdown the background threads

getUnexpiredResponse

public T getUnexpiredResponse()

Gets the current unexpired response. Obviously you have to use the data within reason, such as within a few seconds, on your request. It is assumed that your code always comes back to this method, for every API request.

Returns:

the unexpired response

scheduleTokenRefresh

protected void scheduleTokenRefresh(long millis)

Schedule the next refresh with the specified timeout duration

Parameters:

millis - time (msec) in the future to schedule the refresh