This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.xml.ws
interface LogicalMessage


Most common way to construct:

LogicalMessageContext context = …;

LogicalMessage lm = context.getMessage();

Based on 19 examples


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

          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

          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

getPayload

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

getPayload

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 - The JAXBContext that should be used to unmarshall the message payload
Returns:
The contained message payload; returns null if no payload is present in this message

setPayload

public 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

setPayload

public void setPayload(Source payload)
Sets the message payload

Parameters:
payload - message payload


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.