クラス WebServiceTemplateBuilder
java.lang.ObjectSE
org.springframework.boot.webservices.client.WebServiceTemplateBuilder
WebServiceTemplate の構成および作成に使用できるビルダー。message senders、client interceptors、customizers を登録するための便利なメソッドを提供します。 デフォルトでは、ビルドされた WebServiceTemplate は最も適切な HTTP ベースの WebServiceMessageSender を使用します。デフォルトのままにする場合は、detectHttpMessageSender(false) を呼び出します。典型的な自動構成 Spring Boot アプリケーションでは、このビルダーは Bean として利用でき、WebServiceTemplate が必要なときにいつでも注入できます。
- 導入:
- 2.1.0
- 作成者:
- Dmytro Nosan, Stephane Nicoll
コンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明additionalCustomizers(CollectionSE<? extends WebServiceTemplateCustomizer> customizers) WebServiceTemplateに適用する必要があるWebServiceTemplateCustomizersを追加します。additionalCustomizers(WebServiceTemplateCustomizer... customizers) WebServiceTemplateに適用する必要があるWebServiceTemplateCustomizersを追加します。additionalInterceptors(CollectionSE<? extends org.springframework.ws.client.support.interceptor.ClientInterceptor> interceptors) WebServiceTemplateで使用する必要がある追加のClientInterceptorsを追加します。additionalInterceptors(org.springframework.ws.client.support.interceptor.ClientInterceptor... interceptors) WebServiceTemplateで使用する必要がある追加のClientInterceptorsを追加します。additionalMessageSenders(CollectionSE<? extends org.springframework.ws.transport.WebServiceMessageSender> messageSenders) WebServiceTemplateで使用する必要がある追加のWebServiceMessageSendersを追加します。additionalMessageSenders(org.springframework.ws.transport.WebServiceMessageSender... messageSenders) WebServiceTemplateで使用する必要がある追加のWebServiceMessageSendersを追加します。org.springframework.ws.client.core.WebServiceTemplatebuild()新しいWebServiceTemplateインスタンスをビルドし、このビルダーを使用して構成します。<T extends org.springframework.ws.client.core.WebServiceTemplate>
T指定された型の新しいWebServiceTemplateインスタンスをビルドし、このビルダーを使用して構成します。<T extends org.springframework.ws.client.core.WebServiceTemplate>
Tconfigure(T webServiceTemplate) このビルダーを使用して、提供されたWebServiceTemplateインスタンスを構成します。customizers(CollectionSE<? extends WebServiceTemplateCustomizer> customizers) WebServiceTemplateに適用するWebServiceTemplateCustomizersを設定します。customizers(WebServiceTemplateCustomizer... customizers) WebServiceTemplateに適用するWebServiceTemplateCustomizersを設定します。detectHttpMessageSender(boolean detectHttpMessageSender) 適切な HTTP ベースのWebServiceMessageSenderが指定されていない場合に、クラスパスに基づいて検出するかどうかを設定します。httpMessageSenderFactory(WebServiceMessageSenderFactory messageSenderFactory) HTTP メッセージを送信するために使用するWebServiceMessageSenderFactoryを設定します。interceptors(CollectionSE<? extends org.springframework.ws.client.support.interceptor.ClientInterceptor> interceptors) WebServiceTemplateで使用するClientInterceptorsを設定します。interceptors(org.springframework.ws.client.support.interceptor.ClientInterceptor... interceptors) WebServiceTemplateで使用するClientInterceptorsを設定します。messageSenders(CollectionSE<? extends org.springframework.ws.transport.WebServiceMessageSender> messageSenders) WebServiceTemplateで使用するWebServiceMessageSendersを設定します。messageSenders(org.springframework.ws.transport.WebServiceMessageSender... messageSenders) WebServiceTemplateで使用するWebServiceMessageSendersを設定します。setCheckConnectionForError(boolean checkConnectionForError) 接続のエラーインジケータをチェックする必要があるか(true)、またはこれらを無視する必要があるか(false)を示します。setCheckConnectionForFault(boolean checkConnectionForFault) 接続の障害インジケーターをチェックする必要があるか(true)、またはメッセージのみに依存する必要があるか(false)を示します。setDefaultUri(StringSE defaultUri) URI パラメーターを持たない操作で使用されるデフォルトの URI を設定します。setDestinationProvider(org.springframework.ws.client.support.destination.DestinationProvider destinationProvider) 使用するDestinationProviderを設定します。setFaultMessageResolver(org.springframework.ws.client.core.FaultMessageResolver faultMessageResolver) 使用するFaultMessageResolverを設定します。setMarshaller(Marshaller marshaller) メッセージのシリアライズに使用するMarshallerを設定します。setTransformerFactoryClass(ClassSE<? extends TransformerFactorySE> transformerFactoryClass) 使用するTransformerFactorySE 実装を設定します。setUnmarshaller(Unmarshaller unmarshaller) メッセージのデシリアライズに使用するUnmarshallerを設定します。setWebServiceMessageFactory(org.springframework.ws.WebServiceMessageFactory messageFactory) メッセージの作成に使用するWebServiceMessageFactoryを設定します。
コンストラクターの詳細
WebServiceTemplateBuilder
メソッドの詳細
httpMessageSenderFactory
public WebServiceTemplateBuilder httpMessageSenderFactory(WebServiceMessageSenderFactory messageSenderFactory) HTTP メッセージを送信するために使用するWebServiceMessageSenderFactoryを設定します。- パラメーター:
messageSenderFactory- 使用するWebServiceMessageSenderFactory- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 3.4.0
- 関連事項:
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
WebServiceTemplateに適用するWebServiceTemplateCustomizersを設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザが置き換えられます。- パラメーター:
customizers- 設定するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
customizers
public WebServiceTemplateBuilder customizers(CollectionSE<? extends WebServiceTemplateCustomizer> customizers) WebServiceTemplateに適用するWebServiceTemplateCustomizersを設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザが置き換えられます。- パラメーター:
customizers- 設定するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
additionalCustomizers
WebServiceTemplateに適用する必要があるWebServiceTemplateCustomizersを追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。- パラメーター:
customizers- 追加するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
additionalCustomizers
public WebServiceTemplateBuilder additionalCustomizers(CollectionSE<? extends WebServiceTemplateCustomizer> customizers) WebServiceTemplateに適用する必要があるWebServiceTemplateCustomizersを追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。- パラメーター:
customizers- 追加するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
setCheckConnectionForFault
接続の障害インジケーターをチェックする必要があるか(true)、またはメッセージのみに依存する必要があるか(false)を示します。- パラメーター:
checkConnectionForFault- 障害インジケータを確認するかどうか- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
WebServiceTemplate.setCheckConnectionForFault(boolean)
setCheckConnectionForError
接続のエラーインジケータをチェックする必要があるか(true)、またはこれらを無視する必要があるか(false)を示します。- パラメーター:
checkConnectionForError- エラーインジケーターをチェックするかどうか- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
WebServiceTemplate.setCheckConnectionForError(boolean)
setWebServiceMessageFactory
public WebServiceTemplateBuilder setWebServiceMessageFactory(org.springframework.ws.WebServiceMessageFactory messageFactory) メッセージの作成に使用するWebServiceMessageFactoryを設定します。- パラメーター:
messageFactory- メッセージの作成に使用するメッセージファクトリ- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
WebServiceAccessor.setMessageFactory(WebServiceMessageFactory)
setUnmarshaller
メッセージのデシリアライズに使用するUnmarshallerを設定します。- パラメーター:
unmarshaller- メッセージアンマーシャラー- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
WebServiceTemplate.setUnmarshaller(Unmarshaller)
setMarshaller
メッセージのシリアライズに使用する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
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 サービステンプレートインスタンス
- 関連事項: