Package org.forgerock.openig.filter.oauth2

Class CaffeineCacheAccessTokenResolver.Builder

java.lang.Object

org.forgerock.openig.filter.oauth2.CaffeineCacheAccessTokenResolver.Builder

Enclosing class:

CaffeineCacheAccessTokenResolver

public static final class CaffeineCacheAccessTokenResolver.Builder
extends Object

Builder of CaffeineCacheAccessTokenResolver.

Constructor Summary

Constructors

Constructor	Description
Builder(CaffeineAsyncCache.Builder<String,AccessTokenInfo,AccessTokenException> cacheBuilder, AccessTokenResolver delegate, Clock clock, Duration defaultTimeout, Duration maximumTimeout)	Creates a CaffeineCacheAccessTokenResolver.Builder delegating to the given AccessTokenResolver using the given (pre-configured) cache.

Method Summary

Modifier and Type	Method	Description
CaffeineCacheAccessTokenResolver	build()	Returns a new CaffeineCacheAccessTokenResolver instance.
AsyncCache<String,AccessTokenInfo,AccessTokenException>	cache()	Bind the various cache invalidation callbacks and return a cache based on the properties set on the builder.
CaffeineCacheAccessTokenResolver.Builder	disconnectionStrategy(DisconnectionStrategy disconnectionStrategy)	Bind a DisconnectionStrategy instance to this builder.
CaffeineCacheAccessTokenResolver.Builder	notificationService(NotificationService notificationService)	Bind a NotificationService instance to this builder.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(CaffeineAsyncCache.Builder<String,AccessTokenInfo,AccessTokenException> cacheBuilder,
 AccessTokenResolver delegate,
 Clock clock,
 Duration defaultTimeout,
 Duration maximumTimeout)

Creates a CaffeineCacheAccessTokenResolver.Builder delegating to the given AccessTokenResolver using the given (pre-configured) cache.

Parameters:

cacheBuilder - The cache builder to use. Not null.

delegate - The resolver to use. Not null.

clock - A clock providing access to the current instant, date and time using a time-zone, not null.

defaultTimeout - The default duration for which to cache AM access tokens. If an AM access token provides a valid expiresAt value to specify the time until which the access token remains valid, IG uses that value or the maxTimeout. Not null.

maximumTimeout - The maximum duration for which to cache AM access tokens. If the expiresAt value provided by the AM access token is after the current time plus the maxTimeout, IG uses the maxTimeout. Can be null.

Method Details

notificationService

public CaffeineCacheAccessTokenResolver.Builder notificationService(NotificationService notificationService)

Bind a NotificationService instance to this builder.

Parameters:

notificationService - the notificationService to be bound to this builder

Returns:

this Builder

disconnectionStrategy

public CaffeineCacheAccessTokenResolver.Builder disconnectionStrategy(DisconnectionStrategy disconnectionStrategy)

Bind a DisconnectionStrategy instance to this builder.

Parameters:

disconnectionStrategy - the disconnectionStrategy to be bound to this builder

Returns:

this Builder

cache

public AsyncCache<String,AccessTokenInfo,AccessTokenException> cache()

Bind the various cache invalidation callbacks and return a cache based on the properties set on the builder.

Returns:

the AsyncCache to be used when caching an AccessTokenInfo against a particular token.

build

public CaffeineCacheAccessTokenResolver build()

Returns a new CaffeineCacheAccessTokenResolver instance.

Returns:

a new CaffeineCacheAccessTokenResolver instance