public interface LogicalMessage
LogicalMessage
interface represents a
protocol agnostic XML message and contains methods that
provide access to the payload of the message.Modifier and Type | Method and Description |
---|---|
javax.xml.transform.Source |
getPayload()
Gets the message payload as an XML source, may be called
multiple times on the same LogicalMessage instance, always
returns a new
Source that may be used to retrieve the entire
message payload. |
java.lang.Object |
getPayload(JAXBContext context)
Gets the message payload as a Jakarta XML Binding object.
|
void |
setPayload(java.lang.Object payload,
JAXBContext context)
Sets the message payload
|
void |
setPayload(javax.xml.transform.Source payload)
Sets the message payload
|
javax.xml.transform.Source getPayload()
Source
that may be used to retrieve the entire
message payload.
If the returned Source
is an instance of
DOMSource
, then
modifications to the encapsulated DOM tree change the message
payload in-place, there is no need to susequently call
setPayload
. Other types of Source
provide only
read access to the message payload.
null
if no
payload is present in this message.void setPayload(javax.xml.transform.Source payload)
payload
- message payloadWebServiceException
- If any error during the setting
of the payload in this messagejava.lang.UnsupportedOperationException
- If this
operation is not supportedjava.lang.Object getPayload(JAXBContext context)
setPayload
.context
- The JAXBContext that should be used to unmarshall
the message payloadnull
if no
payload is present in this messageWebServiceException
- If an error occurs when using a supplied
JAXBContext to unmarshall the payload. The cause of
the WebServiceException is the original JAXBException.void setPayload(java.lang.Object payload, JAXBContext context)
payload
- message payloadcontext
- The JAXBContext that should be used to marshall
the payloadjava.lang.UnsupportedOperationException
- If this
operation is not supportedWebServiceException
- If an error occurs when using the supplied
JAXBContext to marshall the payload. The cause of
the WebServiceException is the original JAXBException.