パッケージ org.terasoluna.gfw.web.logging.mdc

クラス XTrackMDCPutFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.terasoluna.gfw.web.logging.mdc.AbstractMDCPutFilter

org.terasoluna.gfw.web.logging.mdc.XTrackMDCPutFilter

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

jakarta.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

public class XTrackMDCPutFilter
extends AbstractMDCPutFilter

Set random value per request to MDC and HTTP Response Header and HTTP Request Attribute (request scope).

default attribute name is "X-Track". You can change this name by configure. The value of X-Track is retrieved from HTTP Request Header (same attribute name).
If the attibute is not set in HTTP Request Header, this filter creates random value as X-Track and use it.

 
 <init-param>
     <param-name>attributeName</param-name>
     <param-value>XXXX</param-value>
 </init-param>
 
 

in web.xml

フィールドの概要

クラスから継承されたフィールド org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

クラスから継承されたフィールド org.springframework.web.filter.GenericFilterBean

logger

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
XTrackMDCPutFilter()

メソッドの概要

修飾子とタイプ	メソッド	説明
protected String	createXTrack()	Create track ID (X-Track)
protected String	getMDCKey(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	get attribute name to set MDC and HTTP Response Header.
protected String	getMDCValue(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	return track ID (X-Track) and set it HTTP Response Header and HTTP Request Attribute (request scope). If track ID is set in HTTP Request Header, then use it.
void	setAttributeName(String attributeName)	set attribute name to set MDC and HTTP Response Header

クラスから継承されたメソッド org.terasoluna.gfw.web.logging.mdc.AbstractMDCPutFilter

cutValue, doFilterInternal, setMaxMDCValueLength, setRemoveValue

クラスから継承されたメソッド org.springframework.web.filter.OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

クラスから継承されたメソッド org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

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

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

コンストラクタの詳細

XTrackMDCPutFilter

public XTrackMDCPutFilter()

メソッドの詳細

setAttributeName

public void setAttributeName(String attributeName)

set attribute name to set MDC and HTTP Response Header

パラメータ:

attributeName - attribute name

getMDCKey

protected String getMDCKey(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

get attribute name to set MDC and HTTP Response Header. (default: X-Track)

定義:

getMDCKey クラス内 AbstractMDCPutFilter

パラメータ:

request - HttpServletRequest

response - HttpServletResponse

戻り値:

Key to store the value in MDC

関連項目:

• AbstractMDCPutFilter.getMDCKey(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

createXTrack

protected String createXTrack()

Create track ID (X-Track)

returns 32-length random HEX string.

戻り値:

X-Track

getMDCValue

protected String getMDCValue(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

return track ID (X-Track) and set it HTTP Response Header and HTTP Request Attribute (request scope).
If track ID is set in HTTP Request Header, then use it. Unless track ID is created by createXTrack().

定義:

getMDCValue クラス内 AbstractMDCPutFilter

パラメータ:

request - HttpServletRequest

response - HttpServletResponse

戻り値:

Value to be stored in MDC

関連項目:

• AbstractMDCPutFilter.getMDCValue(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)