Package javax.xml.rpc.handler
Interface MessageContext
-
- All Known Subinterfaces:
SOAPMessageContext
public interface MessageContext
The interfaceMessageContext
abstracts the message context that is processed by a handler in thehandle
method.The
MessageContext
interface provides methods to manage a property set.MessageContext
properties enable handlers in a handler chain to share processing related state.- Version:
- $Rev: 467553 $ $Date: 2006-10-25 00:01:51 -0400 (Wed, 25 Oct 2006) $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
containsProperty(java.lang.String name)
Returns true if theMessageContext
contains a property with the specified name.java.lang.Object
getProperty(java.lang.String name)
Gets the value of a specific property from theMessageContext
.java.util.Iterator
getPropertyNames()
Returns an Iterator view of the names of the properties in thisMessageContext
.void
removeProperty(java.lang.String name)
Removes a property (name-value pair) from theMessageContext
.void
setProperty(java.lang.String name, java.lang.Object value)
Sets the name and value of a property associated with theMessageContext
.
-
-
-
Method Detail
-
setProperty
void setProperty(java.lang.String name, java.lang.Object value)
Sets the name and value of a property associated with theMessageContext
. If theMessageContext
contains a value of the same property, the old value is replaced.- Parameters:
name
- ame of the property associated with theMessageContext
value
- Value of the property- Throws:
java.lang.IllegalArgumentException
- If some aspect the property is prevents it from being stored in the contextjava.lang.UnsupportedOperationException
- If this method is not supported.
-
getProperty
java.lang.Object getProperty(java.lang.String name)
Gets the value of a specific property from theMessageContext
.- Parameters:
name
- the name of the property whose value is to be retrieved- Returns:
- the value of the property
- Throws:
java.lang.IllegalArgumentException
- if an illegal property name is specified
-
removeProperty
void removeProperty(java.lang.String name)
Removes a property (name-value pair) from theMessageContext
.- Parameters:
name
- the name of the property to be removed- Throws:
java.lang.IllegalArgumentException
- if an illegal property name is specified
-
containsProperty
boolean containsProperty(java.lang.String name)
Returns true if theMessageContext
contains a property with the specified name.- Parameters:
name
- Name of the property whose presense is to be tested- Returns:
- Returns true if the MessageContext contains the property; otherwise false
-
getPropertyNames
java.util.Iterator getPropertyNames()
Returns an Iterator view of the names of the properties in thisMessageContext
.- Returns:
- Iterator for the property names
-
-