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

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

public class LazyStreamBasedMessage
extends com.sun.xml.ws.api.message.Message


Field Summary
protected static java.util.logging.Logger logger
           
 
Fields inherited from class com.sun.xml.ws.api.message.Message
attachmentSet
 
Constructor Summary
LazyStreamBasedMessage(javax.xml.stream.XMLStreamReader message, com.sun.xml.ws.api.pipe.StreamSOAPCodec codec)
          Creates a new instance of StreamMessage
LazyStreamBasedMessage(javax.xml.stream.XMLStreamReader message, com.sun.xml.ws.api.pipe.StreamSOAPCodec codec, com.sun.xml.ws.api.message.AttachmentSet as)
           
 
Method Summary
 com.sun.xml.ws.api.message.Message copy()
          Creates a copy of a Message.
 com.sun.xml.ws.api.message.AttachmentSet getAttachments()
          Gets the attachments of this message (attachments live outside a message.)
 com.sun.xml.ws.api.pipe.StreamSOAPCodec getCodec()
           
 com.sun.xml.ws.api.message.HeaderList getHeaders()
          Gets all the headers of this message.
 java.lang.String getPayloadLocalPart()
          Gets the local name of the payload element.
 java.lang.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.
 boolean isFault()
          Returns true if this message is a fault.
 boolean isOneWay(com.sun.xml.ws.api.model.wsdl.WSDLPort port)
          Returns true if this message is a request message for a one way operation according to the given WSDL.
 void print()
           
 javax.xml.soap.SOAPMessage readAsSOAPMessage()
          Creates the equivalent SOAPMessage from this message.
 javax.xml.transform.Source readEnvelopeAsSource()
          Consumes this message including the envelope.
 javax.xml.stream.XMLStreamReader readMessage()
           
 javax.xml.stream.XMLStreamReader readPayload()
          Reads the payload as a XMLStreamReader This consumes the message.
<T> T
readPayloadAsJAXB(com.sun.xml.bind.api.Bridge<T> bridge)
          Reads the payload as a JAXB object according to the given Bridge.
<T> T
readPayloadAsJAXB(javax.xml.bind.Unmarshaller unmarshaller)
          Reads the payload as a JAXB object by using the given unmarshaller.
 javax.xml.transform.Source readPayloadAsSource()
          Returns the payload as a Source object.
 void writePayloadTo(javax.xml.stream.XMLStreamWriter sw)
          Writes the payload to StAX.
 void writeTo(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ErrorHandler errorHandler)
          Writes the whole SOAP envelope as SAX events.
 void writeTo(javax.xml.stream.XMLStreamWriter sw)
          Writes the whole SOAP message (but not attachments) to the given writer.
 
Methods inherited from class com.sun.xml.ws.api.message.Message
assertOneWay, consume, getFirstDetailEntryName, getID, getID, getMethod, getOperation, getOperation, hasAttachments, readAsSOAPMessage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected static final java.util.logging.Logger logger
Constructor Detail

LazyStreamBasedMessage

public LazyStreamBasedMessage(javax.xml.stream.XMLStreamReader message,
                              com.sun.xml.ws.api.pipe.StreamSOAPCodec codec)
Creates a new instance of StreamMessage


LazyStreamBasedMessage

public LazyStreamBasedMessage(javax.xml.stream.XMLStreamReader message,
                              com.sun.xml.ws.api.pipe.StreamSOAPCodec codec,
                              com.sun.xml.ws.api.message.AttachmentSet as)
Method Detail

getCodec

public com.sun.xml.ws.api.pipe.StreamSOAPCodec getCodec()

hasHeaders

public boolean hasHeaders()
Returns true if headers are present in the message.

Specified by:
hasHeaders in class com.sun.xml.ws.api.message.Message
Returns:
true if headers are present.

getHeaders

public com.sun.xml.ws.api.message.HeaderList getHeaders()
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 hasHeaders().

Specified by:
getHeaders in class com.sun.xml.ws.api.message.Message
Returns:
always return the same non-null object.

getAttachments

@NotNull
public com.sun.xml.ws.api.message.AttachmentSet getAttachments()
Gets the attachments of this message (attachments live outside a message.)

Overrides:
getAttachments in class com.sun.xml.ws.api.message.Message

isOneWay

public boolean isOneWay(@NotNull
                        com.sun.xml.ws.api.model.wsdl.WSDLPort port)
Returns true if this message is a request message for a one way operation according to the given WSDL. False otherwise.

This method is functionally equivalent as doing getOperation(port).getOperation().isOneWay() (with proper null check and all.) But this method can sometimes work faster than that (for example, on the client side when used with SEI.)

