Package org.citrusframework.ws.message

Class SoapMessage

java.lang.Object
org.citrusframework.message.DefaultMessage
org.citrusframework.ws.message.SoapMessage
All Implemented Interfaces:
Serializable, Message
Direct Known Subclasses:
SoapFault
public class SoapMessage extends DefaultMessage
SOAP message representation holding additional elements like SOAP action, header fragment data and attachments.
Since:
2.0
See Also:

  • Constructor Details

    • SoapMessage

      public SoapMessage()
      Empty constructor initializing with empty message payload.

    • SoapMessage

      public SoapMessage(Message message)
      Constructs copy of given message.
      Parameters:
      message -

    • SoapMessage

      public SoapMessage(Object payload)
      Default constructor using just message payload.
      Parameters:
      payload -

    • SoapMessage

      public SoapMessage(Object payload, Map<String,Object> headers)
      Default constructor using payload and headers.
      Parameters:
      payload -
      headers -

  • Method Details

    • header

      public SoapMessage header(String headerName, Object headerValue)
      Sets new header name value pair.
      Parameters:
      headerName -
      headerValue -
      Returns:

    • setHeader

      public SoapMessage setHeader(String headerName, Object headerValue)
      Specified by:
      setHeader in interface Message
      Overrides:
      setHeader in class DefaultMessage

    • addHeaderData

      public SoapMessage addHeaderData(String headerData)
      Specified by:
      addHeaderData in interface Message
      Overrides:
      addHeaderData in class DefaultMessage

    • contentType

      public SoapMessage contentType(String contentType)
      Sets the Http request content type header.
      Parameters:
      contentType - The content type header value to use
      Returns:
      The altered HttpMessage

    • accept

      public SoapMessage accept(String accept)
      Sets the Http accepted content type header for response.
      Parameters:
      accept - The accept header value to set
      Returns:
      The altered HttpMessage

    • status

      public SoapMessage status(org.springframework.http.HttpStatus statusCode)
      Sets the Http response status code.
      Parameters:
      statusCode - The status code header to respond with
      Returns:
      The altered HttpMessage

    • statusCode

      public SoapMessage statusCode(Integer statusCode)
      Sets the Http response status code header.
      Parameters:
      statusCode - The status code header value to respond with
      Returns:
      The altered HttpMessage

    • reasonPhrase

      public SoapMessage reasonPhrase(String reasonPhrase)
      Sets the Http response reason phrase header.
      Parameters:
      reasonPhrase - The reason phrase header value to use
      Returns:
      The altered HttpMessage

    • soapAction

      public SoapMessage soapAction(String soapAction)
      Set soap action for this message.
      Parameters:
      soapAction -

    • mtomEnabled

      public SoapMessage mtomEnabled(boolean mtomEnabled)
      Enable or disable mtom attachments
      Parameters:
      mtomEnabled -

    • addAttachment

      public SoapMessage addAttachment(SoapAttachment attachment)
      Adds new attachment to this message.
      Parameters:
      attachment -

    • getSoapAction

      public String getSoapAction()
      Gets the soap action for this message.
      Returns:

    • getAttachments

      public List<SoapAttachment> getAttachments()
      Gets the list of message attachments.
      Returns:

    • isMtomEnabled

      public boolean isMtomEnabled()
      Gets mtom attachments enabled
      Returns:

    • toString

      public String toString()
      Overrides:
      toString in class DefaultMessage