クラス WebServiceTemplateBuilder

java.lang.ObjectSE
org.springframework.boot.webservices.client.WebServiceTemplateBuilder

public class WebServiceTemplateBuilder extends ObjectSE
WebServiceTemplate の構成および作成に使用できるビルダー。message sendersclient interceptorscustomizers を登録するための便利なメソッドを提供します。

デフォルトでは、ビルドされた WebServiceTemplate は最も適切な HTTP ベースの WebServiceMessageSender を使用します。デフォルトのままにする場合は、detectHttpMessageSender(false) を呼び出します。典型的な自動構成 Spring Boot アプリケーションでは、このビルダーは Bean として利用でき、WebServiceTemplate が必要なときにいつでも注入できます。

導入:
2.1.0
作成者:
Dmytro Nosan, Stephane Nicoll
  • コンストラクターの詳細

  • メソッドの詳細

    • detectHttpMessageSender

      public WebServiceTemplateBuilder detectHttpMessageSender(boolean detectHttpMessageSender)
      クラスパスに基づいて適切な HTTP ベースの WebServiceMessageSender を検出する必要がある場合に設定します。デフォルトは true です。
      パラメーター:
      detectHttpMessageSender - HTTP ベースの WebServiceMessageSender を検出する必要がある場合
      戻り値:
      新しいビルダーインスタンス
      関連事項:
    • messageSenders

      public WebServiceTemplateBuilder messageSenders(org.springframework.ws.transport.WebServiceMessageSender... messageSenders)
      WebServiceTemplate で使用する WebServiceMessageSenders を設定します。この値を設定すると、HTTP ベースのメッセージ送信者を含め、以前に定義されたメッセージ送信者があれば置き換えられます。additionalMessageSenders(WebServiceMessageSender...) を使用して、ユーザー定義のメッセージ送信者に保持することを検討してください。
      パラメーター:
      messageSenders - 設定するメッセージ送信者
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
    • messageSenders

      public WebServiceTemplateBuilder messageSenders(CollectionSE<? extends org.springframework.ws.transport.WebServiceMessageSender> messageSenders)
      WebServiceTemplate で使用する WebServiceMessageSenders を設定します。この値を設定すると、HTTP ベースのメッセージ送信者を含め、以前に定義されたメッセージ送信者があれば置き換えられます。additionalMessageSenders(Collection) を使用して、ユーザー定義のメッセージ送信者に保持することを検討してください。
      パラメーター:
      messageSenders - 設定するメッセージ送信者
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
    • additionalMessageSenders

      public WebServiceTemplateBuilder additionalMessageSenders(org.springframework.ws.transport.WebServiceMessageSender... messageSenders)
      WebServiceTemplate で使用する必要がある追加の WebServiceMessageSenders を追加します。
      パラメーター:
      messageSenders - 追加するメッセージ送信者
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
    • additionalMessageSenders

      public WebServiceTemplateBuilder additionalMessageSenders(CollectionSE<? extends org.springframework.ws.transport.WebServiceMessageSender> messageSenders)
      WebServiceTemplate で使用する必要がある追加の WebServiceMessageSenders を追加します。
      パラメーター:
      messageSenders - 追加するメッセージ送信者
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
    • interceptors

      public WebServiceTemplateBuilder interceptors(org.springframework.ws.client.support.interceptor.ClientInterceptor... interceptors)
      WebServiceTemplate で使用する ClientInterceptors を設定します。この値を設定すると、以前に定義されたインターセプターが置き換えられます。
      パラメーター:
      interceptors - 設定するインターセプター
      戻り値:
      新しいビルダーインスタンス
      関連事項:
    • interceptors

      public WebServiceTemplateBuilder interceptors(CollectionSE<? extends org.springframework.ws.client.support.interceptor.ClientInterceptor> interceptors)
      WebServiceTemplate で使用する ClientInterceptors を設定します。この値を設定すると、以前に定義されたインターセプターが置き換えられます。
      パラメーター:
      interceptors - 設定するインターセプター
      戻り値:
      新しいビルダーインスタンス
      関連事項:
    • additionalInterceptors

      public WebServiceTemplateBuilder additionalInterceptors(org.springframework.ws.client.support.interceptor.ClientInterceptor... interceptors)
      WebServiceTemplate で使用する必要がある追加の ClientInterceptors を追加します。
      パラメーター:
      interceptors - 追加するインターセプター
      戻り値:
      新しいビルダーインスタンス
      関連事項:
    • additionalInterceptors

      public WebServiceTemplateBuilder additionalInterceptors(CollectionSE<? extends org.springframework.ws.client.support.interceptor.ClientInterceptor> interceptors)
      WebServiceTemplate で使用する必要がある追加の ClientInterceptors を追加します。
      パラメーター:
      interceptors - 追加するインターセプター
      戻り値:
      新しいビルダーインスタンス
      関連事項:
    • customizers

      public WebServiceTemplateBuilder customizers(WebServiceTemplateCustomizer... customizers)
      WebServiceTemplate に適用する WebServiceTemplateCustomizers を設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザが置き換えられます。
      パラメーター:
      customizers - 設定するカスタマイザー
      戻り値:
      新しいビルダーインスタンス
      関連事項:
    • customizers

      public WebServiceTemplateBuilder customizers(CollectionSE<? extends WebServiceTemplateCustomizer> customizers)
      WebServiceTemplate に適用する WebServiceTemplateCustomizers を設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザが置き換えられます。
      パラメーター:
      customizers - 設定するカスタマイザー
      戻り値:
      新しいビルダーインスタンス
      関連事項:
    • additionalCustomizers

      public WebServiceTemplateBuilder additionalCustomizers(WebServiceTemplateCustomizer... customizers)
      WebServiceTemplate に適用する必要がある WebServiceTemplateCustomizers を追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。
      パラメーター:
      customizers - 追加するカスタマイザー
      戻り値:
      新しいビルダーインスタンス
      関連事項:
    • additionalCustomizers

      public WebServiceTemplateBuilder additionalCustomizers(CollectionSE<? extends WebServiceTemplateCustomizer> customizers)
      WebServiceTemplate に適用する必要がある WebServiceTemplateCustomizers を追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。
      パラメーター:
      customizers - 追加するカスタマイザー
      戻り値:
      新しいビルダーインスタンス
      関連事項:
    • setCheckConnectionForFault

      public WebServiceTemplateBuilder setCheckConnectionForFault(boolean checkConnectionForFault)
      接続の障害インジケーターをチェックする必要があるか(true)、またはメッセージのみに依存する必要があるか(false)を示します。
      パラメーター:
      checkConnectionForFault - 障害インジケータを確認するかどうか
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
      • WebServiceTemplate.setCheckConnectionForFault(boolean)
    • setCheckConnectionForError

      public WebServiceTemplateBuilder setCheckConnectionForError(boolean checkConnectionForError)
      接続のエラーインジケータをチェックする必要があるか(true)、またはこれらを無視する必要があるか(false)を示します。
      パラメーター:
      checkConnectionForError - エラーインジケーターをチェックするかどうか
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
      • WebServiceTemplate.setCheckConnectionForError(boolean)
    • setWebServiceMessageFactory

      public WebServiceTemplateBuilder setWebServiceMessageFactory(org.springframework.ws.WebServiceMessageFactory messageFactory)
      メッセージの作成に使用する WebServiceMessageFactory を設定します。
      パラメーター:
      messageFactory - メッセージの作成に使用するメッセージファクトリ
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
      • WebServiceAccessor.setMessageFactory(WebServiceMessageFactory)
    • setUnmarshaller

      public WebServiceTemplateBuilder setUnmarshaller(Unmarshaller unmarshaller)
      メッセージのデシリアライズに使用する Unmarshaller を設定します。
      パラメーター:
      unmarshaller - メッセージアンマーシャラー
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
      • WebServiceTemplate.setUnmarshaller(Unmarshaller)
    • setMarshaller

      public WebServiceTemplateBuilder setMarshaller(Marshaller marshaller)
      メッセージのシリアライズに使用する Marshaller を設定します。
      パラメーター:
      marshaller - メッセージマーシャラー
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
      • WebServiceTemplate.setMarshaller(Marshaller)
    • setFaultMessageResolver

      public WebServiceTemplateBuilder setFaultMessageResolver(org.springframework.ws.client.core.FaultMessageResolver faultMessageResolver)
      使用する FaultMessageResolver を設定します。
      パラメーター:
      faultMessageResolver - 使用する障害メッセージリゾルバー
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
      • WebServiceTemplate.setFaultMessageResolver(FaultMessageResolver)
    • setTransformerFactoryClass

      public WebServiceTemplateBuilder setTransformerFactoryClass(ClassSE<? extends TransformerFactorySE> transformerFactoryClass)
      使用する TransformerFactorySE 実装を設定します。
      パラメーター:
      transformerFactoryClass - 使用するトランスフォーマーファクトリの実装
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
      • TransformerObjectSupport.setTransformerFactoryClass(Class)
    • setDefaultUri

      public WebServiceTemplateBuilder setDefaultUri(StringSE defaultUri)
      URI パラメーターを持たない操作で使用されるデフォルトの URI を設定します。通常、このプロパティが設定されているか、setDestinationProvider(DestinationProvider) が設定されていますが、両方は設定されていません。
      パラメーター:
      defaultUri - URI パラメーターを持たない操作で使用される宛先プロバイダー URI。
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
    • setDestinationProvider

      public WebServiceTemplateBuilder setDestinationProvider(org.springframework.ws.client.support.destination.DestinationProvider destinationProvider)
      使用する DestinationProvider を設定します。通常、このプロパティが設定されているか、setDefaultUri(String) が設定されていますが、両方は設定されていません。
      パラメーター:
      destinationProvider - URI パラメーターを持たない操作で使用される宛先プロバイダー
      戻り値:
      新しいビルダーインスタンス。
      関連事項:
      • WebServiceTemplate.setDestinationProvider(DestinationProvider)
    • build

      public org.springframework.ws.client.core.WebServiceTemplate build()
      新しい WebServiceTemplate インスタンスをビルドし、このビルダーを使用して構成します。
      戻り値:
      構成された WebServiceTemplate インスタンス。
      関連事項:
    • build

      public <T extends org.springframework.ws.client.core.WebServiceTemplate> T build(ClassSE<T> webServiceTemplateClass)
      指定された型の新しい WebServiceTemplate インスタンスをビルドし、このビルダーを使用して構成します。
      型パラメーター:
      T - Web サービステンプレートの型
      パラメーター:
      webServiceTemplateClass - 作成するテンプレート型
      戻り値:
      構成された WebServiceTemplate インスタンス。
      関連事項:
    • configure

      public <T extends org.springframework.ws.client.core.WebServiceTemplate> T configure(T webServiceTemplate)
      このビルダーを使用して、提供された WebServiceTemplate インスタンスを構成します。
      型パラメーター:
      T - Web サービステンプレートの型
      パラメーター:
      webServiceTemplate - 設定する WebServiceTemplate 
      戻り値:
      Web サービステンプレートインスタンス
      関連事項: