javax.xml.ws
Interface LogicalMessage
-
public interface LogicalMessageTheLogicalMessageinterface represents a protocol agnostic XML message and contains methods that provide access to the payload of the message.- Since:
- JAX-WS 2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description SourcegetPayload()Gets the message payload as an XML source, may be called multiple times on the same LogicalMessage instance, always returns a newSourcethat may be used to retrieve the entire message payload.ObjectgetPayload(JAXBContext context)Gets the message payload as a JAXB object.voidsetPayload(Object payload, JAXBContext context)Sets the message payloadvoidsetPayload(Source payload)Sets the message payload
-
-
-
Method Detail
getPayload
Source getPayload()
Gets the message payload as an XML source, may be called multiple times on the same LogicalMessage instance, always returns a newSourcethat may be used to retrieve the entire message payload.If the returned
Sourceis an instance ofDOMSource, then modifications to the encapsulated DOM tree change the message payload in-place, there is no need to susequently callsetPayload. Other types ofSourceprovide only read access to the message payload.- Returns:
-
The contained message payload; returns
nullif no payload is present in this message.
setPayload
void setPayload(Source payload)
Sets the message payload- Parameters:
-
payload- message payload - Throws:
-
WebServiceException- If any error during the setting of the payload in this message -
UnsupportedOperationException- If this operation is not supported
getPayload
Object getPayload(JAXBContext context)
Gets the message payload as a JAXB object. Note that there is no connection between the returned object and the message payload, changes to the payload require callingsetPayload.- Parameters:
-
context- The JAXBContext that should be used to unmarshall the message payload - Returns:
-
The contained message payload; returns
nullif no payload is present in this message - Throws:
-
WebServiceException- If an error occurs when using a supplied JAXBContext to unmarshall the payload. The cause of the WebServiceException is the original JAXBException.
setPayload
void setPayload(Object payload, JAXBContext context)
Sets the message payload- Parameters:
-
payload- message payload -
context- The JAXBContext that should be used to marshall the payload - Throws:
-
UnsupportedOperationException- If this operation is not supported -
WebServiceException- If an error occurs when using the supplied JAXBContext to marshall the payload. The cause of the WebServiceException is the original JAXBException.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
