| java.lang.Object
 com.sun.xml.ws.api.message.Message
All known Subclasses: com.sun.xml.ws.message.saaj.SAAJMessage, com.sun.xml.ws.message.AbstractMessageImpl, com.sun.xml.ws.message.source.ProtocolSourceMessage,
| Message | | abstract public class Message (Code) | | Represents a SOAP message.
What is a message?
A
Message consists of the following:
-
Random-accessible list of headers.
a header is a representation of an element inside
<soap:Header>.
It can be read multiple times,
can be added or removed, but it is not modifiable.
See
HeaderList for more about headers.
-
The payload of the message, which is a representation
of an element inside <soap:Body>.
the payload is streamed, and therefore it can be
only read once (or can be only written to something once.)
once a payload is used, a message is said to be consumed.
A message
Message.hasPayload() may not have any payload.
-
Attachments.
TODO: can attachments be streamed? I suspect so.
does anyone need to read attachment twice?
How does this abstraction work?
The basic idea behind the
Message is to hide the actual
data representation. For example, a
Message might be
constructed on top of an
InputStream from the accepted HTTP connection,
or it might be constructed on top of a JAXB object as a result
of the method invocation through
Proxy . There will be
a
Message implementation for each of those cases.
This interface provides a lot of methods that access the payload
in many different forms, and implementations can implement those
methods in the best possible way.
A particular attention is paid to make sure that a
Message object can be constructed on a stream that is not fully read yet.
We believe this improves the turn-around time on the server side.
It is often useful to wrap a
Message into another
Message ,
for example to encrypt the body, or to verify the signature as the body
is read.
This representation is also used for a REST-ful XML message.
In such case we'll construct a
Message with empty
attachments and headers, and when serializing all headers
and attachments will be ignored.
Message and XOP
XOP is considered as an
Codec , and therefore when you are looking at
Message , you'll never see <xop:Include> or any such elements
(instead you'll see the base64 data inlined.) If a consumer of infoset isn't
interested in handling XOP by himself, this allows him to work with XOP
correctly even without noticing it.
For producers and consumers that are interested in accessing the binary data
more efficiently, they can use
XMLStreamReaderEx and
XMLStreamWriterEx .
Message lifespan
Often
Packet include information local to a particular
invocaion (such as
HttpServletRequest , from this angle, it makes sense
to tie a lifespan of a message to one pipeline invocation.
On the other hand, if you think about WS-RM, it often needs to hold on to
a message longer than a pipeline invocation (you might get an HTTP request,
get a message X, get a second HTTP request, get another message Y, and
only then you might want to process X.)
TODO: what do we do about this?
TODO: can body element have foreign attributes? maybe ID for security?
Yes, when the SOAP body is signed there will be an ID attribute present
But in this case any security based impl may need access
to the concrete representation.
TODO: HTTP headers?
Yes. Abstracted as transport-based properties.
TODO: who handles SOAP 1.1 and SOAP 1.2 difference?
As separate channel implementations responsible for the creation of the
message?
TODO: session?
TODO: Do we need to expose SOAPMessage explicitly?
SOAPMessage could be the concrete representation but is it necessary to
transform between different concrete representations?
Perhaps this comes down to how use channels for creation and processing.
TODO: Do we need to distinguish better between creation and processing?
Do we really need the requirement that a created message can be resused
for processing. Shall we bifurcate?
TODO: SOAP version issue
SOAP version is determined by the context, so message itself doesn't carry it around (?)
TODO: wrapping message needs easier. in particular properties and attachments.
author:
Kohsuke Kawaguchi |
| assertOneWay | | final public void assertOneWay(boolean value)(Code) | | Makes an assertion that this
Message is
a request message for an one-way operation according
to the context WSDL.
This method is really only intended to be invoked from within
the JAX-WS runtime, and not by any code building on top of it.
This method can be invoked only when the caller "knows" what
WSDL says. Also, there's no point in invoking this method if the caller
is doing
getOperation(port).getOperation().isOneWay() ,
or sniffing the payload tag name.
In particular, this includes
DispatchImpl .
Once called, this allows
Message.isOneWay(WSDLPort) method
to return a value quickly.
See Also: Message.isOneWay(WSDLPort) |
| consume | | public void consume()(Code) | | 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.
|
| copy | | abstract public Message copy()(Code) | | 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.
- 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 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.
|
| getAttachments | | public AttachmentSet getAttachments()(Code) | | Gets the attachments of this message
(attachments live outside a message.)
|
| getHeaders | | abstract public HeaderList getHeaders()(Code) | | 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() .
always return the same non-null object. |
| getID | | public String getID(WSBinding binding)(Code) | | Retuns a unique id for the message. The id can be used for various things,
like debug assistance, logging, and MIME encoding(say for boundary).
This method will check the existence of the addressing header,
and if present uses that value. Otherwise it generates one from UUID.random(),
and return it without adding a new header. But it doesn't add a
to the header list since we expect them to be added before calling this
method.
Addressing tube will go do a separate verification on inbound
headers to make sure that header is present when it's
supposed to be.
Parameters:
binding - object created by BindingID.createBinding unique id for the message |
| getMethod | | final public JavaMethod getMethod(SEIModel seiModel)(Code) | | Returns the java Method of which this message is an instance of.
This method works only for a request. A pipe can determine a
Method for a request, and then keep it in a local variable to use it with a response,
so there should be no need to find out operation from a response (besides,
there might not be any response!).
Parameters:
seiModel - This represents the java model for the endpointSome server Pipes would get this information when they are created.Null if there is no corresponding Method for this message. This ispossible, for example when a protocol message is sent through apipeline, or when we receive an invalid request on the server,or when we are on the client and the user appliation sends a randomDOM through Dispatch, so this error needs to be handledgracefully. |
| getOperation | | final public WSDLBoundOperation getOperation(WSDLBoundPortType boundPortType)(Code) | | Returns the operation of which this message is an instance of.
This method relies on
WSDLBoundPortType.getOperation(StringString) but
it does so in an efficient way.
This method works only for a request. A pipe can determine an operation for a request,
and then keep it in a local variable to use it with a response, so there should be
no need to find out operation from a response (besides, there might not be any response!).
Parameters:
boundPortType - This represents the port for which this message is used.Most Pipes should get this information when they are created,since a pippeline always work against a particular type of WSDLPort.Null if the operation was not found. This is possible, for example when a protocolmessage is sent through a pipeline, or when we receive an invalid request on the server,or when we are on the client and the user appliation sends a random DOM throughDispatch, so this error needs to be handled gracefully. |
| getPayloadLocalPart | | abstract public String getPayloadLocalPart()(Code) | | Gets the local name of the payload element.
null if a Message doesn't have any payload. |
| getPayloadNamespaceURI | | abstract public String getPayloadNamespaceURI()(Code) | | Gets the namespace URI of the payload element.
null if a Message doesn't have any payload. |
| hasAttachments | | protected boolean hasAttachments()(Code) | | Optimization hint for the derived class to check
if we may have some attachments.
|
| hasHeaders | | abstract public boolean hasHeaders()(Code) | | Returns true if headers are present in the message.
true if headers are present. |
| hasPayload | | abstract public boolean hasPayload()(Code) | | Returns true if a
Message has a payload.
A message without a payload is a SOAP message that looks like:
<![CDATA[
<S:Envelope>
<S:Header>
...
</S:Header>
<S:Body />
</S:Envelope>
]]>
|
| isOneWay | | public boolean isOneWay(WSDLPort port)(Code) | | 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.)
Parameters:
port - Messages are always created under the context ofone WSDLPort and they never go outside that context.Pass in that "governing" WSDLPort object here.We chose to receive this as a parameter instead ofkeeping WSDLPort in a message, just to save the storage. The implementation of this method involves caching the returnvalue, so the behavior is undefined if multiple callers providedifferent WSDLPort objects, which is a bug of the caller. |
| readEnvelopeAsSource | | abstract public Source readEnvelopeAsSource()(Code) | | Consumes this message including the envelope.
returns it as a
Source object.
|
| readPayloadAsJAXB | | abstract public T readPayloadAsJAXB(Unmarshaller unmarshaller) throws JAXBException(Code) | | Reads the payload as a JAXB object by using the given unmarshaller.
This consumes the message.
throws:
JAXBException - If JAXB reports an error during the processing. |
| readPayloadAsJAXB | | abstract public T readPayloadAsJAXB(Bridge<T> bridge) throws JAXBException(Code) | | Reads the payload as a JAXB object according to the given
Bridge .
This consumes the message.
nullif there's no payload.
throws:
JAXBException - If JAXB reports an error during the processing. |
| readPayloadAsSource | | abstract public Source readPayloadAsSource()(Code) | | Returns the payload as a
Source object.
This consumes the message.
if there's no payload, this method returns null. |
| writeTo | | abstract public void writeTo(ContentHandler contentHandler, ErrorHandler errorHandler) throws SAXException(Code) | | Writes the whole SOAP envelope as SAX events.
This consumes the message.
Parameters:
contentHandler - must not be nulll.
Parameters:
errorHandler - must not be null.any error encountered during the SAX event production must befirst reported to this error handler. Fatal errors can be thenthrown as SAXParseException. SAXExceptions thrownfrom ErrorHandler should propagate directly through this method. |
|
|