org.jvnet.ws.message
Interface MessageContext

All Superinterfaces:

DistributedPropertySet, PropertySet

public interface MessageContext
extends DistributedPropertySet

MessageContext represents a container of a SOAP message and all the properties including the transport headers. MessageContext is a composite PropertySet that combines properties exposed from multiple PropertySets into one.

This implementation allows one PropertySet to assemble all properties exposed from other "satellite" PropertySets. (A satellite may itself be a DistributedPropertySet, so in general this can form a tree.)

Author:

shih-chang.chen@oracle.com

Nested Class Summary

Nested classes/interfaces inherited from interface org.jvnet.ws.message.PropertySet

PropertySet.Property

Method Summary

void	addSatellite(PropertySet satellite) Adds the PropertySet
void	copySatelliteInto(MessageContext otherMessageContext) Copies all the PropertySet of this MessageContext into the other MessageContext
SOAPMessage	getAsSOAPMessage() Gets the SAAJ SOAPMessage representation of the SOAP message.
ContentType	getContentType() Gets the Content-type of this message.
<T extends PropertySet> T	getSatellite(Class<T> satelliteClass) Gets the PropertySet
SOAPMessage	getSOAPMessage() Deprecated. use getAsSOAPMessage
void	removeSatellite(PropertySet satellite) Removes the PropertySet
ContentType	writeTo(OutputStream out) Writes the XML infoset portion of this MessageContext (from <soap:Envelope> to </soap:Envelope>).

Methods inherited from interface org.jvnet.ws.message.DistributedPropertySet

addSatellite

Methods inherited from interface org.jvnet.ws.message.PropertySet

asMap, containsKey, createMapView, get, put, remove, supports

Method Detail

getAsSOAPMessage

SOAPMessage getAsSOAPMessage()
                             throws SOAPException

Gets the SAAJ SOAPMessage representation of the SOAP message.

Returns:

The SOAPMessage

Throws:

SOAPException

getSOAPMessage

SOAPMessage getSOAPMessage()
                           throws SOAPException

Deprecated. use getAsSOAPMessage

Gets the SAAJ SOAPMessage representation of the SOAP message.

Returns:

The SOAPMessage

Throws:

SOAPException

addSatellite

void addSatellite(PropertySet satellite)

Adds the PropertySet

Specified by:

addSatellite in interface DistributedPropertySet

Parameters:

satellite - the PropertySet

removeSatellite

void removeSatellite(PropertySet satellite)

Removes the PropertySet

Specified by:

removeSatellite in interface DistributedPropertySet

Parameters:

satellite - the PropertySet

copySatelliteInto

void copySatelliteInto(MessageContext otherMessageContext)

Copies all the PropertySet of this MessageContext into the other MessageContext

Specified by:

copySatelliteInto in interface DistributedPropertySet

Parameters:

otherMessageContext - the MessageContext

getSatellite

<T extends PropertySet> T getSatellite(Class<T> satelliteClass)

Gets the PropertySet

Specified by:

getSatellite in interface DistributedPropertySet

Parameters:

satellite - the PropertySet type

writeTo

ContentType writeTo(OutputStream out)
                    throws IOException

Writes the XML infoset portion of this MessageContext (from <soap:Envelope> to </soap:Envelope>).

Parameters:

out - Must not be null. The caller is responsible for closing the stream, not the callee.

Returns:

The MIME content type of the encoded message (such as "application/xml"). This information is often ncessary by transport.

Throws:

IOException - if a OutputStream throws IOException.

getContentType

ContentType getContentType()

Gets the Content-type of this message. For an out-bound message that this getContentType() method returns a null, the Content-Type can be determined only by calling the writeTo method to write the MessageContext to an OutputStream.

Returns:

The MIME content type of this message