パッケージ org.terasoluna.gfw.web.token.transaction

クラス HttpSessionTransactionTokenStore

java.lang.Object

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

すべての実装されたインタフェース:

TransactionTokenStore

public class HttpSessionTransactionTokenStore
extends Object
implements TransactionTokenStore

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

フィールドの概要

フィールド

修飾子とタイプ	フィールド	説明
static final int	DEFAULT_RETRY_CREATE_TOKEN_NAME	default retry count to generate token
static final int	NO_OF_TOKENS_PER_TOKEN_NAME	default token size per token name
static final String	TOKEN_HOLDER_SESSION_ATTRIBUTE_PREFIX	attribute name of token holder in the session scope

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
HttpSessionTransactionTokenStore()	Default constructor
HttpSessionTransactionTokenStore(int transactionTokenSizePerTokenName)	Constructor.
HttpSessionTransactionTokenStore(int transactionTokenSizePerTokenName, int retryCreateTokenName)	Constructor.
HttpSessionTransactionTokenStore(TokenStringGenerator generator, int transactionTokenSizePerTokenName, int retryCreateTokenName)	Constructor.

メソッドの概要

修飾子とタイプ	メソッド	説明
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

クラスから継承されたメソッド java.lang.Object

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

フィールド詳細

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

関連項目:

• 定数フィールド値

DEFAULT_RETRY_CREATE_TOKEN_NAME

public static final int DEFAULT_RETRY_CREATE_TOKEN_NAME

default retry count to generate token

関連項目:

• 定数フィールド値

コンストラクタの詳細

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.

パラメータ:

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

例外:

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

パラメータ:

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)

例外:

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

パラメータ:

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)

例外:

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

メソッドの詳細

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.

定義:

getAndClear インタフェース内 TransactionTokenStore

パラメータ:

token - TransactionToken instance (must not be null)

戻り値:

token string corresponding

例外:

IllegalArgumentException - generator is null

関連項目:

• 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

定義:

remove インタフェース内 TransactionTokenStore

パラメータ:

token - TransactionToken instance (must not be null)

関連項目:

• 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.

定義:

createAndReserveTokenKey インタフェース内 TransactionTokenStore

パラメータ:

tokenName - token name (namespace)

戻り値:

key created key

関連項目:

• 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_.

定義:

store インタフェース内 TransactionTokenStore

パラメータ:

token - TransactionToken instance (must not be null)

関連項目:

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