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

クラス TransactionTokenInterceptor

java.lang.Object

org.terasoluna.gfw.web.token.transaction.TransactionTokenInterceptor

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

org.springframework.web.servlet.HandlerInterceptor

public class TransactionTokenInterceptor
extends Object
implements org.springframework.web.servlet.HandlerInterceptor

HandlerInterceptor implementation class that introduces TransactionTokenCheck functionality for each incoming HTTP Request.

フィールドの概要

フィールド

修飾子とタイプ	フィールド	説明
static final String	NEXT_TOKEN_REQUEST_ATTRIBUTE_NAME	attribute name of next TransactionToken in the request scope
static final String	TOKEN_CONTEXT_REQUEST_ATTRIBUTE_NAME	attribute name of TransactionTokenContext in the request scope
static final String	TOKEN_REQUEST_PARAMETER	request parameter of token value to check

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
TransactionTokenInterceptor()	Constructor that takes sizePerTokenName.
TransactionTokenInterceptor(int sizePerTokenName)	Constructor that takes sizePerTokenName.
TransactionTokenInterceptor(TokenStringGenerator generator, TransactionTokenInfoStore tokenInfoStore, TransactionTokenStore tokenStore)	Constructor that takes tokenStringGenerator, transactionTokenInfoStore and transactionTokenStore as parameters

メソッドの概要

修飾子とタイプ	メソッド	説明
void	afterCompletion(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, Exception ex)	If exception occurred during request processing, the token is removed from request as well as TransactionTokenStore
void	postHandle(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, org.springframework.web.servlet.ModelAndView modelAndView)	Based on context information from the request attribute named TransactionTokenInterceptor.TOKEN_CONTEXT, creates, updates or keeps the token stored with the request attribute TransactionTokenInterceptor.NEXT_TOKEN and also in the TransactionTokenStore or removes the token from TransactionTokenStore
boolean	preHandle(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler)	Validates the token received from request.
protected void	processTransactionTokenError(TransactionToken receivedToken)

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

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

フィールド詳細

TOKEN_CONTEXT_REQUEST_ATTRIBUTE_NAME

public static final String TOKEN_CONTEXT_REQUEST_ATTRIBUTE_NAME

attribute name of TransactionTokenContext in the request scope

NEXT_TOKEN_REQUEST_ATTRIBUTE_NAME

public static final String NEXT_TOKEN_REQUEST_ATTRIBUTE_NAME

attribute name of next TransactionToken in the request scope

TOKEN_REQUEST_PARAMETER

public static final String TOKEN_REQUEST_PARAMETER

request parameter of token value to check

関連項目:

• 定数フィールド値

コンストラクタの詳細

TransactionTokenInterceptor

public TransactionTokenInterceptor()

Constructor that takes sizePerTokenName.

sizePerTokenName is the number of tokenKeys that are allowed to be generated per tokenName.
TokenStringGenerator is used to generate token string.
TransactionTokenInfoStore is used to store TransactionTokenInfo.
HttpSessionTransactionTokenStore is used to store transaction tokens. Default size per tokenName(namespace) is used.

関連項目:

• HttpSessionTransactionTokenStore()

TransactionTokenInterceptor

public TransactionTokenInterceptor(int sizePerTokenName)

Constructor that takes sizePerTokenName.

sizePerTokenName is the number of tokenKeys that are allowed to be generated per tokenName.
TokenStringGenerator is used to generate token string.
TransactionTokenInfoStore is used to store TransactionTokenInfo.
HttpSessionTransactionTokenStore is used to store transaction tokens. The size per tokenName(namespace) is given.

パラメータ:

sizePerTokenName - size per tokenName(must be greater than 0)

関連項目:

• HttpSessionTransactionTokenStore(int)

TransactionTokenInterceptor

public TransactionTokenInterceptor(TokenStringGenerator generator,
 TransactionTokenInfoStore tokenInfoStore,
 TransactionTokenStore tokenStore)

Constructor that takes tokenStringGenerator, transactionTokenInfoStore and transactionTokenStore as parameters

パラメータ:

generator - token string generator

tokenInfoStore - store for TransactionTokenInfo

tokenStore - store for TransactionToken

メソッドの詳細

preHandle

public boolean preHandle(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Object handler)

Validates the token received from request.

If token check passes, sets context information of the token in the "TransactionTokenInterceptor.TOKEN_CONTEXT" request attribute and returns true.

This method expects the handler argument to be an instance of HandlerMethod class. If the handler is not an instance of HandlerMethod class, the method returns true without executing the validation.

定義:

preHandle インタフェース内 org.springframework.web.servlet.HandlerInterceptor

例外:

InvalidTransactionTokenException - in case of Transaction Token Validation error.

関連項目:

• HandlerInterceptor.preHandle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object)

processTransactionTokenError

protected void processTransactionTokenError(TransactionToken receivedToken)

postHandle

public void postHandle(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Object handler,
 org.springframework.web.servlet.ModelAndView modelAndView)

Based on context information from the request attribute named TransactionTokenInterceptor.TOKEN_CONTEXT, creates, updates or keeps the token stored with the request attribute TransactionTokenInterceptor.NEXT_TOKEN and also in the TransactionTokenStore or removes the token from TransactionTokenStore

modelAndView is not used in the implementation

定義:

postHandle インタフェース内 org.springframework.web.servlet.HandlerInterceptor

パラメータ:

request - current HTTP request

response - current HTTP response

handler - chosen handler to execute, for type and/or instance examination

modelAndView - the ModelAndView that the handler returned (can also be null)

関連項目:

• HandlerInterceptor.postHandle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, org.springframework.web.servlet.ModelAndView)

afterCompletion

public void afterCompletion(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Object handler,
 Exception ex)

If exception occurred during request processing, the token is removed from request as well as TransactionTokenStore

Token Context is fetched from the request attribute named TransactionTokenInterceptor.TOKEN_CONTEXT Arguments response and handler are not used in this implementation

定義:

afterCompletion インタフェース内 org.springframework.web.servlet.HandlerInterceptor

関連項目:

• HandlerInterceptor.afterCompletion(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, java.lang.Exception)