aoqi@0: /*
aoqi@0:  * Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package javax.xml.soap;
aoqi@0: 
aoqi@0: 
aoqi@0: /**
aoqi@0:  * The container for the SOAPHeader and SOAPBody portions of a
aoqi@0:  * <code>SOAPPart</code> object. By default, a <code>SOAPMessage</code>
aoqi@0:  * object is created with a <code>SOAPPart</code> object that has a
aoqi@0:  * <code>SOAPEnvelope</code> object. The <code>SOAPEnvelope</code> object
aoqi@0:  * by default has an empty <code>SOAPBody</code> object and an empty
aoqi@0:  * <code>SOAPHeader</code> object.  The <code>SOAPBody</code> object is
aoqi@0:  * required, and the <code>SOAPHeader</code> object, though
aoqi@0:  * optional, is used in the majority of cases. If the
aoqi@0:  * <code>SOAPHeader</code> object is not needed, it can be deleted,
aoqi@0:  * which is shown later.
aoqi@0:  * <P>
aoqi@0:  * A client can access the <code>SOAPHeader</code> and <code>SOAPBody</code>
aoqi@0:  * objects by calling the methods <code>SOAPEnvelope.getHeader</code> and
aoqi@0:  * <code>SOAPEnvelope.getBody</code>. The
aoqi@0:  * following  lines of code use these two methods after starting with
aoqi@0:  * the <code>SOAPMessage</code>
aoqi@0:  * object <i>message</i> to get the <code>SOAPPart</code> object <i>sp</i>,
aoqi@0:  * which is then used to get the <code>SOAPEnvelope</code> object <i>se</i>.
aoqi@0:  *
aoqi@0:  * <PRE>
aoqi@0:  *     SOAPPart sp = message.getSOAPPart();
aoqi@0:  *     SOAPEnvelope se = sp.getEnvelope();
aoqi@0:  *     SOAPHeader sh = se.getHeader();
aoqi@0:  *     SOAPBody sb = se.getBody();
aoqi@0:  * </PRE>
aoqi@0:  * <P>
aoqi@0:  * It is possible to change the body or header of a <code>SOAPEnvelope</code>
aoqi@0:  * object by retrieving the current one, deleting it, and then adding
aoqi@0:  * a new body or header. The <code>javax.xml.soap.Node</code> method
aoqi@0:  * <code>deleteNode</code> deletes the XML element (node) on which it is
aoqi@0:  * called.  For example, the following line of code deletes the
aoqi@0:  * <code>SOAPBody</code> object that is retrieved by the method <code>getBody</code>.
aoqi@0:  * <PRE>
aoqi@0:  *      se.getBody().detachNode();
aoqi@0:  * </PRE>
aoqi@0:  * To create a <code>SOAPHeader</code> object to replace the one that was removed,
aoqi@0:  * a client uses
aoqi@0:  * the method <code>SOAPEnvelope.addHeader</code>, which creates a new header and
aoqi@0:  * adds it to the <code>SOAPEnvelope</code> object. Similarly, the method
aoqi@0:  * <code>addBody</code> creates a new <code>SOAPBody</code> object and adds
aoqi@0:  * it to the <code>SOAPEnvelope</code> object. The following code fragment
aoqi@0:  * retrieves the current header, removes it, and adds a new one. Then
aoqi@0:  * it retrieves the current body, removes it, and adds a new one.
aoqi@0:  *
aoqi@0:  * <PRE>
aoqi@0:  *     SOAPPart sp = message.getSOAPPart();
aoqi@0:  *     SOAPEnvelope se = sp.getEnvelope();
aoqi@0:  *     se.getHeader().detachNode();
aoqi@0:  *     SOAPHeader sh = se.addHeader();
aoqi@0:  *     se.getBody().detachNode();
aoqi@0:  *     SOAPBody sb = se.addBody();
aoqi@0:  * </PRE>
aoqi@0:  * It is an error to add a <code>SOAPBody</code> or <code>SOAPHeader</code>
aoqi@0:  * object if one already exists.
aoqi@0:  * <P>
aoqi@0:  * The <code>SOAPEnvelope</code> interface provides three methods for creating
aoqi@0:  * <code>Name</code> objects. One method creates <code>Name</code> objects with
aoqi@0:  * a local name, a namespace prefix, and a namesapce URI. The second method creates
aoqi@0:  * <code>Name</code> objects with a local name and a namespace prefix, and the third
aoqi@0:  * creates <code>Name</code> objects with just a local name.  The following line of
aoqi@0:  * code, in which <i>se</i> is a <code>SOAPEnvelope</code> object, creates a new
aoqi@0:  * <code>Name</code> object with all three.
aoqi@0:  * <PRE>
aoqi@0:  *     Name name = se.createName("GetLastTradePrice", "WOMBAT",
aoqi@0:  *                                "http://www.wombat.org/trader");
aoqi@0:  * </PRE>
aoqi@0:  */
aoqi@0: public interface SOAPEnvelope extends SOAPElement {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Creates a new <code>Name</code> object initialized with the
aoqi@0:      * given local name, namespace prefix, and namespace URI.
aoqi@0:      * <P>
aoqi@0:      * This factory method creates <code>Name</code> objects for use in
aoqi@0:      * the SOAP/XML document.
aoqi@0:      *
aoqi@0:      * @param localName a <code>String</code> giving the local name
aoqi@0:      * @param prefix a <code>String</code> giving the prefix of the namespace
aoqi@0:      * @param uri a <code>String</code> giving the URI of the namespace
aoqi@0:      * @return a <code>Name</code> object initialized with the given
aoqi@0:      *         local name, namespace prefix, and namespace URI
aoqi@0:      * @throws SOAPException if there is a SOAP error
aoqi@0:      */
aoqi@0:     public abstract Name createName(String localName, String prefix,
aoqi@0:                                     String uri)
aoqi@0:         throws SOAPException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Creates a new <code>Name</code> object initialized with the
aoqi@0:      * given local name.
aoqi@0:      * <P>
aoqi@0:      * This factory method creates <code>Name</code> objects for use in
aoqi@0:      * the SOAP/XML document.
aoqi@0:      *
aoqi@0:      * @param localName a <code>String</code> giving the local name
aoqi@0:      * @return a <code>Name</code> object initialized with the given
aoqi@0:      *         local name
aoqi@0:      * @throws SOAPException if there is a SOAP error
aoqi@0:      */
aoqi@0:     public abstract Name createName(String localName)
aoqi@0:         throws SOAPException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the <code>SOAPHeader</code> object for
aoqi@0:      * this <code>SOAPEnvelope</code> object.
aoqi@0:      * <P>
aoqi@0:      * A new <code>SOAPMessage</code> object is by default created with a
aoqi@0:      * <code>SOAPEnvelope</code> object that contains an empty
aoqi@0:      * <code>SOAPHeader</code> object.  As a result, the method
aoqi@0:      * <code>getHeader</code> will always return a <code>SOAPHeader</code>
aoqi@0:      * object unless the header has been removed and a new one has not
aoqi@0:      * been added.
aoqi@0:      *
aoqi@0:      * @return the <code>SOAPHeader</code> object or <code>null</code> if
aoqi@0:      *         there is none
aoqi@0:      * @exception SOAPException if there is a problem obtaining the
aoqi@0:      *            <code>SOAPHeader</code> object
aoqi@0:      */
aoqi@0:     public SOAPHeader getHeader() throws SOAPException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the <code>SOAPBody</code> object associated with this
aoqi@0:      * <code>SOAPEnvelope</code> object.
aoqi@0:      * <P>
aoqi@0:      * A new <code>SOAPMessage</code> object is by default created with a
aoqi@0:      * <code>SOAPEnvelope</code> object that contains an empty
aoqi@0:      * <code>SOAPBody</code> object.  As a result, the method
aoqi@0:      * <code>getBody</code> will always return a <code>SOAPBody</code>
aoqi@0:      * object unless the body has been removed and a new one has not
aoqi@0:      * been added.
aoqi@0:      *
aoqi@0:      * @return the <code>SOAPBody</code> object for this
aoqi@0:      *         <code>SOAPEnvelope</code> object or <code>null</code>
aoqi@0:      *         if there is none
aoqi@0:      * @exception SOAPException if there is a problem obtaining the
aoqi@0:      *            <code>SOAPBody</code> object
aoqi@0:      */
aoqi@0:     public SOAPBody getBody() throws SOAPException;
aoqi@0:     /**
aoqi@0:      * Creates a <code>SOAPHeader</code> object and sets it as the
aoqi@0:      * <code>SOAPHeader</code> object for this <code>SOAPEnvelope</code>
aoqi@0:      * object.
aoqi@0:      * <P>
aoqi@0:      * It is illegal to add a header when the envelope already
aoqi@0:      * contains a header.  Therefore, this method should be called
aoqi@0:      * only after the existing header has been removed.
aoqi@0:      *
aoqi@0:      * @return the new <code>SOAPHeader</code> object
aoqi@0:      *
aoqi@0:      * @exception SOAPException if this
aoqi@0:      *            <code>SOAPEnvelope</code> object already contains a
aoqi@0:      *            valid <code>SOAPHeader</code> object
aoqi@0:      */
aoqi@0:     public SOAPHeader addHeader() throws SOAPException;
aoqi@0:     /**
aoqi@0:      * Creates a <code>SOAPBody</code> object and sets it as the
aoqi@0:      * <code>SOAPBody</code> object for this <code>SOAPEnvelope</code>
aoqi@0:      * object.
aoqi@0:      * <P>
aoqi@0:      * It is illegal to add a body when the envelope already
aoqi@0:      * contains a body. Therefore, this method should be called
aoqi@0:      * only after the existing body has been removed.
aoqi@0:      *
aoqi@0:      * @return the new <code>SOAPBody</code> object
aoqi@0:      *
aoqi@0:      * @exception SOAPException if this
aoqi@0:      *            <code>SOAPEnvelope</code> object already contains a
aoqi@0:      *            valid <code>SOAPBody</code> object
aoqi@0:      */
aoqi@0:     public SOAPBody addBody() throws SOAPException;
aoqi@0: }