Module com.sun.xml.ws

Package com.sun.xml.ws.message

Class AbstractMessageImpl

java.lang.Object

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

com.sun.xml.ws.message.AbstractMessageImpl

Direct Known Subclasses:

DOMMessage, EmptyMessageImpl, JAXBDispatchMessage, JAXBMessage, PayloadStreamReaderMessage, StreamMessage, XMLMessage.UnknownContent, XMLMessage.XMLMultiPart

public abstract class AbstractMessageImpl
extends Message

Partial Message implementation.

This class implements some of the Message methods. The idea is that those implementations may be non-optimal but it may save effort in implementing Message and reduce the code size.

Message classes that are used more commonly should examine carefully which method can be implemented faster, and override them accordingly.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
protected TagInfoset	bodyTag
protected static List<TagInfoset>	DEFAULT_TAGS
protected static AttributesImpl	EMPTY_ATTS
protected TagInfoset	envelopeTag
protected TagInfoset	headerTag
protected static LocatorImpl	NULL_LOCATOR
protected SOAPVersion	soapVersion	SOAP version of this message.

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

attachmentSet

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMessageImpl(SOAPVersion soapVersion)
protected	AbstractMessageImpl(AbstractMessageImpl that)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
SOAPVersion	getSOAPVersion()
SOAPMessage	readAsSOAPMessage()	Default implementation that uses writeTo(ContentHandler, ErrorHandler)
SOAPMessage	readAsSOAPMessage(Packet packet, boolean inbound)	Creates the equivalent SOAPMessage from this message.
Source	readEnvelopeAsSource()	Consumes this message including the envelope.
<T> T	readPayloadAsJAXB(com.sun.xml.bind.api.Bridge<T> bridge)	Deprecated.
<T> T	readPayloadAsJAXB(XMLBridge<T> bridge)	Reads the payload as a Data-Bond object This consumes the message.
<T> T	readPayloadAsJAXB(Unmarshaller unmarshaller)	Reads the payload as a JAXB object by using the given unmarshaller.
Message	toSAAJ(Packet p, Boolean inbound)
protected abstract void	writePayloadTo(ContentHandler contentHandler, ErrorHandler errorHandler, boolean fragment)	Writes the payload to SAX events.
void	writeTo(XMLStreamWriter w)	Default implementation that relies on Message.writePayloadTo(XMLStreamWriter)
void	writeTo(ContentHandler contentHandler, ErrorHandler errorHandler)	Writes the whole envelope as SAX events.
void	writeToBodyStart(XMLStreamWriter w)

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

addSOAPMimeHeaders, assertOneWay, consume, copy, copyFrom, generateMessageID, getAttachments, getFirstDetailEntryName, getHeaders, getID, getID, getMethod, getOperation, getOperation, getPayloadLocalPart, getPayloadNamespaceURI, getTransportHeaders, getTransportHeaders, hasAttachments, hasHeaders, hasPayload, isFault, isOneWay, readPayload, readPayloadAsSource, setMessageMedadata, writePayloadTo

Methods inherited from class java.lang.Object

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

Field Detail

soapVersion

protected final SOAPVersion soapVersion

SOAP version of this message. Used to implement some of the methods, but nothing more than that.

So if you aren't using those methods that use this field, this can be null.

envelopeTag

@NotNull
protected TagInfoset envelopeTag

headerTag

@NotNull
protected TagInfoset headerTag

bodyTag

@NotNull
protected TagInfoset bodyTag

EMPTY_ATTS

protected static final AttributesImpl EMPTY_ATTS

NULL_LOCATOR

protected static final LocatorImpl NULL_LOCATOR

DEFAULT_TAGS

protected static final List<TagInfoset> DEFAULT_TAGS

Constructor Detail

AbstractMessageImpl

protected AbstractMessageImpl(SOAPVersion soapVersion)

AbstractMessageImpl

protected AbstractMessageImpl(AbstractMessageImpl that)

Copy constructor.

Method Detail

getSOAPVersion

public SOAPVersion getSOAPVersion()

Overrides:

getSOAPVersion in class Message

readEnvelopeAsSource

public Source readEnvelopeAsSource()

Description copied from class: Message

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

Specified by:

readEnvelopeAsSource in class Message

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.

Specified by:

readPayloadAsJAXB in class Message

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

Deprecated.

Description copied from class: Message

Reads the payload as a JAXB object according to the given Bridge. This consumes the message.

Specified by:

readPayloadAsJAXB in class Message

Returns:

null if there's no payload.

Throws:

JAXBException - If JAXB reports an error during the processing.

readPayloadAsJAXB

public <T> T readPayloadAsJAXB(XMLBridge<T> bridge)
                        throws JAXBException

Description copied from class: Message

Reads the payload as a Data-Bond object This consumes the message.

Specified by:

readPayloadAsJAXB in class Message

Returns:

null if there's no payload.

Throws:

JAXBException - If JAXB reports an error during the processing.

writeToBodyStart

public void writeToBodyStart(XMLStreamWriter w)
                      throws XMLStreamException

Throws:

XMLStreamException

writeTo

public void writeTo(XMLStreamWriter w)
             throws XMLStreamException

Default implementation that relies on Message.writePayloadTo(XMLStreamWriter)

Specified by:

writeTo in class Message

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

Writes the whole envelope as SAX events.

Specified by:

writeTo in class 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:

SAXException

writePayloadTo

protected abstract void writePayloadTo(ContentHandler contentHandler,
                                       ErrorHandler errorHandler,
                                       boolean fragment)
                                throws SAXException

Writes the payload to SAX events.

Parameters:

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

toSAAJ

public Message toSAAJ(Packet p,
                      Boolean inbound)
               throws SOAPException

Throws:

SOAPException

readAsSOAPMessage

public SOAPMessage readAsSOAPMessage()
                              throws SOAPException

Default implementation that uses writeTo(ContentHandler, ErrorHandler)

Specified by:

readAsSOAPMessage in class Message

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 Message

Throws:

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