javax.xml.soap.SOAPElement Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.soap;
import java.util.Iterator;
import javax.xml.namespace.QName;
/**
* An object representing an element of a SOAP message that is allowed but not
* specifically prescribed by a SOAP specification. This interface serves as the
* base interface for those objects that are specifically prescribed by a SOAP
* specification.
*
* Methods in this interface that are required to return SAAJ specific objects
* may "silently" replace nodes in the tree as required to successfully return
* objects of the correct type. See {@link #getChildElements()} and
* {@link javax.xml.soap}
* for details.
*/
public interface SOAPElement extends Node, org.w3c.dom.Element {
/**
* Creates a new SOAPElement object initialized with the
* given Name object and adds the new element to this
* SOAPElement object.
*
* This method may be deprecated in a future release of SAAJ in favor of
* addChildElement(javax.xml.namespace.QName)
*
* @param name a Name object with the XML name for the
* new element
*
* @return the new SOAPElement object that was created
* @exception SOAPException if there is an error in creating the
* SOAPElement object
* @see SOAPElement#addChildElement(javax.xml.namespace.QName)
*/
public SOAPElement addChildElement(Name name) throws SOAPException;
/**
* Creates a new SOAPElement object initialized with the given
* QName object and adds the new element to this SOAPElement
* object. The namespace, localname and prefix of the new
* SOAPElement are all taken from the qname argument.
*
* @param qname a QName object with the XML name for the
* new element
*
* @return the new SOAPElement object that was created
* @exception SOAPException if there is an error in creating the
* SOAPElement object
* @see SOAPElement#addChildElement(Name)
* @since SAAJ 1.3
*/
public SOAPElement addChildElement(QName qname) throws SOAPException;
/**
* Creates a new SOAPElement object initialized with the
* specified local name and adds the new element to this
* SOAPElement object.
* The new SOAPElement inherits any in-scope default namespace.
*
* @param localName a String giving the local name for
* the element
* @return the new SOAPElement object that was created
* @exception SOAPException if there is an error in creating the
* SOAPElement object
*/
public SOAPElement addChildElement(String localName) throws SOAPException;
/**
* Creates a new SOAPElement object initialized with the
* specified local name and prefix and adds the new element to this
* SOAPElement object.
*
* @param localName a String giving the local name for
* the new element
* @param prefix a String giving the namespace prefix for
* the new element
*
* @return the new SOAPElement object that was created
* @exception SOAPException if the prefix is not valid in the
* context of this SOAPElement or if there is an error in creating the
* SOAPElement object
*/
public SOAPElement addChildElement(String localName, String prefix)
throws SOAPException;
/**
* Creates a new SOAPElement object initialized with the
* specified local name, prefix, and URI and adds the new element to this
* SOAPElement object.
*
* @param localName a String giving the local name for
* the new element
* @param prefix a String giving the namespace prefix for
* the new element
* @param uri a String giving the URI of the namespace
* to which the new element belongs
*
* @return the new SOAPElement object that was created
* @exception SOAPException if there is an error in creating the
* SOAPElement object
*/
public SOAPElement addChildElement(String localName, String prefix,
String uri)
throws SOAPException;
/**
* Add a SOAPElement as a child of this
* SOAPElement instance. The SOAPElement
* is expected to be created by a
* SOAPFactory. Callers should not rely on the
* element instance being added as is into the XML
* tree. Implementations could end up copying the content
* of the SOAPElement passed into an instance of
* a different SOAPElement implementation. For
* instance if addChildElement() is called on a
* SOAPHeader, element will be copied
* into an instance of a SOAPHeaderElement.
*
*
The fragment rooted in element is either added
* as a whole or not at all, if there was an error.
*
*
The fragment rooted in element cannot contain
* elements named "Envelope", "Header" or "Body" and in the SOAP
* namespace. Any namespace prefixes present in the fragment
* should be fully resolved using appropriate namespace
* declarations within the fragment itself.
*
* @param element the SOAPElement to be added as a
* new child
*
* @exception SOAPException if there was an error in adding this
* element as a child
*
* @return an instance representing the new SOAP element that was
* actually added to the tree.
*/
public SOAPElement addChildElement(SOAPElement element)
throws SOAPException;
/**
* Detaches all children of this SOAPElement.
*
* This method is useful for rolling back the construction of partially
* completed SOAPHeaders and SOAPBodys in
* preparation for sending a fault when an error condition is detected. It
* is also useful for recycling portions of a document within a SOAP
* message.
*
* @since SAAJ 1.2
*/
public abstract void removeContents();
/**
* Creates a new Text object initialized with the given
* String and adds it to this SOAPElement object.
*
* @param text a String object with the textual content to be added
*
* @return the SOAPElement object into which
* the new Text object was inserted
* @exception SOAPException if there is an error in creating the
* new Text object or if it is not legal to
* attach it as a child to this
* SOAPElement
*/
public SOAPElement addTextNode(String text) throws SOAPException;
/**
* Adds an attribute with the specified name and value to this
* SOAPElement object.
*
* @param name a Name object with the name of the attribute
* @param value a String giving the value of the attribute
* @return the SOAPElement object into which the attribute was
* inserted
*
* @exception SOAPException if there is an error in creating the
* Attribute, or it is invalid to set
an attribute with Name
name on this SOAPElement.
* @see SOAPElement#addAttribute(javax.xml.namespace.QName, String)
*/
public SOAPElement addAttribute(Name name, String value)
throws SOAPException;
/**
* Adds an attribute with the specified name and value to this
* SOAPElement object.
*
* @param qname a QName object with the name of the attribute
* @param value a String giving the value of the attribute
* @return the SOAPElement object into which the attribute was
* inserted
*
* @exception SOAPException if there is an error in creating the
* Attribute, or it is invalid to set
an attribute with QName
qname on this SOAPElement.
* @see SOAPElement#addAttribute(Name, String)
* @since SAAJ 1.3
*/
public SOAPElement addAttribute(QName qname, String value)
throws SOAPException;
/**
* Adds a namespace declaration with the specified prefix and URI to this
* SOAPElement object.
*
* @param prefix a String giving the prefix of the namespace
* @param uri a String giving the uri of the namespace
* @return the SOAPElement object into which this
* namespace declaration was inserted.
*
* @exception SOAPException if there is an error in creating the
* namespace
*/
public SOAPElement addNamespaceDeclaration(String prefix, String uri)
throws SOAPException;
/**
* Returns the value of the attribute with the specified name.
*
* @param name a Name object with the name of the attribute
* @return a String giving the value of the specified
* attribute, Null if there is no such attribute
* @see SOAPElement#getAttributeValue(javax.xml.namespace.QName)
*/
public String getAttributeValue(Name name);
/**
* Returns the value of the attribute with the specified qname.
*
* @param qname a QName object with the qname of the attribute
* @return a String giving the value of the specified
* attribute, Null if there is no such attribute
* @see SOAPElement#getAttributeValue(Name)
* @since SAAJ 1.3
*/
public String getAttributeValue(QName qname);
/**
* Returns an Iterator over all of the attribute
* Name objects in this
* SOAPElement object. The iterator can be used to get
* the attribute names, which can then be passed to the method
* getAttributeValue to retrieve the value of each
* attribute.
*
* @see SOAPElement#getAllAttributesAsQNames()
* @return an iterator over the names of the attributes
*/
public Iterator getAllAttributes();
/**
* Returns an Iterator over all of the attributes
* in this SOAPElement as QName objects.
* The iterator can be used to get the attribute QName, which can then
* be passed to the method getAttributeValue to retrieve
* the value of each attribute.
*
* @return an iterator over the QNames of the attributes
* @see SOAPElement#getAllAttributes()
* @since SAAJ 1.3
*/
public Iterator getAllAttributesAsQNames();
/**
* Returns the URI of the namespace that has the given prefix.
*
* @param prefix a String giving the prefix of the namespace
* for which to search
* @return a String with the uri of the namespace that has
* the given prefix
*/
public String getNamespaceURI(String prefix);
/**
* Returns an Iterator over the namespace prefix
* Strings declared by this element. The prefixes returned by
* this iterator can be passed to the method
* getNamespaceURI to retrieve the URI of each namespace.
*
* @return an iterator over the namespace prefixes in this
* SOAPElement object
*/
public Iterator getNamespacePrefixes();
/**
* Returns an Iterator over the namespace prefix
* Strings visible to this element. The prefixes returned by
* this iterator can be passed to the method
* getNamespaceURI to retrieve the URI of each namespace.
*
* @return an iterator over the namespace prefixes are within scope of this
* SOAPElement object
*
* @since SAAJ 1.2
*/
public Iterator getVisibleNamespacePrefixes();
/**
* Creates a QName whose namespace URI is the one associated
* with the parameter, prefix, in the context of this
* SOAPElement. The remaining elements of the new
* QName are taken directly from the parameters,
* localName and prefix.
*
* @param localName
* a String containing the local part of the name.
* @param prefix
* a String containing the prefix for the name.
*
* @return a QName with the specified localName
* and prefix, and with a namespace that is associated
* with the prefix in the context of this
* SOAPElement. This namespace will be the same as
* the one that would be returned by
* {@link #getNamespaceURI(String)} if it were given
* prefix as it's parameter.
*
* @exception SOAPException if the QName cannot be created.
*
* @since SAAJ 1.3
*/
public QName createQName(String localName, String prefix)
throws SOAPException;
/**
* Returns the name of this SOAPElement object.
*
* @return a Name object with the name of this
* SOAPElement object
*/
public Name getElementName();
/**
* Returns the qname of this SOAPElement object.
*
* @return a QName object with the qname of this
* SOAPElement object
* @see SOAPElement#getElementName()
* @since SAAJ 1.3
*/
public QName getElementQName();
/**
* Changes the name of this Element to newName if
* possible. SOAP Defined elements such as SOAPEnvelope, SOAPHeader, SOAPBody
* etc. cannot have their names changed using this method. Any attempt to do
* so will result in a SOAPException being thrown.
*
* Callers should not rely on the element instance being renamed as is.
* Implementations could end up copying the content of the
* SOAPElement to a renamed instance.
*
* @param newName the new name for the Element.
*
* @exception SOAPException if changing the name of this Element
* is not allowed.
* @return The renamed Node
*
* @since SAAJ 1.3
*/
public SOAPElement setElementQName(QName newName) throws SOAPException;
/**
* Removes the attribute with the specified name.
*
* @param name the Name object with the name of the
* attribute to be removed
* @return true if the attribute was
* removed successfully; false if it was not
* @see SOAPElement#removeAttribute(javax.xml.namespace.QName)
*/
public boolean removeAttribute(Name name);
/**
* Removes the attribute with the specified qname.
*
* @param qname the QName object with the qname of the
* attribute to be removed
* @return true if the attribute was
* removed successfully; false if it was not
* @see SOAPElement#removeAttribute(Name)
* @since SAAJ 1.3
*/
public boolean removeAttribute(QName qname);
/**
* Removes the namespace declaration corresponding to the given prefix.
*
* @param prefix a String giving the prefix for which
* to search
* @return true if the namespace declaration was
* removed successfully; false if it was not
*/
public boolean removeNamespaceDeclaration(String prefix);
/**
* Returns an Iterator over all the immediate child
* {@link Node}s of this element. This includes javax.xml.soap.Text
* objects as well as SOAPElement objects.
*
* Calling this method may cause child Element,
* SOAPElement and org.w3c.dom.Text nodes to be
* replaced by SOAPElement, SOAPHeaderElement,
* SOAPBodyElement or javax.xml.soap.Text nodes as
* appropriate for the type of this parent node. As a result the calling
* application must treat any existing references to these child nodes that
* have been obtained through DOM APIs as invalid and either discard them or
* refresh them with the values returned by this Iterator. This
* behavior can be avoided by calling the equivalent DOM APIs. See
* {@link javax.xml.soap}
* for more details.
*
* @return an iterator with the content of this SOAPElement
* object
*/
public Iterator getChildElements();
/**
* Returns an Iterator over all the immediate child
* {@link Node}s of this element with the specified name. All of these
* children will be SOAPElement nodes.
*
* Calling this method may cause child Element,
* SOAPElement and org.w3c.dom.Text nodes to be
* replaced by SOAPElement, SOAPHeaderElement,
* SOAPBodyElement or javax.xml.soap.Text nodes as
* appropriate for the type of this parent node. As a result the calling
* application must treat any existing references to these child nodes that
* have been obtained through DOM APIs as invalid and either discard them or
* refresh them with the values returned by this Iterator. This
* behavior can be avoided by calling the equivalent DOM APIs. See
* {@link javax.xml.soap}
* for more details.
*
* @param name a Name object with the name of the child
* elements to be returned
*
* @return an Iterator object over all the elements
* in this SOAPElement object with the
* specified name
* @see SOAPElement#getChildElements(javax.xml.namespace.QName)
*/
public Iterator getChildElements(Name name);
/**
* Returns an Iterator over all the immediate child
* {@link Node}s of this element with the specified qname. All of these
* children will be SOAPElement nodes.
*
* Calling this method may cause child Element,
* SOAPElement and org.w3c.dom.Text nodes to be
* replaced by SOAPElement, SOAPHeaderElement,
* SOAPBodyElement or javax.xml.soap.Text nodes as
* appropriate for the type of this parent node. As a result the calling
* application must treat any existing references to these child nodes that
* have been obtained through DOM APIs as invalid and either discard them or
* refresh them with the values returned by this Iterator. This
* behavior can be avoided by calling the equivalent DOM APIs. See
* {@link javax.xml.soap}
* for more details.
*
* @param qname a QName object with the qname of the child
* elements to be returned
*
* @return an Iterator object over all the elements
* in this SOAPElement object with the
* specified qname
* @see SOAPElement#getChildElements(Name)
* @since SAAJ 1.3
*/
public Iterator getChildElements(QName qname);
/**
* Sets the encoding style for this SOAPElement object
* to one specified.
*
* @param encodingStyle a String giving the encoding style
*
* @exception IllegalArgumentException if there was a problem in the
* encoding style being set.
* @exception SOAPException if setting the encodingStyle is invalid for this SOAPElement.
* @see #getEncodingStyle
*/
public void setEncodingStyle(String encodingStyle)
throws SOAPException;
/**
* Returns the encoding style for this SOAPElement object.
*
* @return a String giving the encoding style
*
* @see #setEncodingStyle
*/
public String getEncodingStyle();
}