SOAPHeader.java revision 325
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * This code is free software; you can redistribute it and/or modify it
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * under the terms of the GNU General Public License version 2 only, as
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * published by the Free Software Foundation. Oracle designates this
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * particular file as subject to the "Classpath" exception as provided
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * by Oracle in the LICENSE file that accompanied this code.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * This code is distributed in the hope that it will be useful, but WITHOUT
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * version 2 for more details (a copy is included in the LICENSE file that
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * accompanied this code).
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * You should have received a copy of the GNU General Public License version
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * 2 along with this work; if not, write to the Free Software Foundation,
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * or visit www.oracle.com if you need additional information or have any
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * questions.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * A representation of the SOAP header
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * element. A SOAP header element consists of XML data that affects
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * the way the application-specific content is processed by the message
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * provider. For example, transaction semantics, authentication information,
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * and so on, can be specified as the content of a <code>SOAPHeader</code>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * A <code>SOAPEnvelope</code> object contains an empty
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeader</code> object by default. If the <code>SOAPHeader</code>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * object, which is optional, is not needed, it can be retrieved and deleted
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * with the following line of code. The variable <i>se</i> is a
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPEnvelope</code> object.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * se.getHeader().detachNode();
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * A <code>SOAPHeader</code> object is created with the <code>SOAPEnvelope</code>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * method <code>addHeader</code>. This method, which creates a new header and adds it
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * to the envelope, may be called only after the existing header has been removed.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * se.getHeader().detachNode();
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * SOAPHeader sh = se.addHeader();
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * A <code>SOAPHeader</code> object can have only <code>SOAPHeaderElement</code>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * objects as its immediate children. The method <code>addHeaderElement</code>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * creates a new <code>HeaderElement</code> object and adds it to the
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeader</code> object. In the following line of code, the
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * argument to the method <code>addHeaderElement</code> is a <code>Name</code>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * object that is the name for the new <code>HeaderElement</code> object.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * SOAPHeaderElement shElement = sh.addHeaderElement(name);
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @see SOAPHeaderElement
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenkpublic interface SOAPHeader extends SOAPElement {
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Creates a new <code>SOAPHeaderElement</code> object initialized with the
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * specified name and adds it to this <code>SOAPHeader</code> object.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @param name a <code>Name</code> object with the name of the new
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeaderElement</code> object
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return the new <code>SOAPHeaderElement</code> object that was
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * inserted into this <code>SOAPHeader</code> object
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @exception SOAPException if a SOAP error occurs
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @see SOAPHeader#addHeaderElement(javax.xml.namespace.QName)
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk public SOAPHeaderElement addHeaderElement(Name name)
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Creates a new <code>SOAPHeaderElement</code> object initialized with the
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * specified qname and adds it to this <code>SOAPHeader</code> object.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @param qname a <code>QName</code> object with the qname of the new
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeaderElement</code> object
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return the new <code>SOAPHeaderElement</code> object that was
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * inserted into this <code>SOAPHeader</code> object
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @exception SOAPException if a SOAP error occurs
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @see SOAPHeader#addHeaderElement(Name)
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @since SAAJ 1.3
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk public SOAPHeaderElement addHeaderElement(QName qname)
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Returns an <code>Iterator</code> over all the <code>SOAPHeaderElement</code> objects
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * in this <code>SOAPHeader</code> object
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * that have the specified <i>actor</i> and that have a MustUnderstand attribute
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * whose value is equivalent to <code>true</code>.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * In SOAP 1.2 the <i>env:actor</i> attribute is replaced by the <i>env:role</i>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * attribute, but with essentially the same semantics.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @param actor a <code>String</code> giving the URI of the <code>actor</code> / <code>role</code>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * for which to search
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return an <code>Iterator</code> object over all the
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeaderElement</code> objects that contain the specified
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>actor</code> / <code>role</code> and are marked as MustUnderstand
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @see #examineHeaderElements
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @see #extractHeaderElements
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @see SOAPConstants#URI_SOAP_ACTOR_NEXT
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @since SAAJ 1.2
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk public Iterator examineMustUnderstandHeaderElements(String actor);
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Returns an <code>Iterator</code> over all the <code>SOAPHeaderElement</code> objects
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * in this <code>SOAPHeader</code> object
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * that have the specified <i>actor</i>.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * An <i>actor</i> is a global attribute that indicates the intermediate
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * parties that should process a message before it reaches its ultimate
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * receiver. An actor receives the message and processes it before sending
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * it on to the next actor. The default actor is the ultimate intended
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * recipient for the message, so if no actor attribute is included in a
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeader</code> object, it is sent to the ultimate receiver
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * along with the message body.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * In SOAP 1.2 the <i>env:actor</i> attribute is replaced by the <i>env:role</i>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * attribute, but with essentially the same semantics.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @param actor a <code>String</code> giving the URI of the <code>actor</code> / <code>role</code>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * for which to search
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return an <code>Iterator</code> object over all the
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeaderElement</code> objects that contain the specified
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>actor</code> / <code>role</code>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @see #extractHeaderElements
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @see SOAPConstants#URI_SOAP_ACTOR_NEXT
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk public Iterator examineHeaderElements(String actor);
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Returns an <code>Iterator</code> over all the <code>SOAPHeaderElement</code> objects
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * in this <code>SOAPHeader</code> object
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * that have the specified <i>actor</i> and detaches them
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * from this <code>SOAPHeader</code> object.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * This method allows an actor to process the parts of the
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeader</code> object that apply to it and to remove
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * them before passing the message on to the next actor.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * In SOAP 1.2 the <i>env:actor</i> attribute is replaced by the <i>env:role</i>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * attribute, but with essentially the same semantics.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @param actor a <code>String</code> giving the URI of the <code>actor</code> / <code>role</code>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * for which to search
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return an <code>Iterator</code> object over all the
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeaderElement</code> objects that contain the specified
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>actor</code> / <code>role</code>
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @see #examineHeaderElements
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @see SOAPConstants#URI_SOAP_ACTOR_NEXT
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk public Iterator extractHeaderElements(String actor);
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Creates a new NotUnderstood <code>SOAPHeaderElement</code> object initialized
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * with the specified name and adds it to this <code>SOAPHeader</code> object.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * This operation is supported only by SOAP 1.2.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @param name a <code>QName</code> object with the name of the
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeaderElement</code> object that was not understood.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return the new <code>SOAPHeaderElement</code> object that was
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * inserted into this <code>SOAPHeader</code> object
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @exception SOAPException if a SOAP error occurs.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @exception UnsupportedOperationException if this is a SOAP 1.1 Header.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @since SAAJ 1.3
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk public SOAPHeaderElement addNotUnderstoodHeaderElement(QName name)
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Creates a new Upgrade <code>SOAPHeaderElement</code> object initialized
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * with the specified List of supported SOAP URIs and adds it to this
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeader</code> object.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @param supportedSOAPURIs an <code>Iterator</code> object with the URIs of SOAP
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * versions supported.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return the new <code>SOAPHeaderElement</code> object that was
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * inserted into this <code>SOAPHeader</code> object
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @exception SOAPException if a SOAP error occurs.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @since SAAJ 1.3
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk public SOAPHeaderElement addUpgradeHeaderElement(Iterator supportedSOAPURIs)
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Creates a new Upgrade <code>SOAPHeaderElement</code> object initialized
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * with the specified array of supported SOAP URIs and adds it to this
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeader</code> object.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @param supportedSoapUris an array of the URIs of SOAP versions supported.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return the new <code>SOAPHeaderElement</code> object that was
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * inserted into this <code>SOAPHeader</code> object
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @exception SOAPException if a SOAP error occurs.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @since SAAJ 1.3
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk public SOAPHeaderElement addUpgradeHeaderElement(String[] supportedSoapUris)
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * Creates a new Upgrade <code>SOAPHeaderElement</code> object initialized
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * with the specified supported SOAP URI and adds it to this
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * <code>SOAPHeader</code> object.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @param supportedSoapUri the URI of SOAP the version that is supported.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @return the new <code>SOAPHeaderElement</code> object that was
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * inserted into this <code>SOAPHeader</code> object
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @exception SOAPException if a SOAP error occurs.
c1350cf5bc50458ba79cc93ff9e0e5fe3f1aeeb0jeff.schenk * @since SAAJ 1.3