org.apache.wss4j.common.cache

Class EHCacheReplayCache

java.lang.Object

org.apache.wss4j.common.cache.EHCacheReplayCache

All Implemented Interfaces:

Closeable, AutoCloseable, ReplayCache

public class EHCacheReplayCache
extends Object
implements ReplayCache

An in-memory EHCache implementation of the ReplayCache interface, that overflows to disk. The default TTL is 60 minutes and the max TTL is 12 hours.

Constructor Summary

Constructors

Constructor and Description
EHCacheReplayCache(String key)
EHCacheReplayCache(String key, Path diskstorePath)
EHCacheReplayCache(String key, Path diskstorePath, long diskSize, long heapEntries, boolean persistent)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EHCacheReplayCache

public EHCacheReplayCache(String key)
                   throws WSSecurityException

Throws:

WSSecurityException

EHCacheReplayCache

public EHCacheReplayCache(String key,
                          Path diskstorePath)
                   throws WSSecurityException

Throws:

WSSecurityException

EHCacheReplayCache

public EHCacheReplayCache(String key,
                          Path diskstorePath,
                          long diskSize,
                          long heapEntries,
                          boolean persistent)
                   throws WSSecurityException

Throws:

WSSecurityException

Method Detail

add

public void add(String identifier)

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

Specified by:

add in interface ReplayCache

Parameters:

identifier - The identifier to be added

add

public void add(String identifier,
                Instant expiry)

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

Specified by:

add in interface ReplayCache

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 ReplayCache

Parameters:

identifier - The identifier to check

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

initComplete

public void initComplete()

preShutdown

public void preShutdown()

postShutdown

public void postShutdown()