org.apache.rahas.impl

Class FSBasedRetiredTokenPersister

java.lang.Object

org.apache.rahas.impl.FSBasedRetiredTokenPersister

All Implemented Interfaces:

Runnable, TokenPersister

public class FSBasedRetiredTokenPersister
extends Object
implements TokenPersister

This implements a file system based non-volatile storage mechanism for retired security tokens. This is accessed by/through token persister which handles concurrency with read/write locks. Hence read/write locks are not incorporated here.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxTokensInMemory
protected String	securityTokenStorageFilePath
protected TokenStorage	tokenStorage

Fields inherited from interface org.apache.rahas.TokenPersister

TOKEN_PERSISTER_KEY

Constructor Summary

Constructors

Constructor and Description
FSBasedRetiredTokenPersister()

Method Summary

Modifier and Type	Method and Description
void	deleteToken(String tokenId) Remove the token, given the token id.
List<String>	getRetiredTokens(List<Token> inMemoryTokens) Obtain the list of tokens that are to be persisted.
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	run() When an object implementing interface Runnable is used to create a thread, starting the thread causes the object's run method to be called in that separately executing thread.
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 class java.lang.Object

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

Field Detail

securityTokenStorageFilePath

protected String securityTokenStorageFilePath

maxTokensInMemory

protected int maxTokensInMemory

tokenStorage

protected TokenStorage tokenStorage

Constructor Detail

FSBasedRetiredTokenPersister

public FSBasedRetiredTokenPersister()

Method Detail

isTokensExist

public boolean isTokensExist()

Description copied from interface: TokenPersister

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

Specified by:

isTokensExist in interface TokenPersister

Returns:

whether any tokens exist in persister.

isTokenExist

public boolean isTokenExist(String tokenID)

Description copied from interface: TokenPersister

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

Specified by:

isTokenExist in interface TokenPersister

Returns:

persistTokens

public void persistTokens(Token[] retiredTokens)
                   throws TrustException

Description copied from interface: TokenPersister

Persist an array of tokens

Specified by:

persistTokens in interface TokenPersister

Parameters:

retiredTokens - array of security tokens

Throws:

TrustException

persistToken

public void persistToken(Token token)
                  throws TrustException

Description copied from interface: TokenPersister

Persist a single token

Specified by:

persistToken in interface TokenPersister

Throws:

TrustException

retrieveTokens

public Token[] retrieveTokens()

Description copied from interface: TokenPersister

Read all the persisted tokens.

Specified by:

retrieveTokens in interface TokenPersister

Returns:

stored tokens as an array of tokens

retrieveToken

public Token retrieveToken(String tokenId)
                    throws TrustException

Description copied from interface: TokenPersister

Read a token given it's id.

Specified by:

retrieveToken in interface TokenPersister

Returns:

Throws:

TrustException

retrieveTokenIDs

public String[] retrieveTokenIDs()

Description copied from interface: TokenPersister

Obtain the list of token IDs in persistence.

Specified by:

retrieveTokenIDs in interface TokenPersister

Returns:

string array of token ids if exist, else null

updateToken

public void updateToken(Token token)
                 throws TrustException

Description copied from interface: TokenPersister

Update the given token in persistence.

Specified by:

updateToken in interface TokenPersister

Throws:

TrustException

deleteToken

public void deleteToken(String tokenId)
                 throws TrustException

Description copied from interface: TokenPersister

Remove the token, given the token id.

Specified by:

deleteToken in interface TokenPersister

Throws:

TrustException

setConfiguration

public void setConfiguration(AbstractIssuerConfig config)
                      throws TrustException

Description copied from interface: TokenPersister

Pass persister configuration to be set in the persister implementation.

Specified by:

setConfiguration in interface TokenPersister

Throws:

TrustException

setMessageContext

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

Description copied from interface: TokenPersister

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

Specified by:

setMessageContext in interface TokenPersister

notifyPersistence

public void notifyPersistence()

Description copied from interface: TokenPersister

Notify the persister when persistence needs to happen.

Specified by:

notifyPersistence in interface TokenPersister

getRetiredTokens

public List<String> getRetiredTokens(List<Token> inMemoryTokens)

Obtain the list of tokens that are to be persisted. TODO:this is made public to be used in tests. Should make this protected or private

Parameters:

inMemoryTokens - list of tokens currently resides in memory.

Returns:

List of tokens to be sent to persistence.

run

public void run()

When an object implementing interface Runnable is used to create a thread, starting the thread causes the object's run method to be called in that separately executing thread.

The general contract of the method run is that it may take any action whatsoever.

Specified by:

run in interface Runnable

See Also:

Thread.run()