SOAP

Description

SOAP Helper functions

Functions

NameSignature and Synopsis
addAttachmentvoid addAttachment(SimpleEvent soapEvent, String contentID, Object content, String contentType)
Adds a new attachment to the SOAP message.
addFaultPartvoid addFaultPart (SimpleEvent soapEvent, String faultCode, String faultMessage, String faultActor, String faultDetailString)
Adds a <fault> element to the standard SOAP body

This can be used to build response SOAP body

addHeaderPartvoid addHeaderPart (SimpleEvent soapEvent, String headerPartXml)
Adds a header fragment as a child of the standard SOAP header. This fragment should be a well formed XML.

The actor, and mustUnderstand attribute values are added for the header element.

addSOAPBodyPartvoid addSOAPBodyPart (SimpleEvent soapEvent, String bodyXml)
Adds a body fragment as a child of the standard SOAP body. This fragment should be a well formed xml.
addSOAPHeaderAttributevoid addSOAPHeaderAttribute(SimpleEvent soapEvent, int index, String attribute, String value)
Add attribute to SOAP header
getAllSOAPBodyPartsString[] getAllSOAPBodyParts (SimpleEvent soapEvent)
Gets all SOAP <Body> parts from the SOAP event
getAttachmentContentObject getAttachmentContent(SimpleEvent soapEvent, int index)
Gets the content of the attachment in byte[] form. The attachment is specified using the index. will return null in case of no attachment
getAttachmentContentByContentIDObject getAttachmentContentByContentID(SimpleEvent soapEvent, String contentID)
Gets the content of the attachment in byte[] form. Returns a null if no attachment is found with the given content ID.
getAttachmentContentIDString getAttachmentContentID(SimpleEvent soapEvent, int index)
Gets the String value content ID of the attachment. The attachment is specified using the index.
getAttachmentContentTypeString getAttachmentContentType(SimpleEvent soapEvent, int index)
Gets the String value content type of the attachment. The attachment is specified using the index.
getEnvelopeString getEnvelope (SimpleEvent soapEvent)
Gets the standard SOAP envelope xml node from the payload of this SOAP event.
getFaultString getFault (SimpleEvent soapEvent)
Gets the SOAP <Fault> element from the SOAP event
getFaultActorString getFaultActor (SimpleEvent soapEvent)
Gets the <faultactor> from the SOAP event.
getFaultCodeString getFaultCode (SimpleEvent soapEvent)
Gets the <faultcode> from the SOAP event.
getFaultStringString getFaultString (SimpleEvent soapEvent)
Gets the <faultstring> from the SOAP event.
getHeadersString[] getHeaders(SimpleEvent soapEvent, String actor, boolean removeHeaders)
Gets a list of headers inside the <Header> element of a SOAP message.

The actor value of null means all immediate children of the SOAP header are retrieved.

A non-null actor means only those headers having SOAP actor attribute same as this actor are retrieved.

getNumberOfAttachmentsint getNumberOfAttachments(SimpleEvent soapEvent)
Gets a count of SOAP attachments in the incoming SOAP message.
getSOAPBodyPartsString[] getSOAPBodyParts (SimpleEvent soapEvent, String name, String namespace)
Gets the SOAP <Body> parts matching the name and namespace from the SOAP event
getSOAPHeaderAttributeString getSOAPHeaderAttribute (SimpleEvent soapEvent, int index, String attribute)
Gets the value of the given attribute for the header part at the specified index in header body of the Simple event
removeHeaderPartvoid removeHeaderPart (SimpleEvent soapEvent, String namespace, String name)
Removes 0 or more children of a SOAP <Header> of a SOAP message.
removeHeaderPartsvoid removeHeaderParts (SimpleEvent soapEvent, String actor)
Removes 0 or more children of a SOAP <Header> of a SOAP message.

A null actor value will remove all headers without an actor