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
<T extends PropertySet> T	getSatellite(java.lang.Class<T> satelliteClass) Gets the PropertySet
SOAPMessage	getSOAPMessage() Gets the SAAJ SOAPMessage representation of the SOAP message.
void	removeSatellite(PropertySet satellite) Removes the PropertySet

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

addSatellite

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

containsKey, createMapView, get, put, remove, supports

Method Detail

getSOAPMessage

SOAPMessage getSOAPMessage()
                           throws SOAPException

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(java.lang.Class<T> satelliteClass)

Gets the PropertySet

Specified by:

getSatellite in interface DistributedPropertySet

Parameters:

satellite - the PropertySet type