javax.xml.rpc.handler

Interface MessageContext

public interface MessageContext

The interface MessageContext abstracts the message context that is processed by a handler in the handle 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: 1.0

Method Summary
abstract booleancontainsProperty(String name)
Returns true if the MessageContext contains a property with the specified name.
abstract ObjectgetProperty(String name)
Gets the value of a specific property from the MessageContext.
abstract IteratorgetPropertyNames()
Returns an Iterator view of the names of the properties in this MessageContext.
abstract voidremoveProperty(String name)
Removes a property (name-value pair) from the MessageContext.
abstract voidsetProperty(String name, Object value)
Sets the name and value of a property associated with the MessageContext.

Method Detail

containsProperty

public abstract boolean containsProperty(String name)
Returns true if the MessageContext 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

getProperty

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

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

getPropertyNames

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

Returns: Iterator for the property names

removeProperty

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

Parameters: name the name of the property to be removed

Throws: java.lang.IllegalArgumentException if an illegal property name is specified

setProperty

public abstract void setProperty(String name, 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.

Parameters: name ame of the property associated with the MessageContext value Value of the property

Throws: java.lang.IllegalArgumentException If some aspect the property is prevents it from being stored in the context java.lang.UnsupportedOperationException If this method is not supported.

Copyright B) 2005 Apache Web Services Project. All Rights Reserved.