Package org.mule.soap.api.message

Interface SoapRequest

All Superinterfaces:

SoapMessage, WithContentType

All Known Implementing Classes:

DefaultSoapRequest

public interface SoapRequest
extends SoapMessage

Represents a request that aims to be sent to a Soap Web Service.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
static SoapRequestBuilder	builder()
static SoapRequest	empty(String operation)
default Optional<AddressingProperties>	getAddressingProperties()
String	getOperation()
default Optional<ReliableMessagingProperties>	getReliableMessagingProperties()
boolean	isUseXMLInitialDeclaration()

Methods inherited from interface org.mule.soap.api.message.SoapMessage

getAttachments, getContent, getSoapHeaders, getTransportHeaders

Methods inherited from interface org.mule.soap.api.message.WithContentType

getContentType

Method Details

getOperation

String getOperation()

Returns:

The name of the operation that is requested.

isUseXMLInitialDeclaration

boolean isUseXMLInitialDeclaration()

Returns:

True if the XML initial declaration must be appended to the request's body, otherwise returns False.

getAddressingProperties

default Optional<AddressingProperties> getAddressingProperties()

Returns:

the AddressingProperties that describes the WS-A properties of the request.

Since:

1.6

getReliableMessagingProperties

default Optional<ReliableMessagingProperties> getReliableMessagingProperties()

Returns:

the ReliableMessagingProperties that describes the WS-A properties of the request.

Since:

1.6

builder

static SoapRequestBuilder builder()

Returns:

a SoapRequestBuilder instance to create a new SoapRequest.

empty

static SoapRequest empty(String operation)

Parameters:

operation - the operation that is going to be executed.

Returns:

an empty Soap Request with no content for the requested operation.