パッケージ org.springframework.ws.client.support.interceptor

インターフェース ClientInterceptor

すべての既知の実装クラス:
AbstractValidatingInterceptor、AbstractWsSecurityInterceptor、ClientInterceptorAdapter、PayloadValidatingInterceptor、Wss4jSecurityInterceptor
public interface ClientInterceptor
カスタマイズされたクライアント側メッセージインターセプトを可能にするワークフローインターフェース。アプリケーションは WebServiceTemplate に任意の数の既存またはカスタムインターセプターを登録して、ペイロード処理コードを変更することなく、共通の前処理および後処理動作を追加できます。

ClientInterceptor は、ペイロードの作成後 (WebServiceTemplate.marshalSendAndReceive(Object) または同様のメソッドを使用して、callback の呼び出し後、ただし WebServiceConnection を介してメッセージが送信される前に) 呼び出されます。このメカニズムは、認可チェックやメッセージヘッダーなど、前処理の大きなフィールドに使用できます。その主な目的は、メタデータ (つまり SoapHeader ) 関連のコードを除外できるようにすることです。

クライアントインターセプターは、interceptors プロパティを使用して WebServiceTemplate で定義されます。

導入:
1.5.0
作成者:
Giovanni Cuccu, Arjen Poutsma
関連事項:

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    afterCompletion(MessageContext messageContext, ExceptionSE ex)
    リクエストとレスポンス (障害) 処理完了後のコールバック。
    boolean
    handleFault(MessageContext messageContext)
    受信レスポンス障害を処理します。
    boolean
    handleRequest(MessageContext messageContext)
    発信リクエストメッセージを処理します。
    boolean
    handleResponse(MessageContext messageContext)
    受信レスポンスメッセージを処理します。

  • メソッドの詳細

    • handleRequest

      boolean handleRequest(MessageContext messageContext) throws WebServiceClientException
      発信リクエストメッセージを処理します。ペイロードの作成とコールバックの呼び出しの後で、メッセージが送信される前に呼び出されます。
      パラメーター:
      messageContext - 発信リクエストメッセージが含まれています
      戻り値:
      true は、リクエストインターセプターの処理を続行します。リクエストエンドポイントチェーンのブロックを示す false 
      例外:
      WebServiceClientException - エラーの場合
      関連事項:

    • handleResponse

      boolean handleResponse(MessageContext messageContext) throws WebServiceClientException
      受信レスポンスメッセージを処理します。WebServiceTemplate でのペイロード処理の前に、非障害レスポンスメッセージに対して呼び出されます。

      メモ: このインターセプターの handleRequest(org.springframework.ws.context.MessageContext) メソッドが正常に完了した場合にのみ呼び出されます。

      パラメーター:
      messageContext - 発信リクエストメッセージが含まれています
      戻り値:
      true は、リクエストインターセプターの処理を続行します。レスポンスエンドポイントチェーンのブロックを示す false 
      例外:
      WebServiceClientException - エラーの場合
      関連事項:

    • handleFault

      boolean handleFault(MessageContext messageContext) throws WebServiceClientException
      受信レスポンス障害を処理します。WebServiceTemplate でのペイロード処理の前に、レスポンス障害メッセージに対して呼び出されます。

      メモ: このインターセプターの handleRequest(org.springframework.ws.context.MessageContext) メソッドが正常に完了した場合にのみ呼び出されます。

      パラメーター:
      messageContext - 発信リクエストメッセージが含まれています
      戻り値:
      true は、リクエストインターセプターの処理を続行します。リクエストエンドポイントチェーンのブロックを示す false 
      例外:
      WebServiceClientException - エラーの場合
      関連事項:

    • afterCompletion

      void afterCompletion(MessageContext messageContext, ExceptionSE ex) throws WebServiceClientException
      リクエストとレスポンス (障害) 処理完了後のコールバック。どの結果でも呼び出されるため、適切なリソースのクリーンアップが可能になります。

      メモ: このインターセプターの handleRequest(org.springframework.ws.context.MessageContext) メソッドが正常に完了した場合にのみ呼び出されます。

      パラメーター:
      messageContext - リクエストメッセージとレスポンスメッセージの両方が含まれている場合、レスポンスには障害が含まれている必要があります
      ex - ハンドラーの実行時にスローされる例外（ある場合）
      例外:
      WebServiceClientException - エラーの場合
      導入:
      2.2