org.apache.cxf.ws.security.tokenstore

Class EHCacheTokenStore

java.lang.Object

org.apache.cxf.ws.security.tokenstore.EHCacheTokenStore

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.cxf.buslifecycle.BusLifeCycleListener, TokenStore

public class EHCacheTokenStore
extends Object
implements TokenStore, Closeable, org.apache.cxf.buslifecycle.BusLifeCycleListener

An in-memory EHCache implementation of the TokenStore interface. The default TTL is 60 minutes and the max TTL is 12 hours.

Constructor Summary

Constructors

Constructor and Description
EHCacheTokenStore(String key, org.apache.cxf.Bus b, URL configFileURL)

Method Summary

Modifier and Type	Method and Description
void	add(SecurityToken token) Add the given token to the cache.
void	add(String identifier, SecurityToken token) Add the given token to the cache under the given identifier
void	close()
SecurityToken	getToken(String identifier) Returns the Token of the given identifier
Collection<String>	getTokenIdentifiers() Return the list of all valid token identifiers.
void	initComplete()
void	postShutdown()
void	preShutdown()
void	remove(String identifier) Remove an existing token by its identifier

Methods inherited from class java.lang.Object

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

Constructor Detail

EHCacheTokenStore

public EHCacheTokenStore(String key,
                         org.apache.cxf.Bus b,
                         URL configFileURL)
                  throws TokenStoreException

Throws:

TokenStoreException

Method Detail

add

public void add(SecurityToken token)

Description copied from interface: TokenStore

Add the given token to the cache. The SecurityTokens getId() identifier will be used to key it in the cache.

Specified by:

add in interface TokenStore

Parameters:

token - The token to be added

add

public void add(String identifier,
                SecurityToken token)

Description copied from interface: TokenStore

Add the given token to the cache under the given identifier

Specified by:

add in interface TokenStore

Parameters:

identifier - The identifier to use to key the SecurityToken in the cache

token - The token to be added

remove

public void remove(String identifier)

Description copied from interface: TokenStore

Remove an existing token by its identifier

Specified by:

remove in interface TokenStore

getTokenIdentifiers

public Collection<String> getTokenIdentifiers()

Description copied from interface: TokenStore

Return the list of all valid token identifiers.

Specified by:

getTokenIdentifiers in interface TokenStore

Returns:

As array of (valid) token identifiers

getToken

public SecurityToken getToken(String identifier)

Description copied from interface: TokenStore

Returns the Token of the given identifier

Specified by:

getToken in interface TokenStore

Returns:

The requested Token identified by the given identifier

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

initComplete

public void initComplete()

Specified by:

initComplete in interface org.apache.cxf.buslifecycle.BusLifeCycleListener

preShutdown

public void preShutdown()

Specified by:

preShutdown in interface org.apache.cxf.buslifecycle.BusLifeCycleListener

postShutdown

public void postShutdown()

Specified by:

postShutdown in interface org.apache.cxf.buslifecycle.BusLifeCycleListener