JavaEE API 8.0.1 · javax.xml.rpc.handler.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.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: Returns true if the MessageContext contains the property; otherwise false containsProperty(String Name of the property whose presense is to be tested name) Returns true if the `MessageContext` contains a property with the specified name.
public Object	Returns: Value of the property getProperty(String Name of the property whose value is to be retrieved name) Gets the value of a specific property from the `MessageContext`
public Iterator<E>	Returns: Iterator for the property names getPropertyNames() Returns an Iterator view of the names of the properties in this `MessageContext`
public void	removeProperty(String Name of the property to be removed name) Removes a property (name-value pair) from the `MessageContext`
public void	setProperty(String Name of the property associated with the `MessageContext` name, Object Value of the property value) Sets the name and value of a property associated with the `MessageContext`.

Method Detail

containsProperty back to summary

containsProperty	back to summary
public boolean containsProperty(String name) Returns true if the `MessageContext` contains a property with the specified name. Parameters name:String Name of the property whose presense is to be tested Returns:boolean Returns true if the MessageContext contains the property; otherwise false

public boolean containsProperty(String name)

Returns true if the MessageContext contains a property with the specified name.

Parameters

name:String: Name of the property whose presense is to be tested

Returns:boolean

Returns true if the MessageContext contains the property; otherwise false

getProperty back to summary

getProperty	back to summary
public Object getProperty(String name) Gets the value of a specific property from the `MessageContext` Parameters name:String Name of the property whose value is to be retrieved Returns:Object Value of the property Exceptions IllegalArgumentException: if an illegal property name is specified

public Object getProperty(String name)

Gets the value of a specific property from the MessageContext

Parameters

name:String: Name of the property whose value is to be retrieved

Returns:Object

Value of the property

Exceptions

IllegalArgumentException:: if an illegal property name is specified

getPropertyNames back to summary

getPropertyNames	back to summary
public Iterator<E> getPropertyNames() Returns an Iterator view of the names of the properties in this `MessageContext` Returns:Iterator<E> Iterator for the property names

public Iterator<E> getPropertyNames()

Returns an Iterator view of the names of the properties in this MessageContext

Returns:Iterator<E>: Iterator for the property names

removeProperty back to summary

removeProperty	back to summary
public void removeProperty(String name) Removes a property (name-value pair) from the `MessageContext` Parameters name:String Name of the property to be removed Exceptions IllegalArgumentException: if an illegal property name is specified

public void removeProperty(String name)

Removes a property (name-value pair) from the MessageContext

Parameters

name:String: Name of the property to be removed

Exceptions

IllegalArgumentException:: if an illegal property name is specified

setProperty back to summary

setProperty	back to summary
public 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:String Name of the property associated with the `MessageContext` value:Object Value of the property Exceptions IllegalArgumentException: If some aspect of the property is prevents it from being stored in the context UnsupportedOperationException: If this method is not supported.

public 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:String: Name of the property associated with the MessageContext
value:Object: Value of the property

Exceptions

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

public Interface MessageContext

Method Summary

Method Detail