org.apache.cxf.ws.security.tokenstore
Interface TokenStore

All Known Implementing Classes:

MemoryTokenStore

public interface TokenStore

Method Summary

void	add(SecurityToken token) Add the given token to the list.
Collection<SecurityToken>	getCancelledTokens() Return the list of CANCELLED tokens
Collection<SecurityToken>	getExpiredTokens() Return the list of EXPIRED tokens.
Collection<SecurityToken>	getRenewedTokens() Return the list of RENEWED tokens.
SecurityToken	getToken(String id) Returns the Token of the given id
SecurityToken	getTokenByAssociatedHash(int hashCode) Returns the Token by the associated hash.
Collection<String>	getTokenIdentifiers() Return the list of all token identifiers.
Collection<SecurityToken>	getValidTokens() Return the list of ISSUED and RENEWED tokens.
void	remove(SecurityToken token) Remove an existing token.
void	removeCancelledTokens() Removes all cancelled tokens.
void	removeExpiredTokens() Removes all expired tokens.
void	setAutoRemoveTokens(boolean auto) Controls whether the store will automatically remove cancelled and expired tokens.
void	update(SecurityToken token) Update an existing token.

Method Detail

add

void add(SecurityToken token)

Add the given token to the list.

Parameters:

token - The token to be added

Throws:

TokenStoreException

update

void update(SecurityToken token)

Update an existing token.

Parameters:

token -

remove

void remove(SecurityToken token)

Remove an existing token.

getTokenIdentifiers

Collection<String> getTokenIdentifiers()

Return the list of all token identifiers.

Returns:

As array of token identifiers

getExpiredTokens

Collection<SecurityToken> getExpiredTokens()

Return the list of EXPIRED tokens. If there are no EXPIRED tokens null will be returned

Returns:

An array of expired Tokens

getValidTokens

Collection<SecurityToken> getValidTokens()

Return the list of ISSUED and RENEWED tokens.

Returns:

An array of ISSUED and RENEWED Tokens.

getRenewedTokens

Collection<SecurityToken> getRenewedTokens()

Return the list of RENEWED tokens.

Returns:

An array of RENEWED Tokens

getCancelledTokens

Collection<SecurityToken> getCancelledTokens()

Return the list of CANCELLED tokens

Returns:

An array of CANCELLED Tokens

getToken

SecurityToken getToken(String id)

Returns the Token of the given id

Parameters:

id -

Returns:

The requested Token identified by the give id

getTokenByAssociatedHash

SecurityToken getTokenByAssociatedHash(int hashCode)

Returns the Token by the associated hash.

Parameters:

hashCode -

Returns:

the Token by the associated hash.

removeExpiredTokens

void removeExpiredTokens()

Removes all expired tokens.

removeCancelledTokens

void removeCancelledTokens()

Removes all cancelled tokens.

setAutoRemoveTokens

void setAutoRemoveTokens(boolean auto)

Controls whether the store will automatically remove cancelled and expired tokens. If true, calls to getCancelledTokens() and getExpiredTokens() will never return value;

Parameters:

auto -