CommonsRequestLoggingFilter (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.filter.GenericFilterBean
- - org.springframework.web.filter.OncePerRequestFilter
  - - org.springframework.web.filter.AbstractRequestLoggingFilter
    - - org.springframework.web.filter.CommonsRequestLoggingFilter

実装されたすべてのインターフェース:
FilterEE, Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, EnvironmentCapable, ServletContextAware
```
public class CommonsRequestLoggingFilter
extends AbstractRequestLoggingFilter
```
リクエスト URI（およびオプションでクエリ文字列）を Commons Log に書き込むシンプルなリクエストロギングフィルター。
導入:
1.2.5
作成者:
Rob Harrop, Juergen Hoeller
関連事項:
AbstractRequestLoggingFilter.setIncludeQueryString(boolean), AbstractRequestLoggingFilter.setBeforeMessagePrefix(java.lang.String), AbstractRequestLoggingFilter.setBeforeMessageSuffix(java.lang.String), AbstractRequestLoggingFilter.setAfterMessagePrefix(java.lang.String), AbstractRequestLoggingFilter.setAfterMessageSuffix(java.lang.String), Log.debug(Object)

フィールドサマリー
- クラス org.springframework.web.filter.AbstractRequestLoggingFilter から継承されたフィールド
  DEFAULT_AFTER_MESSAGE_PREFIX, DEFAULT_AFTER_MESSAGE_SUFFIX, DEFAULT_BEFORE_MESSAGE_PREFIX, DEFAULT_BEFORE_MESSAGE_SUFFIX
- クラス org.springframework.web.filter.OncePerRequestFilter から継承されたフィールド
  ALREADY_FILTERED_SUFFIX
- クラス org.springframework.web.filter.GenericFilterBean から継承されたフィールド
  logger

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
CommonsRequestLoggingFilter()

コンストラクター
コンストラクターと説明
`CommonsRequestLoggingFilter()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`afterRequest(HttpServletRequestEE request, StringSE message)` リクエストの処理後にログメッセージを書き込みます。
`protected void`	`beforeRequest(HttpServletRequestEE request, StringSE message)` リクエストが処理される前にログメッセージを書き込みます。
`protected boolean`	`shouldLog(HttpServletRequestEE request)` 現在のリクエストに対して `AbstractRequestLoggingFilter.beforeRequest(javax.servlet.http.HttpServletRequest, java.lang.String)`/`AbstractRequestLoggingFilter.afterRequest(javax.servlet.http.HttpServletRequest, java.lang.String)` メソッドを呼び出すかどうかを決定します。

クラス org.springframework.web.filter.AbstractRequestLoggingFilter から継承されたメソッド
createMessage, doFilterInternal, getHeaderPredicate, getMaxPayloadLength, getMessagePayload, isIncludeClientInfo, isIncludeHeaders, isIncludePayload, isIncludeQueryString, setAfterMessagePrefix, setAfterMessageSuffix, setBeforeMessagePrefix, setBeforeMessageSuffix, setHeaderPredicate, setIncludeClientInfo, setIncludeHeaders, setIncludePayload, setIncludeQueryString, setMaxPayloadLength, shouldNotFilterAsyncDispatch

クラス org.springframework.web.filter.OncePerRequestFilter から継承されたメソッド
doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterErrorDispatch

クラス org.springframework.web.filter.GenericFilterBean から継承されたメソッド
addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - CommonsRequestLoggingFilter
```
public CommonsRequestLoggingFilter()
```
- メソッドの詳細
  - shouldLog
```
protected boolean shouldLog(HttpServletRequestEE request)
```
    クラスからコピーされた説明: AbstractRequestLoggingFilter
    現在のリクエストに対して AbstractRequestLoggingFilter.beforeRequest(javax.servlet.http.HttpServletRequest, java.lang.String)/AbstractRequestLoggingFilter.afterRequest(javax.servlet.http.HttpServletRequest, java.lang.String) メソッドを呼び出すかどうか、つまり、ロギングが現在アクティブになっているかどうか（およびログメッセージを作成する価値があるかどうか）を決定します。
    デフォルトの実装は、常に true を返します。サブクラスは、ログレベルチェックでこれをオーバーライドできます。
    オーバーライド:
    クラス AbstractRequestLoggingFilter の shouldLog
    パラメーター:
    request - 現在の HTTP リクエスト
    戻り値:
    before/after メソッドが呼び出される場合は true。それ以外の場合は false
  - beforeRequest
```
protected void beforeRequest(HttpServletRequestEE request,
                             StringSE message)
```
    リクエストが処理される前にログメッセージを書き込みます。
    次で指定:
    クラス AbstractRequestLoggingFilter の beforeRequest
    パラメーター:
    request - 現在の HTTP リクエスト
    message - 記録するメッセージ
  - afterRequest
```
protected void afterRequest(HttpServletRequestEE request,
                            StringSE message)
```
    リクエストの処理後にログメッセージを書き込みます。
    次で指定:
    クラス AbstractRequestLoggingFilter の afterRequest
    パラメーター:
    request - 現在の HTTP リクエスト
    message - 記録するメッセージ

クラス CommonsRequestLoggingFilter

フィールドサマリー

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

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

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

コンストラクターのサマリー

メソッドのサマリー

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

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

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

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

コンストラクターの詳細

CommonsRequestLoggingFilter

メソッドの詳細

shouldLog

beforeRequest

afterRequest