Class ProtocolSourceMessage
Message
backed by Source
where the Source
represents the complete message such as a SOAP envelope. It uses
StreamSOAPCodec
to create a Message
and uses it as a
delegate for all the methods.- Author:
- Vivek Pandey, Jitendra Kotamraju
-
Field Summary
Fields inherited from class com.sun.xml.ws.api.message.Message
attachmentSet
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
Creates a copy of aMessage
.Gets all the headers of this message.Gets the local name of the payload element.Gets the namespace URI of the payload element.boolean
Returns true if headers are present in the message.boolean
Returns true if aMessage
has a payload.javax.xml.soap.SOAPMessage
Creates the equivalentSOAPMessage
from this message.javax.xml.soap.SOAPMessage
readAsSOAPMessage
(Packet packet, boolean inbound) Creates the equivalentSOAPMessage
from this message.Consumes this message including the envelope.Reads the payload as aXMLStreamReader
This consumes the message.<T> T
readPayloadAsJAXB
(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
(javax.xml.bind.Unmarshaller unmarshaller) Reads the payload as a JAXB object by using the given unmarshaller.Returns the payload as aSource
object.void
Writes the payload to StAX.void
Writes the whole SOAP message (but not attachments) to the given writer.void
writeTo
(ContentHandler contentHandler, ErrorHandler errorHandler) Writes the whole SOAP envelope as SAX events.Methods inherited from class com.sun.xml.ws.api.message.Message
addSOAPMimeHeaders, assertOneWay, consume, copyFrom, generateMessageID, getAttachments, getFirstDetailEntryName, getID, getID, getMethod, getOperation, getOperation, getTransportHeaders, getTransportHeaders, hasAttachments, isFault, isOneWay, setMessageMedadata
-
Constructor Details
-
ProtocolSourceMessage
-
-
Method Details
-
hasHeaders
public boolean hasHeaders()Description copied from class:Message
Returns true if headers are present in the message.- Specified by:
hasHeaders
in classMessage
- Returns:
- true if headers are present.
-
getPayloadLocalPart
Description copied from class:Message
Gets the local name of the payload element.- Specified by:
getPayloadLocalPart
in classMessage
- Returns:
- null if a
Message
doesn't have any payload.
-
getPayloadNamespaceURI
Description copied from class:Message
Gets the namespace URI of the payload element.- Specified by:
getPayloadNamespaceURI
in classMessage
- Returns:
- null if a
Message
doesn't have any payload.
-
hasPayload
public boolean hasPayload()Description copied from class:Message
Returns true if aMessage
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 classMessage
-
readPayloadAsSource
Description copied from class:Message
Returns the payload as aSource
object. This consumes the message.- Specified by:
readPayloadAsSource
in classMessage
- Returns:
- if there's no payload, this method returns null.
-
readPayload
Description copied from class:Message
Reads the payload as aXMLStreamReader
This consumes the message. The caller is encouraged to callXMLStreamReaderFactory.recycle(XMLStreamReader)
when finished using the instance.- Specified by:
readPayload
in classMessage
- 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
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 writeXMLStreamWriter.writeStartDocument()
norXMLStreamWriter.writeEndDocument()
If there's no payload, this method is no-op.
- Specified by:
writePayloadTo
in classMessage
- Throws:
XMLStreamException
- If theXMLStreamWriter
reports an error, or some other errors happen during the processing.
-
writeTo
Description copied from class:Message
Writes the whole SOAP message (but not attachments) to the given writer. This consumes the message.- Specified by:
writeTo
in classMessage
- Throws:
XMLStreamException
- If theXMLStreamWriter
reports an error, or some other errors happen during the processing.
-
copy
Description copied from class:Message
Creates a copy of aMessage
.This method creates a new
Message
whose header/payload/attachments/properties are identical to thisMessage
. Once created, the createdMessage
and the originalMessage
behaves independently --- adding header/ attachment to oneMessage
doesn't affect anotherMessage
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.
- The original and the copy may not be
used concurrently by two threads (this allows two
Message
s 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. - 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 identical copy of aMessage
.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
Message.copy()
METHOD, YOU MUST USE THEMessage.copyFrom(com.sun.xml.ws.api.message.Message)
METHOD IN THE IMPLEMENTATION. - The original and the copy may not be
used concurrently by two threads (this allows two
-
readEnvelopeAsSource
Description copied from class:Message
Consumes this message including the envelope. returns it as aSource
object.- Specified by:
readEnvelopeAsSource
in classMessage
-
readAsSOAPMessage
public javax.xml.soap.SOAPMessage readAsSOAPMessage() throws javax.xml.soap.SOAPExceptionDescription copied from class:Message
Creates the equivalentSOAPMessage
from this message. This consumes the message.- Specified by:
readAsSOAPMessage
in classMessage
- Throws:
javax.xml.soap.SOAPException
- if there's any error while creating aSOAPMessage
.
-
readAsSOAPMessage
public javax.xml.soap.SOAPMessage readAsSOAPMessage(Packet packet, boolean inbound) throws javax.xml.soap.SOAPException Description copied from class:Message
Creates the equivalentSOAPMessage
from this message. It also uses transport specific headers from Packet during the SOAPMessage construction so thatSOAPMessage.getMimeHeaders()
gives meaningful transport headers. This consumes the message.- Overrides:
readAsSOAPMessage
in classMessage
- Throws:
javax.xml.soap.SOAPException
- if there's any error while creating aSOAPMessage
.
-
readPayloadAsJAXB
public <T> T readPayloadAsJAXB(javax.xml.bind.Unmarshaller unmarshaller) throws javax.xml.bind.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 classMessage
- Throws:
javax.xml.bind.JAXBException
- If JAXB reports an error during the processing.
-
readPayloadAsJAXB
Deprecated.Description copied from class:Message
Reads the payload as a JAXB object according to the givenBridge
. This consumes the message.- Specified by:
readPayloadAsJAXB
in classMessage
- Returns:
- null if there's no payload.
- Throws:
javax.xml.bind.JAXBException
- If JAXB reports an error during the processing.
-
readPayloadAsJAXB
Description copied from class:Message
Reads the payload as a Data-Bond object This consumes the message.- Specified by:
readPayloadAsJAXB
in classMessage
- Returns:
- null if there's no payload.
- Throws:
javax.xml.bind.JAXBException
- If JAXB reports an error during the processing.
-
writeTo
Description copied from class:Message
Writes the whole SOAP envelope as SAX events.This consumes the message.
- Specified by:
writeTo
in classMessage
- 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 asSAXParseException
.SAXException
s thrown fromErrorHandler
should propagate directly through this method.- Throws:
SAXException
-
getSOAPVersion
- Overrides:
getSOAPVersion
in classMessage
-
getHeaders
Description copied from class:Message
Gets all the headers of this message.Implementation Note
Message
implementation is allowed to defer the construction ofMessageHeaders
object. So if you only want to check for the existence of any header element, useMessage.hasHeaders()
.- Specified by:
getHeaders
in classMessage
- Returns:
- always return the same non-null object.
-