com.sun.xml.ws.message.stream
Class StreamMessage

java.lang.Object
  extended by com.sun.xml.ws.api.message.Message
      extended by com.sun.xml.ws.message.AbstractMessageImpl
          extended by com.sun.xml.ws.message.stream.StreamMessage

public final class StreamMessage
extends AbstractMessageImpl

Message implementation backed by XMLStreamReader. TODO: we need another message class that keeps XMLStreamReader that points at the start of the envelope element.


Field Summary
 
Fields inherited from class com.sun.xml.ws.message.AbstractMessageImpl
EMPTY_ATTS, NULL_LOCATOR, soapVersion
 
Fields inherited from class com.sun.xml.ws.api.message.Message
attachmentSet
 
Constructor Summary
StreamMessage(HeaderList headers, AttachmentSet attachmentSet, javax.xml.stream.XMLStreamReader reader, SOAPVersion soapVersion)
          Creates a StreamMessage from a XMLStreamReader that points at the start element of the payload, and headers.
StreamMessage(TagInfoset envelopeTag, TagInfoset headerTag, AttachmentSet attachmentSet, HeaderList headers, TagInfoset bodyTag, javax.xml.stream.XMLStreamReader reader, SOAPVersion soapVersion)
          Creates a StreamMessage from a XMLStreamReader and the complete infoset of the SOAP envelope.
 
Method Summary
 void consume()
          Marks the message as consumed, without actually reading the contents.
 Message copy()
          Creates a copy of a Message.
 AttachmentSet getAttachments()
          Gets the attachments of this message (attachments live outside a message.)
 HeaderList getHeaders()
          Gets all the headers of this message.
 String getPayloadLocalPart()
          Gets the local name of the payload element.
 String getPayloadNamespaceURI()
          Gets the namespace URI of the payload element.
 boolean hasHeaders()
          Returns true if headers are present in the message.
 boolean hasPayload()
          Returns true if a Message has a payload.
 javax.xml.stream.XMLStreamReader readPayload()
          Reads the payload as a XMLStreamReader This consumes the message.
<T> T
readPayloadAsJAXB(Bridge<T> bridge)
          Reads the payload as a JAXB object according to the given Bridge.
 Object readPayloadAsJAXB(Unmarshaller unmarshaller)
          Reads the payload as a JAXB object by using the given unmarshaller.
 Source readPayloadAsSource()
          Returns the payload as a Source object.
 void writePayloadTo(ContentHandler contentHandler, ErrorHandler errorHandler, boolean fragment)
          Writes the payload to SAX events.
 void writePayloadTo(javax.xml.stream.XMLStreamWriter writer)
          Writes the payload to StAX.
 void writeTo(ContentHandler contentHandler, ErrorHandler errorHandler)
          Writes the whole envelope as SAX events.
 void writeTo(javax.xml.stream.XMLStreamWriter sw)
          Default implementation that relies on Message.writePayloadTo(XMLStreamWriter)
 
Methods inherited from class com.sun.xml.ws.message.AbstractMessageImpl
readAsSOAPMessage, readAsSOAPMessage, readEnvelopeAsSource
 
Methods inherited from class com.sun.xml.ws.api.message.Message
assertOneWay, getID, getID, getMethod, getOperation, getOperation, hasAttachments, isFault, isOneWay
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StreamMessage

public StreamMessage(@Nullable
                     HeaderList headers,
                     @NotNull
                     AttachmentSet attachmentSet,
                     @NotNull
                     javax.xml.stream.XMLStreamReader reader,
                     @NotNull
                     SOAPVersion soapVersion)
Creates a StreamMessage from a XMLStreamReader that points at the start element of the payload, and headers.

This method creaets a Message from a payload.

