WebServiceTemplateBuilder

Builder that can be used to configure and create a WebServiceTemplate. Provides convenience methods to register message senders, client interceptors and customizers.

By default the built WebServiceTemplate uses the most suitable HTTP-based WebServiceMessageSender, call detectHttpMessageSender(false) if you prefer to keep the default. In a typical auto-configured Spring Boot application this builder is available as a bean and can be injected whenever a WebServiceTemplate is needed.

Author

Dmytro Nosan

Stephane Nicoll

Since

2.1.0

Constructors

Link copied to clipboard
constructor(customizers: Array<WebServiceTemplateCustomizer>)

Functions

Link copied to clipboard
Link copied to clipboard
open fun additionalInterceptors(interceptors: Collection<out ClientInterceptor>): WebServiceTemplateBuilder
open fun additionalInterceptors(interceptors: Array<ClientInterceptor>): WebServiceTemplateBuilder
Add additional ClientInterceptors that should be used with the WebServiceTemplate.
Link copied to clipboard
open fun additionalMessageSenders(messageSenders: Collection<out WebServiceMessageSender>): WebServiceTemplateBuilder
open fun additionalMessageSenders(messageSenders: Array<WebServiceMessageSender>): WebServiceTemplateBuilder
Add additional WebServiceMessageSenders that should be used with the WebServiceTemplate.
Link copied to clipboard
open fun build(): WebServiceTemplate
Build a new WebServiceTemplate instance and configure it using this builder.
open fun <T : WebServiceTemplate?> build(webServiceTemplateClass: Class<T>): T
Build a new WebServiceTemplate instance of the specified type and configure it using this builder.
Link copied to clipboard
open fun <T : WebServiceTemplate?> configure(webServiceTemplate: T): T
Configure the provided WebServiceTemplate instance using this builder.
Link copied to clipboard
Link copied to clipboard
open fun detectHttpMessageSender(detectHttpMessageSender: Boolean): WebServiceTemplateBuilder
Set if a suitable HTTP-based WebServiceMessageSender should be detected based on the classpath.
Link copied to clipboard
open fun interceptors(interceptors: Collection<out ClientInterceptor>): WebServiceTemplateBuilder
open fun interceptors(interceptors: Array<ClientInterceptor>): WebServiceTemplateBuilder
Set the ClientInterceptors that should be used with the WebServiceTemplate.
Link copied to clipboard
open fun messageSenders(messageSenders: Collection<out WebServiceMessageSender>): WebServiceTemplateBuilder
open fun messageSenders(messageSenders: Array<WebServiceMessageSender>): WebServiceTemplateBuilder
Sets the WebServiceMessageSenders that should be used with the WebServiceTemplate.
Link copied to clipboard
Indicates whether the connection should be checked for error indicators (true), or whether these should be ignored (false).
Link copied to clipboard
Indicates whether the connection should be checked for fault indicators (true), or whether we should rely on the message only (false).
Link copied to clipboard
Set the default URI to be used on operations that do not have a URI parameter.
Link copied to clipboard
open fun setDestinationProvider(destinationProvider: DestinationProvider): WebServiceTemplateBuilder
Set the DestinationProvider to use.
Link copied to clipboard
open fun setFaultMessageResolver(faultMessageResolver: FaultMessageResolver): WebServiceTemplateBuilder
Set the FaultMessageResolver to use.
Link copied to clipboard
Set the Marshaller to use to serialize messages.
Link copied to clipboard
Set the TransformerFactory implementation to use.
Link copied to clipboard
Set the Unmarshaller to use to deserialize messages.
Link copied to clipboard
open fun setWebServiceMessageFactory(messageFactory: WebServiceMessageFactory): WebServiceTemplateBuilder
Sets the WebServiceMessageFactory to use for creating messages.