クラス AbstractLoggingInterceptor
java.lang.ObjectSE
org.springframework.xml.transform.TransformerObjectSupport
org.springframework.ws.server.endpoint.AbstractLoggingInterceptor
- 実装されたすべてのインターフェース:
EndpointInterceptor
public abstract class AbstractLoggingInterceptor
extends TransformerObjectSupport
implements EndpointInterceptor
WebServiceMessage
の一部をログに記録する EndpointInterceptor
インスタンスの抽象基本クラス。デフォルトでは、リクエストメッセージとレスポンスメッセージの両方がログに記録されますが、この動作は logRequest
プロパティと logResponse
プロパティを使用して変更できます。- 導入:
- 1.0.0
- 作成者:
- Arjen Poutsma
フィールドサマリー
修飾子と型フィールド説明protected org.apache.commons.logging.Log
トレースメッセージの書き込みに使用されるデフォルトのLog
インスタンス。コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明void
afterCompletion
(MessageContext messageContext, ObjectSE endpoint, ExceptionSE ex) デフォルトでは何もしませんprotected abstract SourceSE
getSource
(WebServiceMessage message) 指定されたWebServiceMessage
のSource
を返す抽象テンプレートメソッド。boolean
handleFault
(MessageContext messageContext, ObjectSE endpoint) デフォルトでは何もしません。boolean
handleRequest
(MessageContext messageContext, ObjectSE endpoint) リクエストメッセージのペイロードをログに記録します。boolean
handleResponse
(MessageContext messageContext, ObjectSE endpoint) レスポンスメッセージのペイロードをログに記録します。protected boolean
logger
フィールドが有効かどうかを確認します。protected void
logMessage
(StringSE message) 指定された文字列メッセージをログに記録します。protected void
logMessageSource
(StringSE logMessage, SourceSE source) void
setLoggerName
(StringSE loggerName) 使用するロガーの名前を設定します。final void
setLogRequest
(boolean logRequest) リクエストをログに記録する必要があるかどうかを示します。final void
setLogResponse
(boolean logResponse) レスポンスをログに記録する必要があるかどうかを示します。クラス org.springframework.xml.transform.TransformerObjectSupport から継承されたメソッド
createTransformer, getTransformerFactory, newTransformerFactory, setTransformerFactoryClass, transform
フィールドの詳細
logger
protected transient org.apache.commons.logging.Log loggerトレースメッセージの書き込みに使用されるデフォルトのLog
インスタンス。このインスタンスは、実装するClass
にマップされます。
コンストラクターの詳細
AbstractLoggingInterceptor
public AbstractLoggingInterceptor()
メソッドの詳細
setLogRequest
public final void setLogRequest(boolean logRequest) リクエストをログに記録する必要があるかどうかを示します。デフォルトはtrue
です。setLogResponse
public final void setLogResponse(boolean logResponse) レスポンスをログに記録する必要があるかどうかを示します。デフォルトはtrue
です。setLoggerName
使用するロガーの名前を設定します。名前は Commons Logging を介して基盤となるロガー実装に渡され、ロガーの構成に従ってログカテゴリとして解釈されます。これは、クラスのカテゴリにログインするのではなく、特定の名前付きカテゴリにログインするように指定できます。
- 関連事項:
LogFactory.getLog(String)
org.apache.log4j.Logger#getLogger(String)
Logger.getLogger(String)
SE
handleRequest
public boolean handleRequest(MessageContext messageContext, ObjectSE endpoint) throws TransformerExceptionSE リクエストメッセージのペイロードをログに記録します。ロギングは、logRequest
がデフォルトであるtrue
に設定されている場合にのみ発生します。- 次で指定:
- インターフェース
EndpointInterceptor
のhandleRequest
- パラメーター:
messageContext
- メッセージコンテキストendpoint
- 呼び出すエンドポイントを選択- 戻り値:
true
- 例外:
TransformerExceptionSE
- ペイロードを文字列に変換できない場合- 関連事項:
handleResponse
レスポンスメッセージのペイロードをログに記録します。ロギングは、logResponse
がデフォルトであるtrue
に設定されている場合にのみ発生します。- 次で指定:
- インターフェース
EndpointInterceptor
のhandleResponse
- パラメーター:
messageContext
- メッセージコンテキストendpoint
- 呼び出すエンドポイントを選択- 戻り値:
true
- 例外:
TransformerExceptionSE
- ペイロードを文字列に変換できない場合ExceptionSE
- エラーの場合- 関連事項:
handleFault
デフォルトでは何もしません。障害はログに記録されません。- 次で指定:
- インターフェース
EndpointInterceptor
のhandleFault
- パラメーター:
messageContext
- リクエストメッセージとレスポンスメッセージの両方が含まれている場合、レスポンスには障害が含まれている必要がありますendpoint
- 呼び出すエンドポイントを選択- 戻り値:
true
は、レスポンスインターセプターチェーンの処理を続行します。false
は、レスポンスハンドラーチェーンのブロックを示します。- 例外:
ExceptionSE
afterCompletion
デフォルトでは何もしません- 次で指定:
- インターフェース
EndpointInterceptor
のafterCompletion
- パラメーター:
messageContext
- リクエストメッセージとレスポンスメッセージの両方が含まれている場合、レスポンスには障害が含まれている必要がありますendpoint
- 呼び出すエンドポイントを選択ex
- ハンドラーの実行時にスローされる例外(ある場合)
isLogEnabled
protected boolean isLogEnabled()logger
フィールドが有効かどうかを確認します。「デバッグ」レベルが有効になっている場合、デフォルトは
true
です。サブクラスはこれをオーバーライドして、ロギングが発生するレベルを変更できます。logMessageSource
メッセージをプレフィックスとして使用して、指定されたsource
SE をlogger
にログに記録します。デフォルトでは、このメッセージは指定されたソースの文字列表現を作成し、
logMessage(String)
に委譲します。- パラメーター:
logMessage
- ログメッセージsource
- ログに記録されるソース- 例外:
TransformerExceptionSE
- エラーの場合
logMessage
指定された文字列メッセージをログに記録します。デフォルトでは、このメソッドは「デバッグ」レベルのログを使用します。サブクラスはこのメソッドをオーバーライドして、ロガーが使用するロギングのレベルを変更できます。
- パラメーター:
message
- メッセージ
getSource
指定されたWebServiceMessage
のSource
を返す抽象テンプレートメソッド。- パラメーター:
message
- メッセージ- 戻り値:
- メッセージのソース