Parameters:
headers - if null, it means no headers. if non-null, it will be owned by this message.
reader - points at the start element/document of the payload (or the end element of the <s:Body> if there's no payload)

StreamMessage

public StreamMessage(@NotNull
                     TagInfoset envelopeTag,
                     @Nullable
                     TagInfoset headerTag,
                     @NotNull
                     AttachmentSet attachmentSet,
                     @Nullable
                     HeaderList headers,
                     @NotNull
                     TagInfoset bodyTag,
                     @NotNull
                     javax.xml.stream.XMLStreamReader reader,
                     @NotNull
                     SOAPVersion soapVersion)
Creates a StreamMessage from a XMLStreamReader and the complete infoset of the SOAP envelope.

See StreamMessage(HeaderList, AttachmentSet, XMLStreamReader, SOAPVersion) for the description of the basic parameters.

Parameters:
headerTag - Null if the message didn't have a header tag.
Method Detail

hasHeaders

public boolean hasHeaders()
Description copied from class: Message
Returns true if headers are present in the message.

Specified by:
hasHeaders in class Message
Returns:
true if headers are present.

getHeaders

public HeaderList getHeaders()
Description copied from class: Message
Gets all the headers of this message.

Implementation Note

Message implementation is allowed to defer the construction of HeaderList object. So if you only want to check for the existence of any header element, use Message.hasHeaders().

Specified by:
getHeaders in class Message
Returns:
always return the same non-null object.

getAttachments

@NotNull
public AttachmentSet getAttachments()
Description copied from class: Message
Gets the attachments of this message (attachments live outside a message.)

Overrides:
getAttachments in class Message

getPayloadLocalPart

public String getPayloadLocalPart()
Description copied from class: Message
Gets the local name of the payload element.

Specified by:
getPayloadLocalPart in class Message
Returns:
null if a Message doesn't have any payload.

getPayloadNamespaceURI

public String getPayloadNamespaceURI()
Description copied from class: Message
Gets the namespace URI of the payload element.

Specified by:
getPayloadNamespaceURI in class Message
Returns:
null if a Message doesn't have any payload.

hasPayload

public boolean hasPayload()
Description copied from class: Message
Returns true if a Message has a payload.

A message without a payload is a SOAP message that looks like:


 <S:Envelope>
   <S:Header>
     ...
   </S:Header>
   <S:Body />
 </S:Envelope>
 

Specified by:
hasPayload in class Message

readPayloadAsSource

public Source readPayloadAsSource()
Description copied from class: Message
Returns the payload as a Source object. This consumes the message.

Specified by:
readPayloadAsSource in class Message
Returns:
if there's no payload, this method returns null.

readPayloadAsJAXB

public Object readPayloadAsJAXB(Unmarshaller unmarshaller)
                         throws JAXBException
Description copied from class: Message
Reads the payload as a JAXB object by using the given unmarshaller. This consumes the message.

Overrides:
readPayloadAsJAXB in class AbstractMessageImpl
Throws:
JAXBException - If JAXB reports an error during the processing.

readPayloadAsJAXB

public <T> T readPayloadAsJAXB(Bridge<T> bridge)
                    throws JAXBException
Description copied from class: Message
Reads the payload as a JAXB object according to the given Bridge. This consumes the message.

Overrides:
readPayloadAsJAXB in class AbstractMessageImpl
Returns:
null if there's no payload.
Throws:
JAXBException - If JAXB reports an error during the processing.

consume

public void consume()
Description copied from class: Message
Marks the message as consumed, without actually reading the contents.

This method provides an opportunity for implementations to reuse any reusable resources needed for representing the payload.

Overrides:
consume in class Message

readPayload

public javax.xml.stream.XMLStreamReader readPayload()
Description copied from class: Message
Reads the payload as a XMLStreamReader This consumes the message. The caller is encouraged to call XMLStreamReaderFactory.recycle(XMLStreamReader) when finished using the instance.

Specified by:
readPayload in class Message
Returns:
If there's no payload, this method returns null. Otherwise always non-null valid XMLStreamReader that points to the payload tag name.

writePayloadTo

public void writePayloadTo(javax.xml.stream.XMLStreamWriter writer)
                    throws javax.xml.stream.XMLStreamException
Description copied from class: Message
Writes the payload to StAX. This method writes just the payload of the message to the writer. This consumes the message. The implementation will not write XMLStreamWriter.writeStartDocument() nor XMLStreamWriter.writeEndDocument()

If there's no payload, this method is no-op.

Specified by:
writePayloadTo in class Message
Throws:
javax.xml.stream.XMLStreamException - If the XMLStreamWriter reports an error, or some other errors happen during the processing.

writeTo

public void writeTo(javax.xml.stream.XMLStreamWriter sw)
             throws javax.xml.stream.XMLStreamException
Description copied from class: AbstractMessageImpl
Default implementation that relies on Message.writePayloadTo(XMLStreamWriter)

Overrides:
writeTo in class AbstractMessageImpl
Throws:
javax.xml.stream.XMLStreamException - If the XMLStreamWriter reports an error, or some other errors happen during the processing.

writePayloadTo

public void writePayloadTo(ContentHandler contentHandler,
                           ErrorHandler errorHandler,
                           boolean fragment)
                    throws SAXException
Description copied from class: AbstractMessageImpl
Writes the payload to SAX events.

Specified by:
writePayloadTo in class AbstractMessageImpl
fragment - if true, this method will fire SAX events without start/endDocument events, suitable for embedding this into a bigger SAX event sequence. if false, this method generaets a completely SAX event sequence on its own.
Throws:
SAXException

copy

public Message copy()
Description copied from class: Message
Creates a copy of a Message.

This method creates a new Message whose header/payload/attachments/properties are identical to this Message. Once created, the created Message and the original Message behaves independently --- adding header/ attachment to one Message doesn't affect another Message at all.

This method does NOT consume a message.

To enable efficient copy operations, there's a few restrictions on how copied message can be used.

  1. The original and the copy may not be used concurrently by two threads (this allows two Messages to share some internal resources, such as JAXB marshallers.) Note that it's OK for the original and the copy to be processed by two threads, as long as they are not concurrent.
  2. The copy has the same 'life scope' as the original (this allows shallower copy, such as JAXB beans wrapped in JAXBMessage.)

A 'life scope' of a message created during a message processing in a pipeline is until a pipeline processes the next message. A message cannot be kept beyond its life scope. (This experimental design is to allow message objects to be reused --- feedback appreciated.)

Design Rationale

Since a Message body is read-once, sometimes (such as when you do fail-over, or WS-RM) you need to create an idential copy of a Message.

The actual copy operation depends on the layout of the data in memory, hence it's best to be done by the Message implementation itself.

The restrictions placed on the use of copied Message can be relaxed if necessary, but it will make the copy method more expensive.

Specified by:
copy in class Message

writeTo

public void writeTo(ContentHandler contentHandler,
                    ErrorHandler errorHandler)
             throws SAXException
Description copied from class: AbstractMessageImpl
Writes the whole envelope as SAX events.

Overrides:
writeTo in class AbstractMessageImpl
Parameters:
contentHandler - must not be nulll.
errorHandler - must not be null. any error encountered during the SAX event production must be first reported to this error handler. Fatal errors can be then thrown as SAXParseException. SAXExceptions thrown from ErrorHandler should propagate directly through this method.
Throws:
SAXException