|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface LogicalMessage
The LogicalMessage interface represents a
protocol agnostic XML message and contains methods that
provide access to the payload of the message.
| Method Summary | |
|---|---|
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. |
Object |
getPayload(JAXBContext context)
Gets the message payload as a JAXB object. |
void |
setPayload(Object payload,
JAXBContext context)
Sets the message payload |
void |
setPayload(Source payload)
Sets the message payload |
| Method Detail |
|---|
Source getPayload()
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.
void setPayload(Source payload)
payload - message payload
WebServiceException - If any error during the setting
of the payload in this message
UnsupportedOperationException - If this
operation is not supportedObject getPayload(JAXBContext context)
setPayload.
context - The JAXBContext that should be used to unmarshall
the message payload
WebServiceException - If an error occurs when using a supplied
JAXBContext to unmarshall the payload. The cause of
the WebServiceException is the original JAXBException.
void setPayload(Object payload,
JAXBContext context)
payload - message payloadcontext - The JAXBContext that should be used to marshall
the payload
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.
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved.