javax.xml.rpc.handler.MessageContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javax.xml.rpc-api Show documentation

Project GlassFish Enterprise JavaBean API

There is a newer version: 1.1.2

/*
 * Copyright 2003 Sun Microsystems, Inc. All rights reserved.
 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */

package javax.xml.rpc.handler;

/** 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.1
 *  @author  Rahul Sharma
 *  @author  Roberto Chinnici
 *  @see javax.xml.rpc.handler.Handler
**/

public interface MessageContext {

  /** 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.
   *
   *  @param name Name of the property associated with the 
   *              MessageContext
   *  @param value Value of the property
   *  @throws java.lang.IllegalArgumentException If some aspect
   *              of the property is prevents it from being stored
   *              in the context
   *  @throws UnsupportedOperationException If this method is 
   *              not supported.
   *             
  **/
  public void setProperty(String name, Object value);

  /** Gets the value of a specific property from the 
   *  MessageContext
   *  @param  name Name of the property whose value is to be
   *               retrieved
   *  @return Value of the property
   *  @throws java.lang.IllegalArgumentException if an illegal
   *              property name is specified
  **/
  public Object getProperty(String name);

  /** Removes a property (name-value pair) from the MessageContext
   *  @param name Name of the property to be removed
   *  @throws java.lang.IllegalArgumentException if an illegal
   *              property name is specified
  **/
  public void removeProperty(String name);

  /** Returns true if the MessageContext contains a property
   *  with the specified name.
   *  @param name Name of the property whose presense is to be
   *              tested
   *  @return Returns true if the MessageContext contains the
   *          property; otherwise false
  **/
  public boolean containsProperty(String name);

  /** Returns an Iterator view of the names of the properties
   *  in this MessageContext
   *
   *  @return Iterator for the property names
  **/
  public java.util.Iterator getPropertyNames();
 
}