public interface SOAPSupport extends XMLSupport
Modifier and Type | Method and Description |
---|---|
void |
addStringAsSoapHeader(Message msg,
java.lang.String name,
java.lang.String uri,
java.lang.String content)
Adds a String as a new SOAP header
|
void |
convertSoapToDOM(Message m)
Deprecated.
use the
XMLSupport.convertToDOM(org.adroitlogic.ultraesb.api.Message) instead |
java.lang.Object |
convertSOAPToJAXBObject(Message msg,
java.lang.Class clazz)
Converts a SOAP payload into a JAXB Object.
|
void |
convertSOAPToJSONStream(Message m)
Convert the current SOAP message payload (which maybe available as any format such as raw file or DOM etc)
into a file based JSON stream
|
void |
convertSOAPToJSONStream(Message m,
javax.xml.namespace.QName staringElement,
boolean retainNSPrefixes)
Convert the current SOAP message payload (which maybe available as any format such as raw file or DOM etc)
into a file based JSON stream
|
void |
deleteSoapHeader(Message msg,
java.lang.String name,
java.lang.String uri)
Delete a SOAP header and its descendants
|
java.lang.String |
getSoapAction(Message msg)
Return the SOAPAction transport header
|
java.lang.String |
getSoapAddressingAction(Message msg)
Get the WSA Action header
|
java.lang.String |
getSoapAddressingFaultTo(Message msg)
Get the WSA FaultTo header
|
java.lang.String |
getSoapAddressingFrom(Message msg)
Get the WSA From header
|
java.lang.String |
getSoapAddressingMessageID(Message msg)
Get the WSA MessageID header
|
java.lang.String |
getSoapAddressingReplyTo(Message msg)
Get the WSA ReplyTo header
|
java.lang.String |
getSoapAddressingTo(Message msg)
Get the WSA To header
|
java.lang.String |
getSoapFaultCode(Message msg)
Extract the SOAP 1.1 Fault/faultcode or SOAP 1.2 Fault/Code/Value if exists
|
java.lang.String |
getSoapFaultDetail(Message msg)
Extract the SOAP 1.1 detail or SOAP 1.2 Detail if exists
|
java.lang.String |
getSoapFaultString(Message msg)
Extract the SOAP 1.1 Fault/faultstring or SOAP 1.2 Reason/Text if exists
|
java.lang.String |
getSoapHeaderAsString(Message msg,
java.lang.String namespace,
java.lang.String name)
Extract the SOAP 1.1/1.2 header value as a String
|
java.util.Map |
getSoapHeadersAsStrings(Message m)
Extract the SOAP 1.1/1.2 header values as a Strings
|
boolean |
isSoap(Message msg)
Check the message content type to see if it indicates a SOAP 1.1 or 1.2 message serialized as XML
|
boolean |
isSoap11(Message msg)
Check the message content type to see if it indicates a SOAP 1.1 message serialized as XML
|
boolean |
isSoap12(Message msg)
Check the message content type to see if it indicates a SOAP 1.2 message serialized as XML
|
void |
removeSoapHeader(Message msg,
java.lang.String name,
java.lang.String uri)
Removes the specified SOAP header and its descendants if any from the payload
|
void |
replaceStringAsSoapHeader(Message msg,
java.lang.String name,
java.lang.String uri,
java.lang.String content)
Replace String based SOAP header
|
void |
serializeJAXBObjectAsSOAP11Stream(Message msg,
java.lang.Object jaxb)
Serialize a JAXB Object as a SOAP 1.1 Stream message
|
void |
serializeJAXBObjectAsSOAP11Stream(Message msg,
java.lang.Object jaxb,
java.lang.String rootElement,
java.lang.String uri)
Serialize a JAXB Object as a SOAP 1.1 Stream message
|
void |
serializeJAXBObjectAsSOAP12Stream(Message msg,
java.lang.Object jaxb)
Serialize a JAXB Object as a SOAP 1.2 Stream message
|
void |
serializeJAXBObjectAsSOAP12Stream(Message msg,
java.lang.Object jaxb,
java.lang.String rootElement,
java.lang.String uri)
Serialize a JAXB Object as a SOAP 1.2 Stream message
|
void |
setPayloadToSOAP11Fault(Message m,
java.lang.String code,
java.lang.String faultString,
java.lang.String detail)
Set the payload of the current message to a SOAP 1.1 fault message with the given code, faultString and detail
|
void |
setPayloadToSOAP12Fault(Message m,
java.lang.String code,
java.lang.String reason,
java.lang.String detail)
Set the payload of the current message to a SOAP 1.2 fault message with the given code, reason and detail
|
addAttributeToElements, addAttributeToElements, addElementsAsChild, addElementsAsChild, addTextElementsAsChild, addTextElementsAsChild, aggregateWithBean, convertDOMToSoap11, convertDOMToSoap12, convertFromFI, convertToDOM, convertToFI, convertXMLToJAXBObject, convertXMLToJAXBObject, convertXMLToJSONStream, convertXMLToJSONStream, createDOMDocument, deleteAttributes, deleteElements, extractAsNodeListUsingXPath, extractAsNodeListUsingXPath, extractAsStringUsingXPath, extractAsStringUsingXPath, extractAsStringUsingXPath, filter, filter, filter, getAttribute, getPayloadAsDOM, getTextElement, insertTextElementsAfter, insertTextElementsAfter, insertTextElementsBefore, insertTextElementsBefore, mergeXMLAttachmentsUnderElement, mergeXMLAttachmentsUnderElement, remove, replaceAttributes, replaceAttributes, replaceTextElements, replaceTextElements, retainElementAsPayload, serializeJAXBObjectAsXMLStream, serializeJAXBObjectAsXMLStream, serializeJAXBObjectAsXMLStream, serializeJAXBObjectAsXMLStream, setPayloadFromDOM, splitAndProcess, splitAndProcess, splitWithBean, transform, transform, transform, transform, validate, validate, validate, validate, wrapPayload
boolean isSoap(Message msg)
msg
- the message to detectboolean isSoap11(Message msg)
msg
- the message to detectboolean isSoap12(Message msg)
msg
- the message to detectjava.lang.String getSoapAction(Message msg)
msg
- message to extract the header fromvoid convertSOAPToJSONStream(Message m)
m
- the message to be convertedvoid convertSOAPToJSONStream(Message m, javax.xml.namespace.QName staringElement, boolean retainNSPrefixes)
m
- the message to be convertedstaringElement
- an optional starting element to begin conversion (e.g. first element of the SOAP body)retainNSPrefixes
- retain the namespace prefixes into JSON names for elements@Deprecated void convertSoapToDOM(Message m)
XMLSupport.convertToDOM(org.adroitlogic.ultraesb.api.Message)
insteadXMLSupport
convertSoapToDOM
in interface XMLSupport
m
- the current message containing a SOAP payload to convert to DOM/POXvoid removeSoapHeader(Message msg, java.lang.String name, java.lang.String uri)
msg
- the current message containing the payloadname
- the local name of the header to be removeduri
- the name space uri of the soap header to be removedvoid addStringAsSoapHeader(Message msg, java.lang.String name, java.lang.String uri, java.lang.String content)
msg
- the current message containing the payloadname
- local name of the new header to be addeduri
- the namespace uri of the soap header to be addedcontent
- content of the new headervoid replaceStringAsSoapHeader(Message msg, java.lang.String name, java.lang.String uri, java.lang.String content)
msg
- the current message containing the payloadname
- name of the header to be deleteduri
- the namespace uri of the soap header to be deletedcontent
- updated content for the SOAP headervoid deleteSoapHeader(Message msg, java.lang.String name, java.lang.String uri)
msg
- the current message containing the payloadname
- name of the header to be deleteduri
- the namespace uri of the soap header to be deletedjava.lang.String getSoapHeaderAsString(Message msg, java.lang.String namespace, java.lang.String name)
msg
- the SOAP messagenamespace
- namespace of the header elementname
- the name of the header elementjava.util.Map getSoapHeadersAsStrings(Message m)
m
- the SOAP messagejava.lang.String getSoapAddressingTo(Message msg)
msg
- message to extract the header fromjava.lang.String getSoapAddressingAction(Message msg)
msg
- message to extract the header fromjava.lang.String getSoapAddressingReplyTo(Message msg)
msg
- message to extract the header fromjava.lang.String getSoapAddressingFaultTo(Message msg)
msg
- message to extract the header fromjava.lang.String getSoapAddressingFrom(Message msg)
msg
- message to extract the header fromjava.lang.String getSoapAddressingMessageID(Message msg)
msg
- message to extract the header fromvoid setPayloadToSOAP11Fault(Message m, java.lang.String code, java.lang.String faultString, java.lang.String detail)
m
- the current messagecode
- Local Name of the fault code - See http://www.w3.org/TR/2000/NOTE-SOAP-20000508/#_Toc478383510
(null will default to "Server")faultString
- fault string, or null (defaults to "General Error")detail
- fault detail, or null (defaults to "Not available")void setPayloadToSOAP12Fault(Message m, java.lang.String code, java.lang.String reason, java.lang.String detail)
m
- the current messagecode
- Local Name of the fault code value - See http://www.w3.org/TR/soap12-part1/#faultcodes
(null will default to "Receiver")reason
- fault reason, or null (defaults to "General Error" if null)detail
- fault detail, or null (defaults to "Not available")java.lang.String getSoapFaultCode(Message msg)
msg
- the message to usejava.lang.String getSoapFaultString(Message msg)
msg
- the message to usejava.lang.String getSoapFaultDetail(Message msg)
msg
- the message to usejava.lang.Object convertSOAPToJAXBObject(Message msg, java.lang.Class clazz)
msg
- the current message to read the payload fromclazz
- the JAXB class to convert the payload intovoid serializeJAXBObjectAsSOAP11Stream(Message msg, java.lang.Object jaxb, java.lang.String rootElement, java.lang.String uri)
msg
- the current message to write the Object into as a SOAP 1.1 streamjaxb
- the JAXB Object to serializerootElement
- root element local name for serializationuri
- namespace uri for the root elementvoid serializeJAXBObjectAsSOAP11Stream(Message msg, java.lang.Object jaxb)
msg
- the current message to write the Object into as a SOAP 1.2 streamjaxb
- the JAXB Object to serializevoid serializeJAXBObjectAsSOAP12Stream(Message msg, java.lang.Object jaxb, java.lang.String rootElement, java.lang.String uri)
msg
- the current message to write the Object into as a SOAP 1.2 streamjaxb
- the JAXB Object to serializerootElement
- root element local name for serializationuri
- namespace uri for the root elementvoid serializeJAXBObjectAsSOAP12Stream(Message msg, java.lang.Object jaxb)
msg
- the current message to write the Object into as a XML streamjaxb
- the JAXB Object to serialize