FileDocCategorySizeDatePackage
LogicalMessage.javaAPI DocJava SE 6 API2805Tue Jun 10 00:27:16 BST 2008javax.xml.ws

LogicalMessage

public interface LogicalMessage
The LogicalMessage interface represents a protocol agnostic XML message and contains methods that provide access to the payload of the message.
since
JAX-WS 2.0

Fields Summary
Constructors Summary
Methods Summary
public javax.xml.transform.SourcegetPayload()
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.

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.

return
The contained message payload; returns null if no payload is present in this message.

public java.lang.ObjectgetPayload(javax.xml.bind.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 calling setPayload.

param
context The JAXBContext that should be used to unmarshall the message payload
return
The contained message payload; returns null if 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.

public voidsetPayload(javax.xml.transform.Source payload)
Sets the message payload

param
payload message payload
throws
WebServiceException If any error during the setting of the payload in this message
throws
java.lang.UnsupportedOperationException If this operation is not supported

public voidsetPayload(java.lang.Object payload, javax.xml.bind.JAXBContext context)
Sets the message payload

param
payload message payload
param
context The JAXBContext that should be used to marshall the payload
throws
java.lang.UnsupportedOperationException If this operation is not supported
throws
WebServiceException If an error occurs when using the supplied JAXBContext to marshall the payload. The cause of the WebServiceException is the original JAXBException.