Overrides:
isOneWay in class com.sun.xml.ws.api.message.Message
Parameters:
port - Messages are always created under the context of one WSDLPort and they never go outside that context. Pass in that "governing" WSDLPort object here. We chose to receive this as a parameter instead of keeping WSDLPort in a message, just to save the storage.

The implementation of this method involves caching the return value, so the behavior is undefined if multiple callers provide different WSDLPort objects, which is a bug of the caller.


getPayloadLocalPart

@Nullable
public java.lang.String getPayloadLocalPart()
Gets the local name of the payload element.

Specified by:
getPayloadLocalPart in class com.sun.xml.ws.api.message.Message
Returns:
null if a Message doesn't have any payload.

getPayloadNamespaceURI

public java.lang.String getPayloadNamespaceURI()
Gets the namespace URI of the payload element.

Specified by:
getPayloadNamespaceURI in class com.sun.xml.ws.api.message.Message
Returns:
null if a Message doesn't have any payload.

hasPayload

public boolean hasPayload()
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 com.sun.xml.ws.api.message.Message

isFault

public boolean isFault()
Returns true if this message is a fault.

Just a convenience method built on getPayloadNamespaceURI() and getPayloadLocalPart().

Overrides:
isFault in class com.sun.xml.ws.api.message.Message

readEnvelopeAsSource

public javax.xml.transform.Source readEnvelopeAsSource()
Consumes this message including the envelope. returns it as a Source object.

Specified by:
readEnvelopeAsSource in class com.sun.xml.ws.api.message.Message

readPayloadAsSource

public javax.xml.transform.Source readPayloadAsSource()
Returns the payload as a Source object. This consumes the message.

Specified by:
readPayloadAsSource in class com.sun.xml.ws.api.message.Message
Returns:
if there's no payload, this method returns null.

readAsSOAPMessage

public javax.xml.soap.SOAPMessage readAsSOAPMessage()
                                             throws javax.xml.soap.SOAPException
Creates the equivalent SOAPMessage from this message. This consumes the message.

Specified by:
readAsSOAPMessage in class com.sun.xml.ws.api.message.Message
Throws:
javax.xml.soap.SOAPException - if there's any error while creating a SOAPMessage.

readPayloadAsJAXB

public <T> T readPayloadAsJAXB(javax.xml.bind.Unmarshaller unmarshaller)
                    throws javax.xml.bind.JAXBException
Reads the payload as a JAXB object by using the given unmarshaller. This consumes the message.

Specified by:
readPayloadAsJAXB in class com.sun.xml.ws.api.message.Message
Throws:
javax.xml.bind.JAXBException - If JAXB reports an error during the processing.

readPayloadAsJAXB

public <T> T readPayloadAsJAXB(com.sun.xml.bind.api.Bridge<T> bridge)
                    throws javax.xml.bind.JAXBException
Reads the payload as a JAXB object according to the given Bridge. This consumes the message.

Specified by:
readPayloadAsJAXB in class com.sun.xml.ws.api.message.Message
Throws:
javax.xml.bind.JAXBException - If JAXB reports an error during the processing.

readPayload

public javax.xml.stream.XMLStreamReader readPayload()
                                             throws javax.xml.stream.XMLStreamException
Reads the payload as a XMLStreamReader This consumes the message.

Specified by:
readPayload in class com.sun.xml.ws.api.message.Message
Returns:
If there's no payload, this method returns null. Otherwise always non-null valid XMLStreamReader that points to the payload tag name.
Throws:
javax.xml.stream.XMLStreamException

writePayloadTo

public void writePayloadTo(javax.xml.stream.XMLStreamWriter sw)
                    throws javax.xml.stream.XMLStreamException
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 com.sun.xml.ws.api.message.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
Writes the whole SOAP message (but not attachments) to the given writer. This consumes the message.

Specified by:
writeTo in class com.sun.xml.ws.api.message.Message
Throws:
javax.xml.stream.XMLStreamException - If the XMLStreamWriter reports an error, or some other errors happen during the processing.

writeTo

public void writeTo(org.xml.sax.ContentHandler contentHandler,
                    org.xml.sax.ErrorHandler errorHandler)
             throws org.xml.sax.SAXException
Writes the whole SOAP envelope as SAX events.

This consumes the message.

Specified by:
writeTo in class com.sun.xml.ws.api.message.Message
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:
org.xml.sax.SAXException

copy

public com.sun.xml.ws.api.message.Message copy()
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 com.sun.xml.ws.api.message.Message

readMessage

public javax.xml.stream.XMLStreamReader readMessage()

print

public void print()
           throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException