Package org.apache.cxf.rs.security.saml.sso.jcache

Class JCacheTokenReplayCache

java.lang.Object

org.apache.cxf.rs.security.saml.sso.jcache.JCacheTokenReplayCache

All Implemented Interfaces:

Closeable, AutoCloseable, TokenReplayCache<String>

public class JCacheTokenReplayCache
extends Object
implements TokenReplayCache<String>

An in-memory JCache based implementation of the TokenReplayCache interface. The default TTL is 60 minutes and the max TTL is 12 hours.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CACHE_KEY

Constructor Summary

Constructors

Constructor	Description
JCacheTokenReplayCache()
JCacheTokenReplayCache(String configFile)
JCacheTokenReplayCache(String configFile, org.apache.cxf.Bus bus)
JCacheTokenReplayCache(org.apache.cxf.Bus bus)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	contains(String identifier)	Return true if the given identifier is contained in the cache
void	putId(String identifier)	Add the given identifier to the cache.
void	putId(String identifier, Instant expiry)	Add the given identifier to the cache to be cached for the given time

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_KEY

public static final String CACHE_KEY

See Also:

Constant Field Values

Constructor Detail

JCacheTokenReplayCache

public JCacheTokenReplayCache()
                       throws URISyntaxException

Throws:

URISyntaxException

JCacheTokenReplayCache

public JCacheTokenReplayCache(org.apache.cxf.Bus bus)
                       throws URISyntaxException

Throws:

URISyntaxException

JCacheTokenReplayCache

public JCacheTokenReplayCache(String configFile)
                       throws URISyntaxException

Throws:

URISyntaxException

JCacheTokenReplayCache

public JCacheTokenReplayCache(String configFile,
                              org.apache.cxf.Bus bus)
                       throws URISyntaxException

Throws:

URISyntaxException

Method Detail

putId

public void putId(String identifier)

Add the given identifier to the cache. It will be cached for a default amount of time.

Specified by:

putId in interface TokenReplayCache<String>

Parameters:

identifier - The identifier to be added

putId

public void putId(String identifier,
                  Instant expiry)

Add the given identifier to the cache to be cached for the given time

Specified by:

putId in interface TokenReplayCache<String>

Parameters:

identifier - The identifier to be added

expiry - A custom expiry time for the identifier. Can be null in which case, the default expiry is used.

contains

public boolean contains(String identifier)

Return true if the given identifier is contained in the cache

Specified by:

contains in interface TokenReplayCache<String>

Parameters:

identifier - The identifier to check

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface TokenReplayCache<String>