Package javax.xml.rpc.handler
Interface MessageContext
-
- All Known Subinterfaces:
SOAPMessageContext
public interface MessageContextThe interfaceMessageContextabstracts the message context that is processed by a handler in thehandlemethod.The
MessageContextinterface provides methods to manage a property set.MessageContextproperties enable handlers in a handler chain to share processing related state.- Version:
- 1.1
- Author:
- Rahul Sharma, Roberto Chinnici
- See Also:
Handler
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancontainsProperty(String name)Returns true if theMessageContextcontains a property with the specified name.ObjectgetProperty(String name)Gets the value of a specific property from theMessageContextIteratorgetPropertyNames()Returns an Iterator view of the names of the properties in thisMessageContextvoidremoveProperty(String name)Removes a property (name-value pair) from theMessageContextvoidsetProperty(String name, Object value)Sets the name and value of a property associated with theMessageContext.
-
-
-
Method Detail
-
setProperty
void setProperty(String name, Object value)
Sets the name and value of a property associated with theMessageContext. If theMessageContextcontains a value of the same property, the old value is replaced.- Parameters:
name- Name of the property associated with theMessageContextvalue- Value of the property- Throws:
IllegalArgumentException- If some aspect of the property is prevents it from being stored in the contextUnsupportedOperationException- If this method is not supported.
-
getProperty
Object getProperty(String name)
Gets the value of a specific property from theMessageContext- Parameters:
name- Name of the property whose value is to be retrieved- Returns:
- Value of the property
- Throws:
IllegalArgumentException- if an illegal property name is specified
-
removeProperty
void removeProperty(String name)
Removes a property (name-value pair) from theMessageContext- Parameters:
name- Name of the property to be removed- Throws:
IllegalArgumentException- if an illegal property name is specified
-
containsProperty
boolean containsProperty(String name)
Returns true if theMessageContextcontains 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
Iterator getPropertyNames()
Returns an Iterator view of the names of the properties in thisMessageContext- Returns:
- Iterator for the property names
-
-