org.jboss.webservice.handler
Class MessageContextImpl

java.lang.Object
  extended byorg.jboss.webservice.handler.MessageContextImpl
All Implemented Interfaces:
MessageContext (src)

public class MessageContextImpl
extends java.lang.Object
implements MessageContext (src)

The message context that is processed by a handler in the handle method.

Provides methods to manage a property set. MessageContext properties enable handlers in a handler chain to share processing related state.

Since:
06-May-2004

Constructor Summary
MessageContextImpl()
           
 
Method Summary
 boolean containsProperty(java.lang.String name)
          Returns true if the MessageContext contains a property with the specified name.
 java.lang.Object getProperty(java.lang.String name)
          Gets the value of a specific property from the MessageContext
 java.util.Iterator getPropertyNames()
          Returns an Iterator view of the names of the properties in this MessageContext
 void removeProperty(java.lang.String name)
          Removes a property (name-value pair) from the MessageContext
 void setProperty(java.lang.String name, java.lang.Object value)
          Sets the name and value of a property associated with the MessageContext.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MessageContextImpl

public MessageContextImpl()
Method Detail

containsProperty

public boolean containsProperty(java.lang.String name)
Returns true if the MessageContext contains a property with the specified name.

Specified by:
containsProperty in interface MessageContext (src)
Parameters:
name - Name of the property whose presense is to be tested
Returns:
Returns true if the MessageContext contains the property; otherwise false

getProperty

public java.lang.Object getProperty(java.lang.String name)
Gets the value of a specific property from the MessageContext

Specified by:
getProperty in interface MessageContext (src)
Parameters:
name - Name of the property whose value is to be retrieved
Returns:
Value of the property
Throws:
java.lang.IllegalArgumentException - if an illegal property name is specified

getPropertyNames

public java.util.Iterator getPropertyNames()
Returns an Iterator view of the names of the properties in this MessageContext

Specified by:
getPropertyNames in interface MessageContext (src)
Returns:
Iterator for the property names

removeProperty

public void removeProperty(java.lang.String name)
Removes a property (name-value pair) from the MessageContext

Specified by:
removeProperty in interface MessageContext (src)
Parameters:
name - Name of the property to be removed
Throws:
java.lang.IllegalArgumentException - if an illegal property name is specified

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
Sets the name and value of a property associated with the MessageContext. If the MessageContext contains a value of the same property, the old value is replaced.

Specified by:
setProperty in interface MessageContext (src)
Parameters:
name - Name of the property associated with the MessageContext
value - Value of the property
Throws:
java.lang.IllegalArgumentException - If some aspect of the property is prevents it from being stored in the context
java.lang.UnsupportedOperationException - If this method is not supported.