javax.xml.rpc.handler.soap.SOAPMessageContext 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.soap;

import javax.xml.rpc.JAXRPCException;
import javax.xml.soap.SOAPMessage;

/** The interface javax.xml.rpc.soap.SOAPMessageContext 
 *  provides access to the SOAP message for either RPC request or 
 *  response. The javax.xml.soap.SOAPMessage specifies
 *  the standard Java API for the representation of a SOAP 1.1 message
 *  with attachments.
 *
 *  @version 1.0
 *  @author  Rahul Sharma
 *  @see javax.xml.soap.SOAPMessage
**/

public interface SOAPMessageContext 
                    extends javax.xml.rpc.handler.MessageContext {

  /** Gets the SOAPMessage from this message context
   *
   *  @return Returns the SOAPMessage; returns null if no 
   *          SOAPMessage is present in this message context
  **/
  public SOAPMessage getMessage();
  
  /** Sets the SOAPMessage in this message context
   *
   *  @param  message SOAP message
   *  @throws JAXRPCException If any error during the setting
   *          of the SOAPMessage in this message context
   *  @throws java.lang.UnsupportedOperationException If this
   *          operation is not supported
  **/
  public void setMessage(SOAPMessage message);

  /** Gets the SOAP actor roles associated with an execution
   *  of the HandlerChain and its contained Handler instances.
   *  Note that SOAP actor roles apply to the SOAP node and
   *  are managed using HandlerChain.setRoles and
   *  HandlerChain.getRoles. Handler instances in
   *  the HandlerChain use this information about the SOAP actor
   *  roles to process the SOAP header blocks. Note that the
   *  SOAP actor roles are invariant during the processing of
   *  SOAP message through the HandlerChain.
   *
   *  @return Array of URIs for SOAP actor roles
   *  @see javax.xml.rpc.handler.HandlerChain#setRoles
   *  @see javax.xml.rpc.handler.HandlerChain#getRoles
  **/
  public String[] getRoles();

}