cgl.narada.wsinfra.deployment
Interface SOAPContext

All Known Implementing Classes:
SOAPContextImpl

public interface SOAPContext

Encapsulates the context of the message currently under processing. It is possible for an entity to retrieve the javax.xml.SOAPMessage or the equivalent EnvelopeDocument. The SOAPContext class also contains methods which will allow different filters within the filter pipeline to exchange state and other variable if so needed. Note that we need this wrapper so that filters that modify/replace the SOAP message will see their changes propagated to other filters. After a filter hass processed the SOAP message the right way to retrieve the SOAP message is to use the getSOAPMessage() method.


Method Summary
 boolean encapsulatesEnvelopeDocument()
          Check to see if the SOAPContext encapsulates an EnvelopeDocument.
 boolean encapsulatesSOAPMessage()
          Check to see if the SOAPContext encapsulates a SOAPMessage.
 EnvelopeDocument getEnvelopeDocument()
          Retrieve the envelope document.
 Object getProperty(String propertyName)
          Retrieves the value associated with the specified propertyName.
 SOAPMessage getSOAPMessage()
          Get the underlying SOAP message.
 boolean hasProperty(String propertyName)
          Check to see if there is a property corresponding to the specified property name.
 Enumeration propertyNames()
          Returns an enumeration of the properties encapsulated within the SOAPContext.
 void removeProperty(String propertyName)
          Removes the propertyName-Value combination associated with the specified propety name.
 void setEnvelopeDocument(EnvelopeDocument envelopeDocument)
          Set the envelope document.
 void setProperty(String propertyName, Object value)
          Adds/Replaces a property with specified value.
 void setSOAPMessage(SOAPMessage soapMessage)
          Set the soap message for the context.
 

Method Detail

getSOAPMessage

SOAPMessage getSOAPMessage()
Get the underlying SOAP message.


setSOAPMessage

void setSOAPMessage(SOAPMessage soapMessage)
Set the soap message for the context.


getEnvelopeDocument

EnvelopeDocument getEnvelopeDocument()
Retrieve the envelope document.


setEnvelopeDocument

void setEnvelopeDocument(EnvelopeDocument envelopeDocument)
Set the envelope document.


encapsulatesSOAPMessage

boolean encapsulatesSOAPMessage()
Check to see if the SOAPContext encapsulates a SOAPMessage.


encapsulatesEnvelopeDocument

boolean encapsulatesEnvelopeDocument()
Check to see if the SOAPContext encapsulates an EnvelopeDocument.


getProperty

Object getProperty(String propertyName)
Retrieves the value associated with the specified propertyName.


hasProperty

boolean hasProperty(String propertyName)
Check to see if there is a property corresponding to the specified property name.


removeProperty

void removeProperty(String propertyName)
Removes the propertyName-Value combination associated with the specified propety name.


setProperty

void setProperty(String propertyName,
                 Object value)
Adds/Replaces a property with specified value.


propertyNames

Enumeration propertyNames()
Returns an enumeration of the properties encapsulated within the SOAPContext.



For comments and suggestions please send e-mail to The NaradaBrokering Project