クラス 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 ClientInterceptor> interceptors) WebServiceTemplateで使用する必要があるClientInterceptorsを追加します。additionalInterceptors(ClientInterceptor... interceptors) WebServiceTemplateで使用する必要があるClientInterceptorsを追加します。additionalMessageSenders(CollectionSE<? extends WebServiceMessageSender> messageSenders) WebServiceTemplateで使用する必要があるWebServiceMessageSendersを追加します。additionalMessageSenders(WebServiceMessageSender... messageSenders) WebServiceTemplateで使用する必要があるWebServiceMessageSendersを追加します。build()新しいWebServiceTemplateインスタンスをビルドし、このビルダーを使用して構成します。<T extends WebServiceTemplate>
T指定された型の新しいWebServiceTemplateインスタンスをビルドし、このビルダーを使用して構成します。<T extends 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 ClientInterceptor> interceptors) WebServiceTemplateで使用するClientInterceptorsを設定します。interceptors(ClientInterceptor... interceptors) WebServiceTemplateで使用するClientInterceptorsを設定します。messageSenders(CollectionSE<? extends WebServiceMessageSender> messageSenders) WebServiceTemplateと一緒に使用するWebServiceMessageSendersを設定します。messageSenders(WebServiceMessageSender... messageSenders) WebServiceTemplateと一緒に使用するWebServiceMessageSendersを設定します。setCheckConnectionForError(boolean checkConnectionForError) 接続のエラーインジケータをチェックする必要があるか(true)、またはこれらを無視する必要があるか(false)を示します。setCheckConnectionForFault(boolean checkConnectionForFault) 接続の障害インジケーターをチェックする必要があるか(true)、またはメッセージのみに依存する必要があるか(false)を示します。setDefaultUri(StringSE defaultUri) URI パラメーターを持たない操作で使用されるデフォルトの URI を設定します。setDestinationProvider(DestinationProvider destinationProvider) 使用するDestinationProviderを設定します。setFaultMessageResolver(FaultMessageResolver faultMessageResolver) 使用するFaultMessageResolverを設定します。setMarshaller(Marshaller marshaller) メッセージのシリアライズに使用するMarshallerを設定します。setTransformerFactoryClass(ClassSE<? extends TransformerFactorySE> transformerFactoryClass) 使用するTransformerFactorySE 実装を設定します。setUnmarshaller(Unmarshaller unmarshaller) メッセージのデシリアライズに使用するUnmarshallerを設定します。setWebServiceMessageFactory(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
Sets theWebServiceMessageSendersthat should be used with theWebServiceTemplate. Setting this value will replace any previously defined message senders, including the HTTP-based message sender, if any. Consider usingadditionalMessageSenders(WebServiceMessageSender...)to keep it with user-defined message senders.- パラメーター:
messageSenders- 設定するメッセージ送信者- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
messageSenders
public WebServiceTemplateBuilder messageSenders(CollectionSE<? extends WebServiceMessageSender> messageSenders) Sets theWebServiceMessageSendersthat should be used with theWebServiceTemplate. Setting this value will replace any previously defined message senders, including the HTTP-based message sender, if any. Consider usingadditionalMessageSenders(Collection)to keep it with user-defined message senders.- パラメーター:
messageSenders- 設定するメッセージ送信者- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
additionalMessageSenders
public WebServiceTemplateBuilder additionalMessageSenders(WebServiceMessageSender... messageSenders) WebServiceTemplateで使用する必要があるWebServiceMessageSendersを追加します。- パラメーター:
messageSenders- 追加するメッセージ送信者- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
additionalMessageSenders
public WebServiceTemplateBuilder additionalMessageSenders(CollectionSE<? extends WebServiceMessageSender> messageSenders) WebServiceTemplateで使用する必要があるWebServiceMessageSendersを追加します。- パラメーター:
messageSenders- 追加するメッセージ送信者- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
interceptors
WebServiceTemplateで使用するClientInterceptorsを設定します。この値を設定すると、以前に定義されたインターセプターが置き換えられます。- パラメーター:
interceptors- 設定するインターセプター- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
interceptors
public WebServiceTemplateBuilder interceptors(CollectionSE<? extends ClientInterceptor> interceptors) WebServiceTemplateで使用するClientInterceptorsを設定します。この値を設定すると、以前に定義されたインターセプターが置き換えられます。- パラメーター:
interceptors- 設定するインターセプター- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
additionalInterceptors
WebServiceTemplateで使用する必要があるClientInterceptorsを追加します。- パラメーター:
interceptors- 追加するインターセプター- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
additionalInterceptors
public WebServiceTemplateBuilder additionalInterceptors(CollectionSE<? extends ClientInterceptor> interceptors) WebServiceTemplateで使用する必要があるClientInterceptorsを追加します。- パラメーター:
interceptors- 追加するインターセプター- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
customizers
SetWebServiceTemplateCustomizersthat should be applied to theWebServiceTemplate. Customizers are applied in the order that they were added after builder configuration has been applied. Setting this value will replace any previously configured customizers.- パラメーター:
customizers- 設定するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
customizers
public WebServiceTemplateBuilder customizers(CollectionSE<? extends WebServiceTemplateCustomizer> customizers) SetWebServiceTemplateCustomizersthat should be applied to theWebServiceTemplate. Customizers are applied in the order that they were added after builder configuration has been applied. Setting this value will replace any previously configured customizers.- パラメーター:
customizers- 設定するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
additionalCustomizers
Add additionalWebServiceTemplateCustomizersthat should be applied to theWebServiceTemplate. Customizers are applied in the order that they were added after builder configuration has been applied.- パラメーター:
customizers- 追加するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
additionalCustomizers
public WebServiceTemplateBuilder additionalCustomizers(CollectionSE<? extends WebServiceTemplateCustomizer> customizers) Add additionalWebServiceTemplateCustomizersthat should be applied to theWebServiceTemplate. Customizers are applied in the order that they were added after builder configuration has been applied.- パラメーター:
customizers- 追加するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
setCheckConnectionForFault
接続の障害インジケーターをチェックする必要があるか(true)、またはメッセージのみに依存する必要があるか(false)を示します。- パラメーター:
checkConnectionForFault- 障害インジケータを確認するかどうか- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
setCheckConnectionForError
接続のエラーインジケータをチェックする必要があるか(true)、またはこれらを無視する必要があるか(false)を示します。- パラメーター:
checkConnectionForError- エラーインジケーターをチェックするかどうか- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
setWebServiceMessageFactory
public WebServiceTemplateBuilder setWebServiceMessageFactory(WebServiceMessageFactory messageFactory) メッセージ作成に使用するWebServiceMessageFactoryを設定します。- パラメーター:
messageFactory- メッセージの作成に使用するメッセージファクトリ- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
setUnmarshaller
メッセージのデシリアライズに使用するUnmarshallerを設定します。- パラメーター:
unmarshaller- メッセージアンマーシャラー- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
setMarshaller
メッセージのシリアライズに使用するMarshallerを設定します。- パラメーター:
marshaller- メッセージマーシャラー- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
setFaultMessageResolver
使用するFaultMessageResolverを設定します。- パラメーター:
faultMessageResolver- 使用する障害メッセージリゾルバー- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
setTransformerFactoryClass
public WebServiceTemplateBuilder setTransformerFactoryClass(ClassSE<? extends TransformerFactorySE> transformerFactoryClass) 使用するTransformerFactorySE 実装を設定します。- パラメーター:
transformerFactoryClass- 使用するトランスフォーマーファクトリの実装- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
setDefaultUri
URI パラメーターを持たない操作で使用されるデフォルトの URI を設定します。通常、このプロパティが設定されているか、setDestinationProvider(DestinationProvider)が設定されていますが、両方は設定されていません。- パラメーター:
defaultUri- URI パラメーターを持たない操作で使用される宛先プロバイダー URI。- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
setDestinationProvider
Set theDestinationProviderto use. Typically, either this property is set, orsetDefaultUri(String), but not both.- パラメーター:
destinationProvider- URI パラメーターを持たない操作で使用される宛先プロバイダー- 戻り値:
- 新しいビルダーインスタンス。
- 関連事項:
build
新しいWebServiceTemplateインスタンスをビルドし、このビルダーを使用して構成します。- 戻り値:
- 構成済みの
WebServiceTemplateインスタンス。 - 関連事項:
build
指定された型の新しいWebServiceTemplateインスタンスをビルドし、このビルダーを使用して構成します。- 型パラメーター:
T- Web サービステンプレートの型- パラメーター:
webServiceTemplateClass- 作成するテンプレート型- 戻り値:
- 構成済みの
WebServiceTemplateインスタンス。 - 関連事項:
configure
このビルダーを使用して、提供されたWebServiceTemplateインスタンスを構成します。- 型パラメーター:
T- Web サービステンプレートの型- パラメーター:
webServiceTemplate- 構成するWebServiceTemplate- 戻り値:
- Web サービステンプレートインスタンス
- 関連事項: