Package org.entur.jwt.client

Class DefaultCachedAccessTokenProvider

java.lang.Object

org.entur.jwt.client.BaseAccessTokenProvider

org.entur.jwt.client.AbstractCachedAccessTokenProvider

org.entur.jwt.client.DefaultCachedAccessTokenProvider

All Implemented Interfaces:

Closeable, AutoCloseable, AccessTokenHealthProvider, AccessTokenProvider

Direct Known Subclasses:

PreemptiveCachedAccessTokenProvider

public class DefaultCachedAccessTokenProvider
extends AbstractCachedAccessTokenProvider

Caching AccessTokenProvider. Blocks when the cache is updated.

Nested Class Summary

Nested classes/interfaces inherited from class org.entur.jwt.client.AbstractCachedAccessTokenProvider

AbstractCachedAccessTokenProvider.AccessTokenCacheItem

Field Summary

Fields

Modifier and Type	Field	Description
protected final ReentrantLock	lock
protected final long	minimumTimeToLive
protected final long	refreshTimeout

Fields inherited from class org.entur.jwt.client.AbstractCachedAccessTokenProvider

cache

Fields inherited from class org.entur.jwt.client.BaseAccessTokenProvider

logger, provider

Constructor Summary

Constructors

Constructor	Description
DefaultCachedAccessTokenProvider(AccessTokenProvider provider, long minimumTimeToLive, long refreshTimeout)	Construct new instance.
DefaultCachedAccessTokenProvider(AccessTokenProvider provider, long minimumTimeToLiveUnits, TimeUnit minimumTimeToLiveUnit, long refreshTimeoutUnits, TimeUnit refreshTimeoutUnit)	Construct new instance.

Method Summary

Modifier and Type	Method	Description
void	close()
protected AbstractCachedAccessTokenProvider.AccessTokenCacheItem	createCacheItem(long time, AccessToken accessToken)
protected AccessToken	getAccessToken(long time, boolean forceUpdate)
protected AbstractCachedAccessTokenProvider.AccessTokenCacheItem	getAccessTokenBlocking(long time, AbstractCachedAccessTokenProvider.AccessTokenCacheItem cache)
AccessToken	getCachedAccessToken()	Get cached token.
long	getMinimumTimeToLive()
long	getRefreshTimeout()
protected AbstractCachedAccessTokenProvider.AccessTokenCacheItem	loadAccessTokenFromProvider(long time)

Methods inherited from class org.entur.jwt.client.AbstractCachedAccessTokenProvider

getAccessToken, getCache, getCachedAccessToken

Methods inherited from class org.entur.jwt.client.BaseAccessTokenProvider

getHealth, getProvider, supportsHealth

Methods inherited from class java.lang.Object

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

Field Details

lock

protected final ReentrantLock lock

minimumTimeToLive

protected final long minimumTimeToLive

refreshTimeout

protected final long refreshTimeout

Constructor Details

DefaultCachedAccessTokenProvider

public DefaultCachedAccessTokenProvider(AccessTokenProvider provider,
 long minimumTimeToLiveUnits,
 TimeUnit minimumTimeToLiveUnit,
 long refreshTimeoutUnits,
 TimeUnit refreshTimeoutUnit)

Construct new instance.

Parameters:

provider - Access-token provider

minimumTimeToLiveUnits - minimum time to live (left when returned by AbstractCachedAccessTokenProvider.getAccessToken(boolean)).

minimumTimeToLiveUnit - minimum time to live unit

refreshTimeoutUnits - cache refresh timeout

refreshTimeoutUnit - cache refresh timeout unit

DefaultCachedAccessTokenProvider

public DefaultCachedAccessTokenProvider(AccessTokenProvider provider,
 long minimumTimeToLive,
 long refreshTimeout)

Construct new instance.

Parameters:

provider - Access-token provider

minimumTimeToLive - minimum time to live left when returned by AbstractCachedAccessTokenProvider.getAccessToken(boolean).

refreshTimeout - cache refresh timeout unit

Method Details

getCachedAccessToken

public AccessToken getCachedAccessToken()

Get cached token.

Returns:

token, null if cache is not populated

getAccessToken

protected AccessToken getAccessToken(long time,
 boolean forceUpdate)
                              throws AccessTokenException

Throws:

AccessTokenException

getAccessTokenBlocking

protected AbstractCachedAccessTokenProvider.AccessTokenCacheItem getAccessTokenBlocking(long time,
 AbstractCachedAccessTokenProvider.AccessTokenCacheItem cache)
                                                                                 throws AccessTokenException

Throws:

AccessTokenException

loadAccessTokenFromProvider

protected AbstractCachedAccessTokenProvider.AccessTokenCacheItem loadAccessTokenFromProvider(long time)
                                                                                      throws AccessTokenException

Throws:

AccessTokenException

createCacheItem

protected AbstractCachedAccessTokenProvider.AccessTokenCacheItem createCacheItem(long time,
 AccessToken accessToken)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class BaseAccessTokenProvider

Throws:

IOException

getMinimumTimeToLive

public long getMinimumTimeToLive()

getRefreshTimeout

public long getRefreshTimeout()