Module com.sun.xml.ws

Package com.sun.xml.ws.encoding.xml

Class XMLMessage.XMLMultiPart

java.lang.Object

com.sun.xml.ws.api.message.Message

com.sun.xml.ws.message.AbstractMessageImpl

com.sun.xml.ws.encoding.xml.XMLMessage.XMLMultiPart

All Implemented Interfaces:

XMLMessage.MessageDataSource

Enclosing class:

XMLMessage

public static final class XMLMessage.XMLMultiPart
extends AbstractMessageImpl
implements XMLMessage.MessageDataSource

Data represented as a multi-part MIME message.

The root part may be an XML or an FI document. This class parses MIME message lazily.

Field Summary

Fields inherited from class com.sun.xml.ws.message.AbstractMessageImpl

bodyTag, DEFAULT_TAGS, EMPTY_ATTS, envelopeTag, headerTag, NULL_LOCATOR, soapVersion

Fields inherited from class com.sun.xml.ws.api.message.Message

attachmentSet

Constructor Summary

Constructors

Constructor	Description
XMLMultiPart(String contentType, InputStream is, WSFeatureList f)

Method Summary

Modifier and Type	Method	Description
Message	copy()	Creates a copy of a Message.
AttachmentSet	getAttachments()	Gets the attachments of this message (attachments live outside a message.)
DataSource	getDataSource()	Get the data source.
MessageHeaders	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.
boolean	hasUnconsumedDataSource()	Check if the data source has been consumed.
boolean	isFault()	Returns true if this message is a fault.
boolean	isOneWay(WSDLPort port)	Returns true if this message is a request message for a one way operation according to the given WSDL.
SOAPMessage	readAsSOAPMessage()	Default implementation that uses AbstractMessageImpl.writeTo(ContentHandler, ErrorHandler)
SOAPMessage	readAsSOAPMessage(Packet packet, boolean inbound)	Creates the equivalent SOAPMessage from this message.
Source	readEnvelopeAsSource()	Consumes this message including the envelope.
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(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(XMLStreamWriter sw)	Writes the payload to StAX.
protected void	writePayloadTo(ContentHandler contentHandler, ErrorHandler errorHandler, boolean fragment)	Writes the payload to SAX events.
void	writeTo(XMLStreamWriter sw)	Default implementation that relies on Message.writePayloadTo(XMLStreamWriter)
void	writeTo(ContentHandler contentHandler, ErrorHandler errorHandler)	Writes the whole envelope as SAX events.

Methods inherited from class com.sun.xml.ws.message.AbstractMessageImpl

getSOAPVersion, readPayloadAsJAXB, toSAAJ, writeToBodyStart

Methods inherited from class com.sun.xml.ws.api.message.Message

addSOAPMimeHeaders, assertOneWay, consume, copyFrom, generateMessageID, getFirstDetailEntryName, getID, getID, getMethod, getOperation, getOperation, getTransportHeaders, getTransportHeaders, hasAttachments, setMessageMedadata

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLMultiPart

public XMLMultiPart(String contentType,
                    InputStream is,
                    WSFeatureList f)

Method Detail

hasUnconsumedDataSource

public boolean hasUnconsumedDataSource()

Description copied from interface: XMLMessage.MessageDataSource

Check if the data source has been consumed.

Specified by:

hasUnconsumedDataSource in interface XMLMessage.MessageDataSource

Returns:

true of the data source has been consumed, otherwise false.

getDataSource

public DataSource getDataSource()

Description copied from interface: XMLMessage.MessageDataSource

Get the data source.

Specified by:

getDataSource in interface XMLMessage.MessageDataSource

Returns:

the data source.

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

@NotNull
public MessageHeaders getHeaders()

Description copied from class: Message

Gets all the headers of this message.

Implementation Note

Message implementation is allowed to defer the construction of MessageHeaders 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.

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

isFault

public boolean isFault()

Description copied from class: Message

Returns true if this message is a fault.

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

Overrides:

isFault in class Message

readEnvelopeAsSource

public Source readEnvelopeAsSource()

Description copied from class: Message

Consumes this message including the envelope. returns it as a Source object.

Overrides:

readEnvelopeAsSource in class AbstractMessageImpl

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.

readAsSOAPMessage

public SOAPMessage readAsSOAPMessage()
                              throws SOAPException

Description copied from class: AbstractMessageImpl

Default implementation that uses AbstractMessageImpl.writeTo(ContentHandler, ErrorHandler)

Overrides:

readAsSOAPMessage in class AbstractMessageImpl

Throws:

SOAPException - if there's any error while creating a SOAPMessage.

readAsSOAPMessage

public SOAPMessage readAsSOAPMessage(Packet packet,
                                     boolean inbound)
                              throws SOAPException

Description copied from class: Message

Creates the equivalent SOAPMessage from this message. It also uses transport specific headers from Packet during the SOAPMessage construction so that SOAPMessage.getMimeHeaders() gives meaningful transport headers. This consumes the message.

Overrides:

readAsSOAPMessage in class AbstractMessageImpl

Throws:

SOAPException - if there's any error while creating a SOAPMessage.

readPayloadAsJAXB

public <T> T 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(com.sun.xml.bind.api.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.

readPayload

public XMLStreamReader readPayload()
                            throws XMLStreamException

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.

Throws:

XMLStreamException

writePayloadTo

public void writePayloadTo(XMLStreamWriter sw)
                    throws 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:

XMLStreamException - If the XMLStreamWriter reports an error, or some other errors happen during the processing.

writeTo

public void writeTo(XMLStreamWriter sw)
             throws XMLStreamException

Description copied from class: AbstractMessageImpl

Default implementation that relies on Message.writePayloadTo(XMLStreamWriter)

Overrides:

writeTo in class AbstractMessageImpl

Throws:

XMLStreamException - If the XMLStreamWriter reports an error, or some other errors happen during the processing.

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

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.

IMPORTANT

WHEN YOU IMPLEMENT OR CHANGE A {@link .copy()} METHOD, YOU MUST USE THE Message.copyFrom(com.sun.xml.ws.api.message.Message) METHOD IN THE IMPLEMENTATION.

Specified by:

copy in class Message

writePayloadTo

protected 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

isOneWay

public boolean isOneWay(@NotNull
                        WSDLPort port)

Description copied from class: Message

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

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