クラス AbstractLoggingInterceptor

java.lang.ObjectSE
org.springframework.xml.transform.TransformerObjectSupport
org.springframework.ws.server.endpoint.AbstractLoggingInterceptor
実装されたすべてのインターフェース:
EndpointInterceptor
既知の直属サブクラス
PayloadLoggingInterceptorSoapEnvelopeLoggingInterceptor

public abstract class AbstractLoggingInterceptor extends TransformerObjectSupport implements EndpointInterceptor
WebServiceMessage の一部をログに記録する EndpointInterceptor インスタンスの抽象基本クラス。デフォルトでは、リクエストメッセージとレスポンスメッセージの両方がログに記録されますが、この動作は logRequest プロパティと logResponse プロパティを使用して変更できます。
導入:
1.0.0
作成者:
Arjen Poutsma
  • フィールドの詳細

    • 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

      public void setLoggerName(StringSE loggerName)
      使用するロガーの名前を設定します。名前は Commons Logging を介して基盤となるロガー実装に渡され、ロガーの構成に従ってログカテゴリとして解釈されます。

      これは、クラスのカテゴリにログインするのではなく、特定の名前付きカテゴリにログインするように指定できます。

      関連事項:
    • handleRequest

      public boolean handleRequest(MessageContext messageContext, ObjectSE endpoint) throws TransformerExceptionSE
      リクエストメッセージのペイロードをログに記録します。ロギングは、logRequest がデフォルトである true に設定されている場合にのみ発生します。
      次で指定:
      インターフェース EndpointInterceptorhandleRequest 
      パラメーター:
      messageContext - メッセージコンテキスト
      endpoint - 呼び出すエンドポイントを選択
      戻り値:
      true
      例外:
      TransformerExceptionSE - ペイロードを文字列に変換できない場合
      関連事項:
    • handleResponse

      public boolean handleResponse(MessageContext messageContext, ObjectSE endpoint) throws ExceptionSE
      レスポンスメッセージのペイロードをログに記録します。ロギングは、logResponse がデフォルトである true に設定されている場合にのみ発生します。
      次で指定:
      インターフェース EndpointInterceptorhandleResponse 
      パラメーター:
      messageContext - メッセージコンテキスト
      endpoint - 呼び出すエンドポイントを選択
      戻り値:
      true
      例外:
      TransformerExceptionSE - ペイロードを文字列に変換できない場合
      ExceptionSE - エラーの場合
      関連事項:
    • handleFault

      public boolean handleFault(MessageContext messageContext, ObjectSE endpoint) throws ExceptionSE
      デフォルトでは何もしません。障害はログに記録されません。
      次で指定:
      インターフェース EndpointInterceptorhandleFault 
      パラメーター:
      messageContext - リクエストメッセージとレスポンスメッセージの両方が含まれている場合、レスポンスには障害が含まれている必要があります
      endpoint - 呼び出すエンドポイントを選択
      戻り値:
      true は、レスポンスインターセプターチェーンの処理を続行します。false は、レスポンスハンドラーチェーンのブロックを示します。
      例外:
      ExceptionSE
    • afterCompletion

      public void afterCompletion(MessageContext messageContext, ObjectSE endpoint, ExceptionSE ex)
      デフォルトでは何もしません
      次で指定:
      インターフェース EndpointInterceptorafterCompletion 
      パラメーター:
      messageContext - リクエストメッセージとレスポンスメッセージの両方が含まれている場合、レスポンスには障害が含まれている必要があります
      endpoint - 呼び出すエンドポイントを選択
      ex - ハンドラーの実行時にスローされる例外(ある場合)
    • isLogEnabled

      protected boolean isLogEnabled()
      logger フィールドが有効かどうかを確認します。

      「デバッグ」レベルが有効になっている場合、デフォルトは true です。サブクラスはこれをオーバーライドして、ロギングが発生するレベルを変更できます。

    • logMessageSource

      protected void logMessageSource(StringSE logMessage, SourceSE source) throws TransformerExceptionSE
      メッセージをプレフィックスとして使用して、指定された sourceSElogger にログに記録します。

      デフォルトでは、このメッセージは指定されたソースの文字列表現を作成し、logMessage(String) に委譲します。

      パラメーター:
      logMessage - ログメッセージ
      source - ログに記録されるソース
      例外:
      TransformerExceptionSE - エラーの場合
    • logMessage

      protected void logMessage(StringSE message)
      指定された文字列メッセージをログに記録します。

      デフォルトでは、このメソッドは「デバッグ」レベルのログを使用します。サブクラスはこのメソッドをオーバーライドして、ロガーが使用するロギングのレベルを変更できます。

      パラメーター:
      message - メッセージ
    • getSource

      protected abstract SourceSE getSource(WebServiceMessage message)
      指定された WebServiceMessage の Source を返す抽象テンプレートメソッド。
      パラメーター:
      message - メッセージ
      戻り値:
      メッセージのソース