org.mule.soap.api.client

Interface SoapClient

All Known Implementing Classes:

AbstractSoapCxfClient, DefaultSoapCxfClient, SoapMtomCxfClient

public interface SoapClient

Contract for clients that consumes SOAP Web Services.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
SoapResponse	consume(SoapRequest request, TransportDispatcher dispatcher) Sends a SoapRequest blocking the current thread until a response is available or the request times out.
default String	createSequence(CreateSequenceRequest request, TransportDispatcher dispatcher) Creates a Reliable Message sequence
void	destroy() Shuts down the client and all resources that is holding.
default SoapResponse	parseResponse(String operation, TransportResponse response) Generates a SoapResponse from a TransportResponse
default void	terminateSequence(TerminateSequenceRequest request, TransportDispatcher dispatcher) Terminates a Reliable Message sequence

Method Detail

consume

SoapResponse consume(SoapRequest request,
                     TransportDispatcher dispatcher)
              throws BadRequestException,
                     BadResponseException

Sends a SoapRequest blocking the current thread until a response is available or the request times out.

Parameters:

request - a SoapRequest instance.

dispatcher - a TransportDispatcher that will be used to dispatch the SoapRequest

Returns:

a SoapResponse instance with the XML content and Headers if any.

Throws:

BadRequestException

BadResponseException

parseResponse

default SoapResponse parseResponse(String operation,
                                   TransportResponse response)
                            throws BadResponseException

Generates a SoapResponse from a TransportResponse

Parameters:

operation - The name of the operation related to the response

response - a TransportResponse instance

Returns:

a SoapResponse instance with the XML content and Headers if any.

Throws:

BadResponseException

Since:

1.5

destroy

void destroy()

Shuts down the client and all resources that is holding.

createSequence

default String createSequence(CreateSequenceRequest request,
                              TransportDispatcher dispatcher)

Creates a Reliable Message sequence

Parameters:

request - a CreateSequenceRequest instance.

dispatcher - a TransportDispatcher that will be used to dispatch the RM protocol message

Returns:

a String representing a reliable message sequence identifier

Since:

1.6

terminateSequence

default void terminateSequence(TerminateSequenceRequest request,
                               TransportDispatcher dispatcher)

Terminates a Reliable Message sequence

Parameters:

request - a TerminateSequenceRequest instance.

dispatcher - a TransportDispatcher that will be used to dispatch the RM protocol message

Since:

1.6