-
- 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:
- 1.1
- Author:
- Rahul Sharma, Roberto Chinnici
- See Also:
Handler
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description boolean
containsProperty(String name)
Returns true if theMessageContext
contains a property with the specified name.Object
getProperty(String name)
Gets the value of a specific property from theMessageContext
Iterator
getPropertyNames()
Returns an Iterator view of the names of the properties in thisMessageContext
void
removeProperty(String name)
Removes a property (name-value pair) from theMessageContext
void
setProperty(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 theMessageContext
contains a value of the same property, the old value is replaced.- Parameters:
name
- Name of the property associated with theMessageContext
value
- 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 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
Iterator getPropertyNames()
Returns an Iterator view of the names of the properties in thisMessageContext
- Returns:
- Iterator for the property names
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/xml/rpc/handler/MessageContext.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.