org.mule.runtime.soap.api.client

Class SoapClientConfigurationBuilder

java.lang.Object

org.mule.runtime.soap.api.client.SoapClientConfigurationBuilder

public class SoapClientConfigurationBuilder
extends Object

Builder pattern implementation that creates SoapClientConfiguration instances.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
SoapClientConfiguration	build()
SoapClientConfigurationBuilder	enableMtom(boolean mtomEnabled) Specifies that the Web Service is MTOM enabled.
SoapClientConfigurationBuilder	withAddress(String address) Sets the address of the Web Service, if none specified it will be fetched from the wsdl file, if possible.
SoapClientConfigurationBuilder	withDispatcher(org.mule.runtime.extension.api.soap.message.MessageDispatcher dispatcher) Sets a custom MessageDispatcher that enables the send and retrieve of SoapMessages using a custom underlying transport.
SoapClientConfigurationBuilder	withEncoding(String encoding) Sets the encoding of the messages send and retrieved by the .
SoapClientConfigurationBuilder	withPort(String port) Sets the port of the service that describes the set of operations that can be performed.
SoapClientConfigurationBuilder	withResourceLocator(TransportResourceLocator locator) Sets a TransportResourceLocator instance to fetch the wsdl resources.
SoapClientConfigurationBuilder	withSecurities(List<org.mule.runtime.extension.api.soap.security.SecurityStrategy> security) Sets a list of SecurityStrategies to connect with a Secured Soap Web Service.
SoapClientConfigurationBuilder	withSecurity(org.mule.runtime.extension.api.soap.security.SecurityStrategy security) Sets a new SecurityStrategy to connect with a Secured Soap Web Service.
SoapClientConfigurationBuilder	withService(String service) Sets the service of the WSDL we want to perform operations from.
SoapClientConfigurationBuilder	withVersion(SoapVersion version) Sets the SoapVersion of the Web Service.
SoapClientConfigurationBuilder	withWsdlLocation(String wsdlLocation) Sets the location of the WSDL that describes the SOAP web service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withWsdlLocation

public SoapClientConfigurationBuilder withWsdlLocation(String wsdlLocation)

Sets the location of the WSDL that describes the SOAP web service. This can be an URL to an external resource (e.g http://somewsdl.com/hit?wsdl), just a reference to a local file or an application resource name.

Returns:

this builder.

withAddress

public SoapClientConfigurationBuilder withAddress(String address)

Sets the address of the Web Service, if none specified it will be fetched from the wsdl file, if possible.

Returns:

this builder.

withService

public SoapClientConfigurationBuilder withService(String service)

Sets the service of the WSDL we want to perform operations from.

Returns:

this builder.

withPort

public SoapClientConfigurationBuilder withPort(String port)

Sets the port of the service that describes the set of operations that can be performed.

Returns:

this builder.

withEncoding

public SoapClientConfigurationBuilder withEncoding(String encoding)

Sets the encoding of the messages send and retrieved by the .

Returns:

this builder.

withVersion

public SoapClientConfigurationBuilder withVersion(SoapVersion version)

Sets the SoapVersion of the Web Service. defaults to SOAP 1.1

Returns:

this builder.

enableMtom

public SoapClientConfigurationBuilder enableMtom(boolean mtomEnabled)

Specifies that the Web Service is MTOM enabled.

Returns:

this builder.

withSecurity

public SoapClientConfigurationBuilder withSecurity(org.mule.runtime.extension.api.soap.security.SecurityStrategy security)

Sets a new SecurityStrategy to connect with a Secured Soap Web Service.

One of: DecryptSecurityStrategy, EncryptSecurityStrategy, SignSecurityStrategy, TimestampSecurityStrategy, UsernameTokenSecurityStrategy or VerifySignatureSecurityStrategy.

Multiple Security Strategies can be configured.

Returns:

this builder.

withSecurities

public SoapClientConfigurationBuilder withSecurities(List<org.mule.runtime.extension.api.soap.security.SecurityStrategy> security)

Sets a list of SecurityStrategies to connect with a Secured Soap Web Service.

Returns:

this builder.

withDispatcher

public SoapClientConfigurationBuilder withDispatcher(org.mule.runtime.extension.api.soap.message.MessageDispatcher dispatcher)

Sets a custom MessageDispatcher that enables the send and retrieve of SoapMessages using a custom underlying transport.

Returns:

this builder

withResourceLocator

public SoapClientConfigurationBuilder withResourceLocator(TransportResourceLocator locator)

Sets a TransportResourceLocator instance to fetch the wsdl resources.

Returns:

this builder

build

public SoapClientConfiguration build()

Returns:

a new SoapClientConfiguration instance with the attributes specified.