Package org.entur.jwt.client

Class AbstractAccessTokenHealthProvider

java.lang.Object

org.entur.jwt.client.BaseAccessTokenProvider

org.entur.jwt.client.AbstractAccessTokenHealthProvider

All Implemented Interfaces:

Closeable, AutoCloseable, AccessTokenHealthProvider, AccessTokenProvider

Direct Known Subclasses:

DefaultAccessTokenHealthProvider, EagerAccessTokenHealthProvider

public abstract class AbstractAccessTokenHealthProvider
extends BaseAccessTokenProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessTokenHealth	providerStatus	The state of the below provider
protected AccessTokenProvider	refreshProvider	Provider to invoke when refreshing state.
protected AccessTokenHealth	status	The state of the top level provider

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

logger, provider

Constructor Summary

Constructors

Constructor	Description
AbstractAccessTokenHealthProvider(AccessTokenProvider provider)

Method Summary

Modifier and Type	Method	Description
AccessToken	getAccessToken(boolean forceRefresh)
AccessTokenHealth	getHealth(boolean refresh)	Get health.
protected abstract AccessTokenHealth	getRefreshHealth()
void	setRefreshProvider(AccessTokenProvider top)
boolean	supportsHealth()

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

close, getProvider

Methods inherited from class java.lang.Object

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

Field Details

providerStatus

protected volatile AccessTokenHealth providerStatus

The state of the below provider

status

protected volatile AccessTokenHealth status

The state of the top level provider

refreshProvider

protected AccessTokenProvider refreshProvider

Provider to invoke when refreshing state. This should be the top level provider, so that caches are actually populated and so on.

Constructor Details

AbstractAccessTokenHealthProvider

public AbstractAccessTokenHealthProvider(AccessTokenProvider provider)

Method Details

getAccessToken

public AccessToken getAccessToken(boolean forceRefresh)
                           throws AccessTokenException

Throws:

AccessTokenException

getHealth

public AccessTokenHealth getHealth(boolean refresh)

Description copied from interface: AccessTokenHealthProvider

Get health. An implementation is expected to refresh the health status if there is no current status, or if the last status was unsuccessful.

Specified by:

getHealth in interface AccessTokenHealthProvider

Overrides:

getHealth in class BaseAccessTokenProvider

Parameters:

refresh - true if the provider (optionally) can refresh the state before returning (typically if the health is missing or bad)

Returns:

health status, or null if none is available.

getRefreshHealth

protected abstract AccessTokenHealth getRefreshHealth()

setRefreshProvider

public void setRefreshProvider(AccessTokenProvider top)

supportsHealth

public boolean supportsHealth()

Specified by:

supportsHealth in interface AccessTokenHealthProvider

Overrides:

supportsHealth in class BaseAccessTokenProvider