Top Description Methods
javax.xml.ws

public Interface LogicalMessage

Imports
javax.xml.transform.Source, javax.xml.bind.JAXBContext
The LogicalMessage interface represents a protocol agnostic XML message and contains methods that provide access to the payload of the message.
Since
1.6, JAX-WS 2.0

Method Summary

Modifier and TypeMethod and Description
public Source

Returns:

The contained message payload; returns null if no payload is present in this message.
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.

public Object

Returns:

The contained message payload; returns null if no payload is present in this message
getPayload(JAXBContext
The JAXBContext that should be used to unmarshall the message payload
context)

Gets the message payload as a JAXB object.

public void
setPayload(Source
message payload
payload)

Sets the message payload

public void
setPayload(Object
message payload
payload, JAXBContext
The JAXBContext that should be used to marshall the payload
context)

Sets the message payload

Method Detail

getPayloadback to summary
public 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.

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.

Returns:Source

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

getPayloadback to summary
public 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 calling setPayload.

Parameters
context:JAXBContext

The JAXBContext that should be used to unmarshall the message payload

Returns:Object

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

Exceptions
WebServiceException:
If an error occurs when using a supplied JAXBContext to unmarshall the payload. The cause of the WebServiceException is the original JAXBException.
setPayloadback to summary
public void setPayload(Source payload)

Sets the message payload

Parameters
payload:Source

message payload

Exceptions
WebServiceException:
If any error during the setting of the payload in this message
UnsupportedOperationException:
If this operation is not supported
setPayloadback to summary
public void setPayload(Object payload, JAXBContext context)

Sets the message payload

Parameters
payload:Object

message payload

context:JAXBContext

The JAXBContext that should be used to marshall the payload

Exceptions
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.