org.mule.modules.wsdl.runtime

Class SoapClient

java.lang.Object

org.mule.modules.wsdl.runtime.SoapClient

public class SoapClient
extends Object

Helper class that invokes SOAP web services.

Author:

martin.paoloni@mulesoft.com

Method Summary

Modifier and Type	Method and Description
Dispatch<SOAPMessage>	buildMessageDispatch(String endpointPath, String operationName)
SOAPMessage	buildSoapRequest(XMLStreamReader payload, String operationName, Dispatch<SOAPMessage> dispatch, DocumentBuilder docBuilder) Build SOAP Request based on the provided parameters
static SoapClient	create(ServiceDefinition service)
Integer	getConnectionTimeout() Getter method for connection timeout.
Map<String,String>	getHeaderParams()
Integer	getReadTimeout() Getter method for readTimeout
XMLStreamReader	invoke(CallDefinition callDefinition, XMLStreamReader payload) Invokes a web serviceDefinition.
XMLStreamReader	invoke(CallDefinition callDefinition, XMLStreamReader payload, DocumentBuilder docBuilder) Invokes a web serviceDefinition.
void	setConnectionTimeout(int connectionTimeout) Setter method for connectionTimeout.
void	setHeaderParams(Map<String,String> headerParams) Sets the parameters to be appended to the header.
void	setReadTimeout(Integer readTimeout) Setter method for readTimeout.
void	setSoapHeaderBuilder(HeaderBuilder soapHeaderBuilder) Sets the HeaderBuilder implementation.

Methods inherited from class java.lang.Object

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

Method Detail

create

@NotNull
public static SoapClient create(@NotNull
                                         ServiceDefinition service)

invoke

@Nullable
public XMLStreamReader invoke(@NotNull
                                        CallDefinition callDefinition,
                                        @Nullable
                                        XMLStreamReader payload)
                                 throws SoapCallException

Invokes a web serviceDefinition.

Parameters:

payload - A {link reader with the payload message to send.

callDefinition - SOAP operation invocation definition

Returns:

A {link reader with the output message received.

Throws:

SoapCallException - Unexpected error during serviceDefinition call

invoke

@Nullable
public XMLStreamReader invoke(@NotNull
                                        CallDefinition callDefinition,
                                        @Nullable
                                        XMLStreamReader payload,
                                        DocumentBuilder docBuilder)
                                 throws SoapCallException

Invokes a web serviceDefinition.

Parameters:

payload - A {link reader with the payload message to send.

callDefinition - SOAP operation invocation definition

docBuilder - class used to transform the reader into a Document and, if necessary, enrich it with an xsi:type attribute

Returns:

A {link reader with the output message received.

Throws:

SoapCallException - Unexpected error during serviceDefinition call

buildMessageDispatch

@NotNull
public Dispatch<SOAPMessage> buildMessageDispatch(@NotNull
                                                           String endpointPath,
                                                           @NotNull
                                                           String operationName)

buildSoapRequest

@NotNull
public SOAPMessage buildSoapRequest(@Nullable
                                             XMLStreamReader payload,
                                             @NotNull
                                             String operationName,
                                             @NotNull
                                             Dispatch<SOAPMessage> dispatch,
                                             DocumentBuilder docBuilder)
                                      throws SOAPException,
                                             SoapHeaderException,
                                             XMLStreamException,
                                             ParserConfigurationException

Build SOAP Request based on the provided parameters

Parameters:

payload - Full payload to be sent without the operation

operationName - Operation name to be invoked.

dispatch - Dispatch object used for the invocation.

docBuilder - class used to transform the reader into a Document and, if necessary, enrich it with an xsi:type attribute

Returns:

SOAPMessage ready to be sent.

Throws:

SOAPException - when it cannot construct the SOAPMessage

SoapHeaderException - when it cannot build the SOAP Headers

XMLStreamException - when it cannot successfully create the XMLStreamReader

ParserConfigurationException - when it cannot properly modify the payload with the xsi:type attribute

getConnectionTimeout

public Integer getConnectionTimeout()

Getter method for connection timeout.

Returns:

the connectionTimeout

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

Setter method for connectionTimeout.

Parameters:

connectionTimeout - the connectionTimeout to set

getReadTimeout

public Integer getReadTimeout()

Getter method for readTimeout

Returns:

the readTimeout

setReadTimeout

public void setReadTimeout(Integer readTimeout)

Setter method for readTimeout.

Parameters:

readTimeout - the readTimeout to set

getHeaderParams

@NotNull
public Map<String,String> getHeaderParams()

setHeaderParams

public void setHeaderParams(@NotNull
                            Map<String,String> headerParams)

Sets the parameters to be appended to the header.

Parameters:

headerParams - the header parameters to set.

setSoapHeaderBuilder

public void setSoapHeaderBuilder(HeaderBuilder soapHeaderBuilder)

Sets the HeaderBuilder implementation.

Parameters:

soapHeaderBuilder - the HeaderBuilder implementation.