com.sap.cloud.security.xsuaa.tokenflows

Class TokenCacheConfiguration

java.lang.Object

com.sap.cloud.security.xsuaa.tokenflows.TokenCacheConfiguration

All Implemented Interfaces:

CacheConfiguration

public class TokenCacheConfiguration
extends Object
implements CacheConfiguration

Data class to capture configuration options of token caches.

Method Summary

Modifier and Type	Method and Description
static TokenCacheConfiguration	cacheDisabled() The default cache configuration.
static TokenCacheConfiguration	defaultConfiguration() A special cache configuration used to disable caching.
boolean	equals(Object o)
Duration	getCacheDuration()
int	getCacheSize()
static TokenCacheConfiguration	getInstance(Duration cacheDuration, int cacheSize, Duration tokenExpirationDelta) Creates a new TokenCacheConfiguration instance with the given properties.
static TokenCacheConfiguration	getInstance(Duration cacheDuration, int cacheSize, Duration tokenExpirationDelta, boolean cacheStatisticsEnabled) Creates a new TokenCacheConfiguration instance with the given properties.
Duration	getTokenExpirationDelta() If a cached token expires because its expiration time (exp) has been reached, it should not be retrieved from the cache.
int	hashCode()
boolean	isCacheStatisticsEnabled()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sap.cloud.security.config.CacheConfiguration

isCacheDisabled

Method Detail

getInstance

public static TokenCacheConfiguration getInstance(@Nonnull
                                                  Duration cacheDuration,
                                                  int cacheSize,
                                                  @Nonnull
                                                  Duration tokenExpirationDelta)

Creates a new TokenCacheConfiguration instance with the given properties. See CacheConfiguration.getCacheDuration(), CacheConfiguration.getCacheSize() and getTokenExpirationDelta() for an explanation of the respective properties.

Parameters:

cacheDuration - the cache duration property.

cacheSize - the cache size property.

tokenExpirationDelta - the token expiration delta.

Returns:

a new TokenCacheConfiguration instance.

getInstance

public static TokenCacheConfiguration getInstance(Duration cacheDuration,
                                                  int cacheSize,
                                                  Duration tokenExpirationDelta,
                                                  boolean cacheStatisticsEnabled)

Creates a new TokenCacheConfiguration instance with the given properties. See CacheConfiguration.getCacheDuration(), CacheConfiguration.getCacheSize(), getTokenExpirationDelta() and CacheConfiguration.isCacheStatisticsEnabled() for an explanation of the respective properties.

Parameters:

cacheDuration - the cache duration property.

cacheSize - the cache size property.

tokenExpirationDelta - the token expiration delta.

cacheStatisticsEnabled - true if cache statistic recording has been enabled

Returns:

a new TokenCacheConfiguration instance.

cacheDisabled

public static TokenCacheConfiguration cacheDisabled()

The default cache configuration.

defaultConfiguration

public static TokenCacheConfiguration defaultConfiguration()

A special cache configuration used to disable caching.

getCacheDuration

@Nonnull
public Duration getCacheDuration()

Specified by:

getCacheDuration in interface CacheConfiguration

getCacheSize

public int getCacheSize()

Specified by:

getCacheSize in interface CacheConfiguration

getTokenExpirationDelta

public Duration getTokenExpirationDelta()

If a cached token expires because its expiration time (exp) has been reached, it should not be retrieved from the cache. A new token should be requested in this case. For this to work cached tokens are being checked if their expiration time (exp) has already been reached or if it is soon going to be reached. The expiration delta controls what soon means. For example if the expiration delta is set to 10 seconds and a cached token will expire in 5 seconds, it will not be retrieved from cache anymore because the duration until the token is expired is smaller than delta.

Returns:

the token expiration delta.

isCacheStatisticsEnabled

public boolean isCacheStatisticsEnabled()

Specified by:

isCacheStatisticsEnabled in interface CacheConfiguration

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object