1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/javax/xml/soap/SOAPElement.java Wed Apr 27 01:27:09 2016 +0800
1.3 @@ -0,0 +1,524 @@
1.4 +/*
1.5 + * Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package javax.xml.soap;
1.30 +
1.31 +import java.util.Iterator;
1.32 +
1.33 +import javax.xml.namespace.QName;
1.34 +
1.35 +/**
1.36 + * An object representing an element of a SOAP message that is allowed but not
1.37 + * specifically prescribed by a SOAP specification. This interface serves as the
1.38 + * base interface for those objects that are specifically prescribed by a SOAP
1.39 + * specification.
1.40 + * <p>
1.41 + * Methods in this interface that are required to return SAAJ specific objects
1.42 + * may "silently" replace nodes in the tree as required to successfully return
1.43 + * objects of the correct type. See {@link #getChildElements()} and
1.44 + * {@link <a HREF="package-summary.html#package_description">javax.xml.soap<a>}
1.45 + * for details.
1.46 + */
1.47 +public interface SOAPElement extends Node, org.w3c.dom.Element {
1.48 +
1.49 + /**
1.50 + * Creates a new <code>SOAPElement</code> object initialized with the
1.51 + * given <code>Name</code> object and adds the new element to this
1.52 + * <code>SOAPElement</code> object.
1.53 + * <P>
1.54 + * This method may be deprecated in a future release of SAAJ in favor of
1.55 + * addChildElement(javax.xml.namespace.QName)
1.56 + *
1.57 + * @param name a <code>Name</code> object with the XML name for the
1.58 + * new element
1.59 + *
1.60 + * @return the new <code>SOAPElement</code> object that was created
1.61 + * @exception SOAPException if there is an error in creating the
1.62 + * <code>SOAPElement</code> object
1.63 + * @see SOAPElement#addChildElement(javax.xml.namespace.QName)
1.64 + */
1.65 + public SOAPElement addChildElement(Name name) throws SOAPException;
1.66 +
1.67 + /**
1.68 + * Creates a new <code>SOAPElement</code> object initialized with the given
1.69 + * <code>QName</code> object and adds the new element to this <code>SOAPElement</code>
1.70 + * object. The <i>namespace</i>, <i>localname</i> and <i>prefix</i> of the new
1.71 + * <code>SOAPElement</code> are all taken from the <code>qname</code> argument.
1.72 + *
1.73 + * @param qname a <code>QName</code> object with the XML name for the
1.74 + * new element
1.75 + *
1.76 + * @return the new <code>SOAPElement</code> object that was created
1.77 + * @exception SOAPException if there is an error in creating the
1.78 + * <code>SOAPElement</code> object
1.79 + * @see SOAPElement#addChildElement(Name)
1.80 + * @since SAAJ 1.3
1.81 + */
1.82 + public SOAPElement addChildElement(QName qname) throws SOAPException;
1.83 +
1.84 + /**
1.85 + * Creates a new <code>SOAPElement</code> object initialized with the
1.86 + * specified local name and adds the new element to this
1.87 + * <code>SOAPElement</code> object.
1.88 + * The new <code>SOAPElement</code> inherits any in-scope default namespace.
1.89 + *
1.90 + * @param localName a <code>String</code> giving the local name for
1.91 + * the element
1.92 + * @return the new <code>SOAPElement</code> object that was created
1.93 + * @exception SOAPException if there is an error in creating the
1.94 + * <code>SOAPElement</code> object
1.95 + */
1.96 + public SOAPElement addChildElement(String localName) throws SOAPException;
1.97 +
1.98 + /**
1.99 + * Creates a new <code>SOAPElement</code> object initialized with the
1.100 + * specified local name and prefix and adds the new element to this
1.101 + * <code>SOAPElement</code> object.
1.102 + *
1.103 + * @param localName a <code>String</code> giving the local name for
1.104 + * the new element
1.105 + * @param prefix a <code>String</code> giving the namespace prefix for
1.106 + * the new element
1.107 + *
1.108 + * @return the new <code>SOAPElement</code> object that was created
1.109 + * @exception SOAPException if the <code>prefix</code> is not valid in the
1.110 + * context of this <code>SOAPElement</code> or if there is an error in creating the
1.111 + * <code>SOAPElement</code> object
1.112 + */
1.113 + public SOAPElement addChildElement(String localName, String prefix)
1.114 + throws SOAPException;
1.115 +
1.116 + /**
1.117 + * Creates a new <code>SOAPElement</code> object initialized with the
1.118 + * specified local name, prefix, and URI and adds the new element to this
1.119 + * <code>SOAPElement</code> object.
1.120 + *
1.121 + * @param localName a <code>String</code> giving the local name for
1.122 + * the new element
1.123 + * @param prefix a <code>String</code> giving the namespace prefix for
1.124 + * the new element
1.125 + * @param uri a <code>String</code> giving the URI of the namespace
1.126 + * to which the new element belongs
1.127 + *
1.128 + * @return the new <code>SOAPElement</code> object that was created
1.129 + * @exception SOAPException if there is an error in creating the
1.130 + * <code>SOAPElement</code> object
1.131 + */
1.132 + public SOAPElement addChildElement(String localName, String prefix,
1.133 + String uri)
1.134 + throws SOAPException;
1.135 +
1.136 + /**
1.137 + * Add a <code>SOAPElement</code> as a child of this
1.138 + * <code>SOAPElement</code> instance. The <code>SOAPElement</code>
1.139 + * is expected to be created by a
1.140 + * <code>SOAPFactory</code>. Callers should not rely on the
1.141 + * element instance being added as is into the XML
1.142 + * tree. Implementations could end up copying the content
1.143 + * of the <code>SOAPElement</code> passed into an instance of
1.144 + * a different <code>SOAPElement</code> implementation. For
1.145 + * instance if <code>addChildElement()</code> is called on a
1.146 + * <code>SOAPHeader</code>, <code>element</code> will be copied
1.147 + * into an instance of a <code>SOAPHeaderElement</code>.
1.148 + *
1.149 + * <P>The fragment rooted in <code>element</code> is either added
1.150 + * as a whole or not at all, if there was an error.
1.151 + *
1.152 + * <P>The fragment rooted in <code>element</code> cannot contain
1.153 + * elements named "Envelope", "Header" or "Body" and in the SOAP
1.154 + * namespace. Any namespace prefixes present in the fragment
1.155 + * should be fully resolved using appropriate namespace
1.156 + * declarations within the fragment itself.
1.157 + *
1.158 + * @param element the <code>SOAPElement</code> to be added as a
1.159 + * new child
1.160 + *
1.161 + * @exception SOAPException if there was an error in adding this
1.162 + * element as a child
1.163 + *
1.164 + * @return an instance representing the new SOAP element that was
1.165 + * actually added to the tree.
1.166 + */
1.167 + public SOAPElement addChildElement(SOAPElement element)
1.168 + throws SOAPException;
1.169 +
1.170 + /**
1.171 + * Detaches all children of this <code>SOAPElement</code>.
1.172 + * <p>
1.173 + * This method is useful for rolling back the construction of partially
1.174 + * completed <code>SOAPHeaders</code> and <code>SOAPBodys</code> in
1.175 + * preparation for sending a fault when an error condition is detected. It
1.176 + * is also useful for recycling portions of a document within a SOAP
1.177 + * message.
1.178 + *
1.179 + * @since SAAJ 1.2
1.180 + */
1.181 + public abstract void removeContents();
1.182 +
1.183 + /**
1.184 + * Creates a new <code>Text</code> object initialized with the given
1.185 + * <code>String</code> and adds it to this <code>SOAPElement</code> object.
1.186 + *
1.187 + * @param text a <code>String</code> object with the textual content to be added
1.188 + *
1.189 + * @return the <code>SOAPElement</code> object into which
1.190 + * the new <code>Text</code> object was inserted
1.191 + * @exception SOAPException if there is an error in creating the
1.192 + * new <code>Text</code> object or if it is not legal to
1.193 + * attach it as a child to this
1.194 + * <code>SOAPElement</code>
1.195 + */
1.196 + public SOAPElement addTextNode(String text) throws SOAPException;
1.197 +
1.198 + /**
1.199 + * Adds an attribute with the specified name and value to this
1.200 + * <code>SOAPElement</code> object.
1.201 + *
1.202 + * @param name a <code>Name</code> object with the name of the attribute
1.203 + * @param value a <code>String</code> giving the value of the attribute
1.204 + * @return the <code>SOAPElement</code> object into which the attribute was
1.205 + * inserted
1.206 + *
1.207 + * @exception SOAPException if there is an error in creating the
1.208 + * Attribute, or it is invalid to set
1.209 + an attribute with <code>Name</code>
1.210 + <code>name</code> on this SOAPElement.
1.211 + * @see SOAPElement#addAttribute(javax.xml.namespace.QName, String)
1.212 + */
1.213 + public SOAPElement addAttribute(Name name, String value)
1.214 + throws SOAPException;
1.215 +
1.216 + /**
1.217 + * Adds an attribute with the specified name and value to this
1.218 + * <code>SOAPElement</code> object.
1.219 + *
1.220 + * @param qname a <code>QName</code> object with the name of the attribute
1.221 + * @param value a <code>String</code> giving the value of the attribute
1.222 + * @return the <code>SOAPElement</code> object into which the attribute was
1.223 + * inserted
1.224 + *
1.225 + * @exception SOAPException if there is an error in creating the
1.226 + * Attribute, or it is invalid to set
1.227 + an attribute with <code>QName</code>
1.228 + <code>qname</code> on this SOAPElement.
1.229 + * @see SOAPElement#addAttribute(Name, String)
1.230 + * @since SAAJ 1.3
1.231 + */
1.232 + public SOAPElement addAttribute(QName qname, String value)
1.233 + throws SOAPException;
1.234 +
1.235 + /**
1.236 + * Adds a namespace declaration with the specified prefix and URI to this
1.237 + * <code>SOAPElement</code> object.
1.238 + *
1.239 + * @param prefix a <code>String</code> giving the prefix of the namespace
1.240 + * @param uri a <code>String</code> giving the uri of the namespace
1.241 + * @return the <code>SOAPElement</code> object into which this
1.242 + * namespace declaration was inserted.
1.243 + *
1.244 + * @exception SOAPException if there is an error in creating the
1.245 + * namespace
1.246 + */
1.247 + public SOAPElement addNamespaceDeclaration(String prefix, String uri)
1.248 + throws SOAPException;
1.249 +
1.250 + /**
1.251 + * Returns the value of the attribute with the specified name.
1.252 + *
1.253 + * @param name a <code>Name</code> object with the name of the attribute
1.254 + * @return a <code>String</code> giving the value of the specified
1.255 + * attribute, Null if there is no such attribute
1.256 + * @see SOAPElement#getAttributeValue(javax.xml.namespace.QName)
1.257 + */
1.258 + public String getAttributeValue(Name name);
1.259 +
1.260 + /**
1.261 + * Returns the value of the attribute with the specified qname.
1.262 + *
1.263 + * @param qname a <code>QName</code> object with the qname of the attribute
1.264 + * @return a <code>String</code> giving the value of the specified
1.265 + * attribute, Null if there is no such attribute
1.266 + * @see SOAPElement#getAttributeValue(Name)
1.267 + * @since SAAJ 1.3
1.268 + */
1.269 + public String getAttributeValue(QName qname);
1.270 +
1.271 + /**
1.272 + * Returns an <code>Iterator</code> over all of the attribute
1.273 + * <code>Name</code> objects in this
1.274 + * <code>SOAPElement</code> object. The iterator can be used to get
1.275 + * the attribute names, which can then be passed to the method
1.276 + * <code>getAttributeValue</code> to retrieve the value of each
1.277 + * attribute.
1.278 + *
1.279 + * @see SOAPElement#getAllAttributesAsQNames()
1.280 + * @return an iterator over the names of the attributes
1.281 + */
1.282 + public Iterator getAllAttributes();
1.283 +
1.284 + /**
1.285 + * Returns an <code>Iterator</code> over all of the attributes
1.286 + * in this <code>SOAPElement</code> as <code>QName</code> objects.
1.287 + * The iterator can be used to get the attribute QName, which can then
1.288 + * be passed to the method <code>getAttributeValue</code> to retrieve
1.289 + * the value of each attribute.
1.290 + *
1.291 + * @return an iterator over the QNames of the attributes
1.292 + * @see SOAPElement#getAllAttributes()
1.293 + * @since SAAJ 1.3
1.294 + */
1.295 + public Iterator getAllAttributesAsQNames();
1.296 +
1.297 +
1.298 + /**
1.299 + * Returns the URI of the namespace that has the given prefix.
1.300 + *
1.301 + * @param prefix a <code>String</code> giving the prefix of the namespace
1.302 + * for which to search
1.303 + * @return a <code>String</code> with the uri of the namespace that has
1.304 + * the given prefix
1.305 + */
1.306 + public String getNamespaceURI(String prefix);
1.307 +
1.308 + /**
1.309 + * Returns an <code>Iterator</code> over the namespace prefix
1.310 + * <code>String</code>s declared by this element. The prefixes returned by
1.311 + * this iterator can be passed to the method
1.312 + * <code>getNamespaceURI</code> to retrieve the URI of each namespace.
1.313 + *
1.314 + * @return an iterator over the namespace prefixes in this
1.315 + * <code>SOAPElement</code> object
1.316 + */
1.317 + public Iterator getNamespacePrefixes();
1.318 +
1.319 + /**
1.320 + * Returns an <code>Iterator</code> over the namespace prefix
1.321 + * <code>String</code>s visible to this element. The prefixes returned by
1.322 + * this iterator can be passed to the method
1.323 + * <code>getNamespaceURI</code> to retrieve the URI of each namespace.
1.324 + *
1.325 + * @return an iterator over the namespace prefixes are within scope of this
1.326 + * <code>SOAPElement</code> object
1.327 + *
1.328 + * @since SAAJ 1.2
1.329 + */
1.330 + public Iterator getVisibleNamespacePrefixes();
1.331 +
1.332 + /**
1.333 + * Creates a <code>QName</code> whose namespace URI is the one associated
1.334 + * with the parameter, <code>prefix</code>, in the context of this
1.335 + * <code>SOAPElement</code>. The remaining elements of the new
1.336 + * <code>QName</code> are taken directly from the parameters,
1.337 + * <code>localName</code> and <code>prefix</code>.
1.338 + *
1.339 + * @param localName
1.340 + * a <code>String</code> containing the local part of the name.
1.341 + * @param prefix
1.342 + * a <code>String</code> containing the prefix for the name.
1.343 + *
1.344 + * @return a <code>QName</code> with the specified <code>localName</code>
1.345 + * and <code>prefix</code>, and with a namespace that is associated
1.346 + * with the <code>prefix</code> in the context of this
1.347 + * <code>SOAPElement</code>. This namespace will be the same as
1.348 + * the one that would be returned by
1.349 + * <code>{@link #getNamespaceURI(String)}</code> if it were given
1.350 + * <code>prefix</code> as it's parameter.
1.351 + *
1.352 + * @exception SOAPException if the <code>QName</code> cannot be created.
1.353 + *
1.354 + * @since SAAJ 1.3
1.355 + */
1.356 + public QName createQName(String localName, String prefix)
1.357 + throws SOAPException;
1.358 + /**
1.359 + * Returns the name of this <code>SOAPElement</code> object.
1.360 + *
1.361 + * @return a <code>Name</code> object with the name of this
1.362 + * <code>SOAPElement</code> object
1.363 + */
1.364 + public Name getElementName();
1.365 +
1.366 + /**
1.367 + * Returns the qname of this <code>SOAPElement</code> object.
1.368 + *
1.369 + * @return a <code>QName</code> object with the qname of this
1.370 + * <code>SOAPElement</code> object
1.371 + * @see SOAPElement#getElementName()
1.372 + * @since SAAJ 1.3
1.373 + */
1.374 + public QName getElementQName();
1.375 +
1.376 + /**
1.377 + * Changes the name of this <code>Element</code> to <code>newName</code> if
1.378 + * possible. SOAP Defined elements such as SOAPEnvelope, SOAPHeader, SOAPBody
1.379 + * etc. cannot have their names changed using this method. Any attempt to do
1.380 + * so will result in a SOAPException being thrown.
1.381 + *<P>
1.382 + * Callers should not rely on the element instance being renamed as is.
1.383 + * Implementations could end up copying the content of the
1.384 + * <code>SOAPElement</code> to a renamed instance.
1.385 + *
1.386 + * @param newName the new name for the <code>Element</code>.
1.387 + *
1.388 + * @exception SOAPException if changing the name of this <code>Element</code>
1.389 + * is not allowed.
1.390 + * @return The renamed Node
1.391 + *
1.392 + * @since SAAJ 1.3
1.393 + */
1.394 + public SOAPElement setElementQName(QName newName) throws SOAPException;
1.395 +
1.396 + /**
1.397 + * Removes the attribute with the specified name.
1.398 + *
1.399 + * @param name the <code>Name</code> object with the name of the
1.400 + * attribute to be removed
1.401 + * @return <code>true</code> if the attribute was
1.402 + * removed successfully; <code>false</code> if it was not
1.403 + * @see SOAPElement#removeAttribute(javax.xml.namespace.QName)
1.404 + */
1.405 + public boolean removeAttribute(Name name);
1.406 +
1.407 + /**
1.408 + * Removes the attribute with the specified qname.
1.409 + *
1.410 + * @param qname the <code>QName</code> object with the qname of the
1.411 + * attribute to be removed
1.412 + * @return <code>true</code> if the attribute was
1.413 + * removed successfully; <code>false</code> if it was not
1.414 + * @see SOAPElement#removeAttribute(Name)
1.415 + * @since SAAJ 1.3
1.416 + */
1.417 + public boolean removeAttribute(QName qname);
1.418 +
1.419 + /**
1.420 + * Removes the namespace declaration corresponding to the given prefix.
1.421 + *
1.422 + * @param prefix a <code>String</code> giving the prefix for which
1.423 + * to search
1.424 + * @return <code>true</code> if the namespace declaration was
1.425 + * removed successfully; <code>false</code> if it was not
1.426 + */
1.427 + public boolean removeNamespaceDeclaration(String prefix);
1.428 +
1.429 + /**
1.430 + * Returns an <code>Iterator</code> over all the immediate child
1.431 + * {@link Node}s of this element. This includes <code>javax.xml.soap.Text</code>
1.432 + * objects as well as <code>SOAPElement</code> objects.
1.433 + * <p>
1.434 + * Calling this method may cause child <code>Element</code>,
1.435 + * <code>SOAPElement</code> and <code>org.w3c.dom.Text</code> nodes to be
1.436 + * replaced by <code>SOAPElement</code>, <code>SOAPHeaderElement</code>,
1.437 + * <code>SOAPBodyElement</code> or <code>javax.xml.soap.Text</code> nodes as
1.438 + * appropriate for the type of this parent node. As a result the calling
1.439 + * application must treat any existing references to these child nodes that
1.440 + * have been obtained through DOM APIs as invalid and either discard them or
1.441 + * refresh them with the values returned by this <code>Iterator</code>. This
1.442 + * behavior can be avoided by calling the equivalent DOM APIs. See
1.443 + * {@link <a HREF="package-summary.html#package_description">javax.xml.soap<a>}
1.444 + * for more details.
1.445 + *
1.446 + * @return an iterator with the content of this <code>SOAPElement</code>
1.447 + * object
1.448 + */
1.449 + public Iterator getChildElements();
1.450 +
1.451 + /**
1.452 + * Returns an <code>Iterator</code> over all the immediate child
1.453 + * {@link Node}s of this element with the specified name. All of these
1.454 + * children will be <code>SOAPElement</code> nodes.
1.455 + * <p>
1.456 + * Calling this method may cause child <code>Element</code>,
1.457 + * <code>SOAPElement</code> and <code>org.w3c.dom.Text</code> nodes to be
1.458 + * replaced by <code>SOAPElement</code>, <code>SOAPHeaderElement</code>,
1.459 + * <code>SOAPBodyElement</code> or <code>javax.xml.soap.Text</code> nodes as
1.460 + * appropriate for the type of this parent node. As a result the calling
1.461 + * application must treat any existing references to these child nodes that
1.462 + * have been obtained through DOM APIs as invalid and either discard them or
1.463 + * refresh them with the values returned by this <code>Iterator</code>. This
1.464 + * behavior can be avoided by calling the equivalent DOM APIs. See
1.465 + * {@link <a HREF="package-summary.html#package_description">javax.xml.soap<a>}
1.466 + * for more details.
1.467 + *
1.468 + * @param name a <code>Name</code> object with the name of the child
1.469 + * elements to be returned
1.470 + *
1.471 + * @return an <code>Iterator</code> object over all the elements
1.472 + * in this <code>SOAPElement</code> object with the
1.473 + * specified name
1.474 + * @see SOAPElement#getChildElements(javax.xml.namespace.QName)
1.475 + */
1.476 + public Iterator getChildElements(Name name);
1.477 +
1.478 + /**
1.479 + * Returns an <code>Iterator</code> over all the immediate child
1.480 + * {@link Node}s of this element with the specified qname. All of these
1.481 + * children will be <code>SOAPElement</code> nodes.
1.482 + * <p>
1.483 + * Calling this method may cause child <code>Element</code>,
1.484 + * <code>SOAPElement</code> and <code>org.w3c.dom.Text</code> nodes to be
1.485 + * replaced by <code>SOAPElement</code>, <code>SOAPHeaderElement</code>,
1.486 + * <code>SOAPBodyElement</code> or <code>javax.xml.soap.Text</code> nodes as
1.487 + * appropriate for the type of this parent node. As a result the calling
1.488 + * application must treat any existing references to these child nodes that
1.489 + * have been obtained through DOM APIs as invalid and either discard them or
1.490 + * refresh them with the values returned by this <code>Iterator</code>. This
1.491 + * behavior can be avoided by calling the equivalent DOM APIs. See
1.492 + * {@link <a HREF="package-summary.html#package_description">javax.xml.soap<a>}
1.493 + * for more details.
1.494 + *
1.495 + * @param qname a <code>QName</code> object with the qname of the child
1.496 + * elements to be returned
1.497 + *
1.498 + * @return an <code>Iterator</code> object over all the elements
1.499 + * in this <code>SOAPElement</code> object with the
1.500 + * specified qname
1.501 + * @see SOAPElement#getChildElements(Name)
1.502 + * @since SAAJ 1.3
1.503 + */
1.504 + public Iterator getChildElements(QName qname);
1.505 +
1.506 + /**
1.507 + * Sets the encoding style for this <code>SOAPElement</code> object
1.508 + * to one specified.
1.509 + *
1.510 + * @param encodingStyle a <code>String</code> giving the encoding style
1.511 + *
1.512 + * @exception IllegalArgumentException if there was a problem in the
1.513 + * encoding style being set.
1.514 + * @exception SOAPException if setting the encodingStyle is invalid for this SOAPElement.
1.515 + * @see #getEncodingStyle
1.516 + */
1.517 + public void setEncodingStyle(String encodingStyle)
1.518 + throws SOAPException;
1.519 + /**
1.520 + * Returns the encoding style for this <code>SOAPElement</code> object.
1.521 + *
1.522 + * @return a <code>String</code> giving the encoding style
1.523 + *
1.524 + * @see #setEncodingStyle
1.525 + */
1.526 + public String getEncodingStyle();
1.527 +}
