payload factory feature

Soap Feature

Soap Feature can be used to manipulate SOAP messages as required. SOAP Feature provides a rich api that can be used to acquire SOAP headers, manipulate SOAP headers, convert to JSON format, convert to JAXB format and to provide WSDL support.

APIs Java Docs

isSOAP
Parameters
boolean flag

Indicates whether the message detection should be done only using the content-type

XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP type needs to be detected

Returns
boolean result

True if a SOAP message format has been detected.

True if a SOAP message format has been detected. The API call returns true if the message is SOAP version 1.1 or SOAP version 1.2. The flag can be used to perform an optimization where SOAP messages are detected only using only the content type without checking for the namespace URI.

isSOAP11
Parameters
boolean flag

Indicates whether the message detection should be done only using the content-type

XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP version needs to be verified to be 1.1

Returns
boolean result

True if SOAP message version 1.1 has been detected.

True if a SOAP message version 1.1 has been detected. The function call checks whether a SOAP action is present. The flag can be used to perform an optimization where SOAP messages are detected only using only the content type without checking for the namespace URI.

isSOAP12
Parameters
boolean flag

Indicates whether the message detection should be done only using the content-type

XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP version needs to be verified to be 1.2

Returns
boolean result

True if a SOAP message format has been detected.

True if a SOAP message format has been detected. The API call returns true if the message is SOAP version 1.1 or SOAP version 1.2. The flag can be used to perform an optimization where SOAP messages are detected only using only the content type without checking for the namespace URI.

getSOAPAction
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP action transport header needs to be acquired

Returns
String action

SOAP action transport header is returned.

Returns the SOAP action transport header.

setSOAPAction
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP action transport header needs to be set

String action

String action that needs to be set to the message

Sets the string action to the transport header of the SOAP message which is of type org.adroitlogic.x.api.XMessage

convertSOAPToJSONStream
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object which needs to be converted

Converts the SOAP message which is of type XMessage to a JSON stream

convertSOAPToJSONStream
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object which needs to be converted

QName qName

The starting element to begin conversion

boolean retainNameSpacePrefixes

Indicates whether namespace prefixes need to be retained into JSON elements for names

Converts the SOAP message which is of type XMessage to a JSON stream staring from a specified element.

Note that the namespaces can be retained if needed by specifying the retainNamesSpacePrefixes variable.

removeSOAPHeader
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP header needs to be removed

String name

The name of the local header to be removed

String uri

The namespace of the SOAP header to be removed

Removes the specified SOAP header and its descendants from the payload.

addStringAsSOAPHeader
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP header needs to be added

String name

The localname of the header to be added

String uri

The namespace uri of the header to be added

String content

Content of the new header

Adds the specified String as a SOAP header

replaceStringAsSOAPHeader
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP header needs to be replaced

String name

The localname of the header to be replaced

String uri

The namespace uri of the header to be replaced

String content

Updated content for the SOAP header

Replaces the specified String in the SOAP header.

deleteSOAPHeader
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP header needs to be deleted

String name

The localname of the header to be deleted

String uri

The namespace uri of the header to be deleted

Deletes a specified SOAP header and its descendants.

getSOAPHeaderAsString
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP header needs to be read

String namespace

The namespace of the header element

String name

The localname of the header to be read

Returns
String header

The String value of the header

Returns the String value of the header

getSOAPHeaderAsMap
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP header needs to be read

Returns
String header

a Map of QNames and Strings of the text value

Returns a Map of QNames and Strings of the text value

getSOAPAddressingTo
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP addressing needs to be acquired

Returns
String header

The header value

Returns the header value

getSOAPAddressingAction
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP addressing needs to be acquired

Returns
String header

The action header value

Returns the action header value

getSOAPAddressingReplyTo
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP addressing needs to be acquired

Returns
String replyTo

The reply to header value

Returns the reply to header value

getSOAPAddressingFaultTo
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP addressing needs to be acquired

Returns
String faultTo

The fault to header value

Returns the fault to header value

getSOAPAddressingFrom
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP addressing needs to be acquired

Returns
String from

The from header value

Returns the from header value

getSOAPAddressingMessageID
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object of which the SOAP addressing needs to be acquired

Returns
String header

The MessageID value

Returns the messageID value

validateSOAPAgainstWSDL
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object which needs be verified against the WSDL

Returns
boolean result

True if the validation is successful

Returns the header value

setPayloadToSOAP12Fault
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object

String code

Local Name of the fault code - See http://www.w3.org/TR/2000/NOTE-SOAP-20000508/#_Toc478383510

  • (null will default to "Server")

String faultString

fault string, or null (defaults to "General Error")

String faultDetails

fault detail, or null (defaults to "Not available")

Set the payload of the current message to a SOAP 1.2 fault message with a given code, faultString and faultDetails

getSOAPFaultCode
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object

Returns
String faultCode

The faultcode if it exists

Returns the faultCode if it exists

getSOAPFaultString
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object

Returns
String faultCode

Extract the SOAP 1.1 Fault Message or SOAP 1.2 Fault/Code/Value if exists

Extract the SOAP 1.1 Fault Message or SOAP 1.2 Fault/Code/Value if exists

getSOAPFaultDetails
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object

Returns
String faultCode

The fault message details if it exists

Extract SOAP message fault details if it exists.

convertSOAPToJAXBObject
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object

Class clazz

The JAXB class to convert the payload into

Returns
String faultCode

Serialize a JAXB Object as a SOAP 1.1 Stream message

Serialize a JAXB Object as a SOAP 1.1 Stream message

serializeJAXBObjectAsSOAP11Stream
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object

Object jaxb

the JAXB Object to serialize

String rootElement

root element local name for serialization

String uri

namespace uri for the root element

Returns
String faultCode

Serialize a JAXB Object as a SOAP 1.1 Stream message

Serialize a JAXB Object as a SOAP 1.1 Stream message

serializeJAXBObjectAsSOAP11Stream
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object

Object jaxb

the JAXB Object to serialize

Returns
:: Serialize a JAXB Object as a SOAP 1.1 Stream message

Serialize a JAXB Object as a SOAP 1.1 Stream message

serializeJAXBObjectAsSOAP12Stream
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object

Object jaxb

the JAXB Object to serialize

String rootElement

root element local name for serialization

String uri

namespace uri for the root element

Returns
String faultCode

Serialize a JAXB Object as a SOAP 1.2 Stream message

Serialize a JAXB Object as a SOAP 1.2 Stream message

serializeJAXBObjectAsSOAP12Stream
Parameters
XMessage m

The org.adroitlogic.x.api.XMessage object

Object jaxb

the JAXB Object to serialize

Returns
:: Serialize a JAXB Object as a SOAP 1.2 Stream message

Serialize a JAXB Object as a SOAP 1.2 Stream message
In this topic
In this topic
(c) Copyright 2016-2017 AdroitLogic. All rights reserved.
Terms of Use
Contact Us