public interface SOAPSupport extends XMLSupport
Modifier and Type | Method and Description |
---|---|
void |
addSoapAction(Message msg,
String action)
Add a SOAPAction transport header to the message
|
void |
addStringAsSoapHeader(Message msg,
String name,
String uri,
String content)
Adds a String as a new SOAP header
|
<T> T |
convertSOAPToJAXBObject(Message msg,
Class<? extends T> 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,
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,
String name,
String uri)
Delete a SOAP header and its descendants
|
String |
getSoapAction(Message msg)
Return the SOAPAction transport header
|
String |
getSoapAddressingAction(Message msg)
Get the WSA Action header
|
String |
getSoapAddressingFaultTo(Message msg)
Get the WSA FaultTo header
|
String |
getSoapAddressingFrom(Message msg)
Get the WSA From header
|
String |
getSoapAddressingMessageID(Message msg)
Get the WSA MessageID header
|
String |
getSoapAddressingReplyTo(Message msg)
Get the WSA ReplyTo header
|
String |
getSoapAddressingTo(Message msg)
Get the WSA To header
|
String |
getSoapFaultCode(Message msg)
Extract the SOAP 1.1 Fault/faultcode or SOAP 1.2 Fault/Code/Value if exists
|
String |
getSoapFaultDetail(Message msg)
Extract the SOAP 1.1 detail or SOAP 1.2 Detail if exists
|
String |
getSoapFaultString(Message msg)
Extract the SOAP 1.1 Fault/faultstring or SOAP 1.2 Reason/Text if exists
|
String |
getSoapHeaderAsString(Message msg,
String namespace,
String name)
Extract the SOAP 1.1/1.2 header value as a String
|
Map<QName,String> |
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,
String name,
String uri)
Removes the specified SOAP header and its descendants if any from the payload
|
void |
replaceStringAsSoapHeader(Message msg,
String name,
String uri,
String content)
Replace String based SOAP header
|
void |
serializeJAXBObjectAsSOAP11Stream(Message msg,
Object jaxb)
Serialize a JAXB Object as a SOAP 1.1 Stream message
|
void |
serializeJAXBObjectAsSOAP11Stream(Message msg,
Object jaxb,
String rootElement,
String uri)
Serialize a JAXB Object as a SOAP 1.1 Stream message
|
void |
serializeJAXBObjectAsSOAP12Stream(Message msg,
Object jaxb)
Serialize a JAXB Object as a SOAP 1.2 Stream message
|
void |
serializeJAXBObjectAsSOAP12Stream(Message msg,
Object jaxb,
String rootElement,
String uri)
Serialize a JAXB Object as a SOAP 1.2 Stream message
|
void |
setPayloadToSOAP11Fault(Message m,
String code,
String faultString,
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,
String code,
String reason,
String detail)
Set the payload of the current message to a SOAP 1.2 fault message with the given code, reason and detail
|
addAttributeToElements, addElementsAsChild, addTextElementsAsChild, aggregateWithBean, convertDOMToSoap11, convertDOMToSoap12, convertFromFI, convertSoapToDOM, convertToDOM, convertToFI, convertXMLToJAXBObject, convertXMLToJAXBObject, convertXMLToJSONStream, convertXMLToJSONStream, createDOMDocument, deleteAttributes, deleteElements, extractAsNodeListUsingXPath, extractAsNodeListUsingXPath, extractAsStringUsingXPath, extractAsStringUsingXPath, extractAsStringUsingXPath, filter, filter, getAttribute, getPayloadAsDOM, getTextElement, insertTextElementsAfter, insertTextElementsBefore, mergeXMLAttachmentsUnderElement, mergeXMLAttachmentsUnderElement, remove, replaceAttributes, replaceTextElements, retainElementAsPayload, serializeJAXBObjectAsXMLStream, serializeJAXBObjectAsXMLStream, serializeJAXBObjectAsXMLStream, serializeJAXBObjectAsXMLStream, setPayloadFromDOM, splitAndProcess, splitWithBean, transform, transform, transform, validate, validate, validate, validate, validateAll, 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 detectString getSoapAction(Message msg)
msg
- message to extract the header fromvoid addSoapAction(Message msg, String action)
msg
- message to add the SOAPAction headeraction
- the value of the SOAPAction header to be addedvoid convertSOAPToJSONStream(Message m)
m
- the message to be convertedvoid convertSOAPToJSONStream(Message m, 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 elementsvoid removeSoapHeader(Message msg, String name, 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, String name, String uri, 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, String name, String uri, 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, String name, 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 deletedString getSoapHeaderAsString(Message msg, String namespace, String name)
msg
- the SOAP messagenamespace
- namespace of the header elementname
- the name of the header elementMap<QName,String> getSoapHeadersAsStrings(Message m)
m
- the SOAP messageString getSoapAddressingTo(Message msg)
msg
- message to extract the header fromString getSoapAddressingAction(Message msg)
msg
- message to extract the header fromString getSoapAddressingReplyTo(Message msg)
msg
- message to extract the header fromString getSoapAddressingFaultTo(Message msg)
msg
- message to extract the header fromString getSoapAddressingFrom(Message msg)
msg
- message to extract the header fromString getSoapAddressingMessageID(Message msg)
msg
- message to extract the header fromvoid setPayloadToSOAP11Fault(Message m, String code, String faultString, 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, String code, String reason, 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")String getSoapFaultCode(Message msg)
msg
- the message to useString getSoapFaultString(Message msg)
msg
- the message to useString getSoapFaultDetail(Message msg)
msg
- the message to use<T> T convertSOAPToJAXBObject(Message msg, Class<? extends T> clazz)
msg
- the current message to read the payload fromclazz
- the JAXB class to convert the payload intovoid serializeJAXBObjectAsSOAP11Stream(Message msg, Object jaxb, String rootElement, 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, 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, Object jaxb, String rootElement, 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 elementCopyright © 2010–2016 AdroitLogic. All rights reserved.