org.terasoluna.gfw.web.token.transaction

Class HttpSessionTransactionTokenStore

java.lang.Object

org.terasoluna.gfw.web.token.transaction.HttpSessionTransactionTokenStore

All Implemented Interfaces:

TransactionTokenStore

public class HttpSessionTransactionTokenStore
extends Object
implements TransactionTokenStore

Implementation of TransactionTokenStore interface which uses HTTP session to store the token

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RETRY_CREATE_TOKEN_NAME default retry count to generate token
static int	NO_OF_TOKENS_PER_TOKEN_NAME default token size per token name
static String	TOKEN_HOLDER_SESSION_ATTRIBUTE_PREFIX attribute name of token holder in the session scope

Constructor Summary

Constructors

Constructor and Description
HttpSessionTransactionTokenStore() Default constructor
HttpSessionTransactionTokenStore(int transactionTokenSizePerTokenName) Constructor.
HttpSessionTransactionTokenStore(int transactionTokenSizePerTokenName, int retryCreateTokenName) Constructor.
HttpSessionTransactionTokenStore(TokenStringGenerator generator, int transactionTokenSizePerTokenName, int retryCreateTokenName) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	createAndReserveTokenKey(String tokenName) Creates a new Token key and reserve it in the HttpSession removes oldeset token if token size is greater than or equals transactionTokensPerTokenName in the same namespace.
String	getAndClear(TransactionToken token) Fetches the value stored in session corresponding to the TransactionToken received as argument to this method.
void	remove(TransactionToken token) Removes the session attribute corresponding to the transactionToken instance passed as argument to this method
void	store(TransactionToken token) Stores the token represented by TransactionToken into HTTP session

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_HOLDER_SESSION_ATTRIBUTE_PREFIX

public static final String TOKEN_HOLDER_SESSION_ATTRIBUTE_PREFIX

attribute name of token holder in the session scope

NO_OF_TOKENS_PER_TOKEN_NAME

public static final int NO_OF_TOKENS_PER_TOKEN_NAME

default token size per token name

See Also:

Constant Field Values

DEFAULT_RETRY_CREATE_TOKEN_NAME

public static final int DEFAULT_RETRY_CREATE_TOKEN_NAME

default retry count to generate token

See Also:

Constant Field Values

Constructor Detail

HttpSessionTransactionTokenStore

public HttpSessionTransactionTokenStore()

Default constructor

By default, number of tokenKeys per tokenName is set to 10. And number of retries to create a tokenName is set to 10.

HttpSessionTransactionTokenStore

public HttpSessionTransactionTokenStore(int transactionTokenSizePerTokenName)

Constructor. Takes transactionTokensPerTokenName as an argument

transactionTokensPerTokenName indicates the number of transactionTokens that can be stored in the session for each
tokenName at a time.

Parameters:

transactionTokenSizePerTokenName - Allowed number of tokens for each tokenName(must be greater than 0)

Throws:

IllegalArgumentException - sizePerTokenName is (less than or equals 0)

HttpSessionTransactionTokenStore

public HttpSessionTransactionTokenStore(int transactionTokenSizePerTokenName,
                                int retryCreateTokenName)

Constructor. Takes transactionTokensPerTokenName and retryCreateTokenName as an argument

transactionTokensPerTokenName indicates the number of transactionTokens that can be stored in the session for each
tokenName at a time.

retryCreateTokenName indicates the number of times retrys are done to create a token name

Parameters:

transactionTokenSizePerTokenName - Allowed number of tokens for each tokenName(must be greater than 0)

retryCreateTokenName - Number of retries for creating tokenName(must be greater than 0)

Throws:

IllegalArgumentException - sizePerTokenName is (less than or equals 0) or retryCreateTokenName is (less than or equals 0)

HttpSessionTransactionTokenStore

public HttpSessionTransactionTokenStore(TokenStringGenerator generator,
                                int transactionTokenSizePerTokenName,
                                int retryCreateTokenName)

Constructor. Enables customization of the token store

Parameters:

generator - TokenStringGenerator instance (must not be null)

transactionTokenSizePerTokenName - Allowed number of tokens for each tokenName(must be greater than 0)

retryCreateTokenName - Number of retries for creating tokenName(must be greater than 0)

Throws:

IllegalArgumentException - generator is null or sizePerTokenName is (less than or equals 0) or retryCreateTokenName is (less than or equals 0)

Method Detail

getAndClear

public String getAndClear(TransactionToken token)

Fetches the value stored in session corresponding to the TransactionToken received as argument to this method.

This value corresponding to the same transactionToken instance can be fetched only once. Once the value is fetched, its value is cleared from the session. For all further invocations to this method for the same transactionToken instance, null will be returned.

Specified by:

getAndClear in interface TransactionTokenStore

Parameters:

token - TransactionToken instance (must not be null)

Returns:

token string corresponding

Throws:

IllegalArgumentException - generator is null

See Also:

TransactionTokenStore.getAndClear(org.terasoluna.gfw.web.token.transaction.TransactionToken)

remove

public void remove(TransactionToken token)

Removes the session attribute corresponding to the transactionToken instance passed as argument to this method

Specified by:

remove in interface TransactionTokenStore

Parameters:

token - TransactionToken instance (must not be null)

See Also:

TransactionTokenStore.remove(org.terasoluna.gfw.web.token.transaction.TransactionToken)

createAndReserveTokenKey

public String createAndReserveTokenKey(String tokenName)

Creates a new Token key and reserve it in the HttpSession
removes oldeset token if token size is greater than or equals transactionTokensPerTokenName in the same namespace.

Specified by:

createAndReserveTokenKey in interface TransactionTokenStore

Parameters:

tokenName - token name (namespace)

Returns:

key created key

See Also:

TransactionTokenStore.createAndReserveTokenKey(java.lang.String)

store

public void store(TransactionToken token)

Stores the token represented by TransactionToken into HTTP session

The session attribute name to store it is prefixed with HttpSessionTransactionTokenStore_TOKEN_.

Specified by:

store in interface TransactionTokenStore

Parameters:

token - TransactionToken instance (must not be null)

See Also:

TransactionTokenStore.store(org.terasoluna.gfw.web.token.transaction.TransactionToken)