org.apache.rahas

Interface TokenPersister

All Superinterfaces:

Runnable

All Known Implementing Classes:

FSBasedRetiredTokenPersister

public interface TokenPersister
extends Runnable

Non-volatile storage interface for for storing security tokens. Persisting should be run as a background process without blocking any other flow. Hence, extending Runnable interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TOKEN_PERSISTER_KEY

Method Summary

Modifier and Type	Method and Description
void	deleteToken(String tokenId) Remove the token, given the token id.
boolean	isTokenExist(String tokenID) Check whether a particular token exists in persistence storage given the token id.
boolean	isTokensExist() To check whether any retired tokens are persisted, before performing any operations to manipulate tokens.
void	notifyPersistence() Notify the persister when persistence needs to happen.
void	persistToken(Token token) Persist a single token
void	persistTokens(Token[] retiredTokens) Persist an array of tokens
Token	retrieveToken(String tokenId) Read a token given it's id.
String[]	retrieveTokenIDs() Obtain the list of token IDs in persistence.
Token[]	retrieveTokens() Read all the persisted tokens.
void	setConfiguration(AbstractIssuerConfig config) Pass persister configuration to be set in the persister implementation.
void	setMessageContext(org.apache.axis2.context.MessageContext msgContext) Set message context in order to get access to message/config context properties.
void	updateToken(Token token) Update the given token in persistence.

Methods inherited from interface java.lang.Runnable

run

Field Detail

TOKEN_PERSISTER_KEY

static final String TOKEN_PERSISTER_KEY

See Also:

Constant Field Values

Method Detail

isTokensExist

boolean isTokensExist()

To check whether any retired tokens are persisted, before performing any operations to manipulate tokens.

Returns:

whether any tokens exist in persister.

isTokenExist

boolean isTokenExist(String tokenID)

Check whether a particular token exists in persistence storage given the token id.

Parameters:

tokenID -

Returns:

persistTokens

void persistTokens(Token[] retiredTokens)
            throws TrustException

Persist an array of tokens

Parameters:

retiredTokens - array of security tokens

Throws:

TrustException

persistToken

void persistToken(Token token)
           throws TrustException

Persist a single token

Parameters:

token -

Throws:

TrustException

retrieveTokens

Token[] retrieveTokens()

Read all the persisted tokens.

Returns:

stored tokens as an array of tokens

retrieveToken

Token retrieveToken(String tokenId)
             throws TrustException

Read a token given it's id.

Parameters:

tokenId -

Returns:

Throws:

TrustException

retrieveTokenIDs

String[] retrieveTokenIDs()

Obtain the list of token IDs in persistence.

Returns:

string array of token ids if exist, else null

updateToken

void updateToken(Token token)
          throws TrustException

Update the given token in persistence.

Parameters:

token -

Throws:

TrustException

deleteToken

void deleteToken(String tokenId)
          throws TrustException

Remove the token, given the token id.

Parameters:

tokenId -

Throws:

TrustException

setConfiguration

void setConfiguration(AbstractIssuerConfig config)
               throws TrustException

Pass persister configuration to be set in the persister implementation.

Parameters:

config -

Throws:

TrustException

setMessageContext

void setMessageContext(org.apache.axis2.context.MessageContext msgContext)

Set message context in order to get access to message/config context properties.

Parameters:

msgContext -

notifyPersistence

void notifyPersistence()

Notify the persister when persistence needs to happen.