org.jboss.ws.core.soap

Class SOAPElementImpl

java.lang.Object

org.jboss.ws.core.soap.NodeImpl

org.jboss.ws.core.soap.SOAPElementImpl

All Implemented Interfaces:

SOAPElement, Element, Node

Direct Known Subclasses:

DetailEntryImpl, SOAPBodyElementMessage, SOAPBodyElementRpc, SOAPBodyImpl, SOAPContentElement, SOAPEnvelopeImpl, SOAPFaultElementImpl, SOAPHeaderImpl

public class SOAPElementImpl
extends NodeImpl
implements SOAPElement

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.

Author:

Thomas.Diesler@jboss.org

Field Summary

Fields inherited from class org.jboss.ws.core.soap.NodeImpl

domNode, soapParent

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Modifier	Constructor and Description
	SOAPElementImpl(Name name) Called by SOAPFactory
	SOAPElementImpl(QName qname) Called by SOAPFactory
protected	SOAPElementImpl(SOAPElementImpl element) Copy constructor for converting SOAPElement types
	SOAPElementImpl(String localPart) Called by SOAPFactory
	SOAPElementImpl(String localPart, String prefix, String nsURI) Called by SOAPFactory

Method Summary

Methods

Modifier and Type	Method and Description
SOAPElement	addAttribute(Name name, String value) Adds an attribute with the specified name and value to this SOAPElement object.
SOAPElement	addAttribute(QName qname, String value)
SOAPElement	addChildElement(Name name) Creates a new SOAPElement object initialized with the given Name object and adds the new element to this SOAPElement object.
SOAPElement	addChildElement(QName qname)
SOAPElement	addChildElement(SOAPElement child) Add a SOAPElement as a child of this SOAPElement instance.
SOAPElement	addChildElement(String name) Creates a new SOAPElement object initialized with the specified local name and adds the new element to this SOAPElement object.
SOAPElement	addChildElement(String localName, String prefix) Creates a new SOAPElement object initialized with the specified local name and prefix and adds the new element to this SOAPElement object.
SOAPElement	addChildElement(String localName, String prefix, String uri) Creates a new SOAPElement object initialized with the specified local name, prefix, and URI and adds the new element to this SOAPElement object.
SOAPElement	addNamespaceDeclaration(String prefix, String nsURI) Adds a namespace declaration with the specified prefix and URI to this SOAPElement object.
SOAPElement	addTextNode(String value) Creates a new Text object initialized with the given String and adds it to this SOAPElement object.
QName	createQName(String localName, String prefix) Creates a QName whose namespace URI is the one associated with the parameter, prefix, in the context of this SOAPElement.
Iterator<Name>	getAllAttributes() Returns an Iterator over all of the attribute Name objects in this SOAPElement object.
Iterator<QName>	getAllAttributesAsQNames()
String	getAttribute(String name)
Attr	getAttributeNode(String name)
Attr	getAttributeNodeNS(String namespaceURI, String localName)
String	getAttributeNS(String namespaceURI, String localName)
String	getAttributeValue(Name name) Returns the value of the attribute with the specified name.
String	getAttributeValue(QName qname)
Iterator<Node>	getChildElements() Returns an Iterator over all the immediate child Nodes of this element.
Iterator<SOAPElement>	getChildElements(Name name) Returns an Iterator over all the immediate child Nodes of this element with the specified name.
Iterator<SOAPElement>	getChildElements(QName qname)
Name	getElementName() Returns the name of this SOAPElement object.
QName	getElementQName()
NodeList	getElementsByTagName(String name)
NodeList	getElementsByTagNameNS(String namespaceURI, String localName)
String	getEncodingStyle() Returns the encoding style for this SOAPElement object.
protected SOAPElement	getFirstChildElementByLocalName(String localName)
Iterator<String>	getNamespacePrefixes() Returns an Iterator over the namespace prefix Strings declared by this element.
String	getNamespaceURI(String prefix) Returns the URI of the namespace that has the given prefix.
TypeInfo	getSchemaTypeInfo()
SOAPEnvelope	getSOAPEnvelope() Get the SOAPEnvelope for this SOAPElement
String	getTagName()
Iterator<String>	getVisibleNamespacePrefixes() Returns an Iterator over the namespace prefix Strings visible to this element.
boolean	hasAttribute(String name)
boolean	hasAttributeNS(String namespaceURI, String localName)
boolean	removeAttribute(Name name) Removes the attribute with the specified name.
boolean	removeAttribute(QName qname)
void	removeAttribute(String name)
Attr	removeAttributeNode(Attr oldAttr)
void	removeAttributeNS(String namespaceURI, String localName)
void	removeContents() Detaches all children of this SOAPElement.
boolean	removeNamespaceDeclaration(String prefix) Removes the namespace declaration corresponding to the given prefix.
void	setAttribute(String name, String value)
Attr	setAttributeNode(Attr newAttr)
Attr	setAttributeNodeNS(Attr newAttr)
void	setAttributeNS(String namespaceURI, String qualifiedName, String value)
SOAPElement	setElementQName(QName qname) Changes the name of this Element to newName if possible.
SOAPElement	setElementQNameInternal(QName qname)
void	setEncodingStyle(String encodingStyle) Sets the encoding style for this SOAPElement object to one specified.
void	setIdAttribute(String name, boolean isId)
void	setIdAttributeNode(Attr idAttr, boolean isId)
void	setIdAttributeNS(String namespaceURI, String localName, boolean isId)
void	setPrefix(String prefix)
void	writeElement(Writer writer) The default implementation uses a DOMWriter.
protected void	writeElementContent(Writer out)

Methods inherited from class org.jboss.ws.core.soap.NodeImpl

appendChild, cloneNode, compareDocumentPosition, detachNode, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, getValue, hasAttributes, hasChildNodes, hashCode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, removeChild, replaceChild, setNodeValue, setParentElement, setTextContent, setUserData, setValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.soap.Node

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setTextContent, setUserData

Constructor Detail

SOAPElementImpl

public SOAPElementImpl(String localPart)

Called by SOAPFactory

SOAPElementImpl

public SOAPElementImpl(String localPart,
               String prefix,
               String nsURI)

Called by SOAPFactory

SOAPElementImpl

public SOAPElementImpl(Name name)

Called by SOAPFactory

SOAPElementImpl

public SOAPElementImpl(QName qname)

Called by SOAPFactory

SOAPElementImpl

protected SOAPElementImpl(SOAPElementImpl element)

Copy constructor for converting SOAPElement types

Method Detail

getSOAPEnvelope

public SOAPEnvelope getSOAPEnvelope()

Get the SOAPEnvelope for this SOAPElement

getElementQName

public QName getElementQName()

Specified by:

getElementQName in interface SOAPElement

setElementQName

public SOAPElement setElementQName(QName qname)
                            throws SOAPException

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.

Specified by:

setElementQName in interface SOAPElement

Parameters:

qname - the new name for the Element.

Returns:

The renamed Node

Throws:

SOAPException - if changing the name of this Element is not allowed.

setElementQNameInternal

public SOAPElement setElementQNameInternal(QName qname)
                                    throws SOAPException

Throws:

SOAPException

addAttribute

public SOAPElement addAttribute(Name name,
                       String value)
                         throws SOAPException

Adds an attribute with the specified name and value to this SOAPElement object.

Specified by:

addAttribute in interface SOAPElement

Parameters:

name - a Name object with the name of the attribute

value - a String giving the value of the attribute

Returns:

the SOAPElement object into which the attribute was inserted

Throws:

SOAPException - if there is an error in creating the Attribute

addAttribute

public SOAPElement addAttribute(QName qname,
                       String value)
                         throws SOAPException

Specified by:

addAttribute in interface SOAPElement

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(String name)
                            throws SOAPException

Creates a new SOAPElement object initialized with the specified local name and adds the new element to this SOAPElement object.

Specified by:

addChildElement in interface SOAPElement

Parameters:

name - a String giving the local name for the element

Returns:

the new SOAPElement object that was created

Throws:

SOAPException - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement addChildElement(String localName,
                          String prefix)
                            throws SOAPException

Creates a new SOAPElement object initialized with the specified local name and prefix and adds the new element to this SOAPElement object.

Specified by:

addChildElement in interface SOAPElement

Parameters:

localName - a String giving the local name for the new element

prefix - a String giving the namespace prefix for the new element

Returns:

the new SOAPElement object that was created

Throws:

SOAPException - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement addChildElement(String localName,
                          String prefix,
                          String uri)
                            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.

Specified by:

addChildElement in interface SOAPElement

Parameters:

localName - a String giving the local name for the new element

prefix - a String giving the namespace prefix for the new element

uri - a String giving the URI of the namespace to which the new element belongs

Returns:

the new SOAPElement object that was created

Throws:

SOAPException - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement addChildElement(Name name)
                            throws SOAPException

Creates a new SOAPElement object initialized with the given Name object and adds the new element to this SOAPElement object.

Specified by:

addChildElement in interface SOAPElement

Parameters:

name - a Name object with the XML name for the new element

Returns:

the new SOAPElement object that was created

Throws:

SOAPException - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement addChildElement(QName qname)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(SOAPElement child)
                            throws SOAPException

Add a SOAPElement as a child of this SOAPElement instance. The SOAPElement is expected to be created by a SOAPElementFactory.

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.

Specified by:

addChildElement in interface SOAPElement

Parameters:

child - the SOAPElement to be added as a new child

Returns:

an instance representing the new SOAP element that was actually added to the tree.

Throws:

SOAPException - if there was an error in adding this element as a child

addNamespaceDeclaration

public SOAPElement addNamespaceDeclaration(String prefix,
                                  String nsURI)

Adds a namespace declaration with the specified prefix and URI to this SOAPElement object.

Specified by:

addNamespaceDeclaration in interface SOAPElement

Parameters:

prefix - a String giving the prefix of the namespace

nsURI - a String giving the uri of the namespace

Returns:

the SOAPElement object into which this namespace declaration was inserted.

Throws:

SOAPException - if there is an error in creating the namespace

addTextNode

public SOAPElement addTextNode(String value)
                        throws SOAPException

Creates a new Text object initialized with the given String and adds it to this SOAPElement object.

Specified by:

addTextNode in interface SOAPElement

Parameters:

value - a String object with the textual content to be added

Returns:

the SOAPElement object into which the new Text object was inserted

Throws:

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

getAllAttributes

public Iterator<Name> getAllAttributes()

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.

Specified by:

getAllAttributes in interface SOAPElement

Returns:

an iterator over the names of the attributes

getAllAttributesAsQNames

public Iterator<QName> getAllAttributesAsQNames()

Specified by:

getAllAttributesAsQNames in interface SOAPElement

getAttributeValue

public String getAttributeValue(Name name)

Returns the value of the attribute with the specified name.

Specified by:

getAttributeValue in interface SOAPElement

Parameters:

name - a Name object with the name of the attribute

Returns:

a String giving the value of the specified attribute

getAttributeValue

public String getAttributeValue(QName qname)

Specified by:

getAttributeValue in interface SOAPElement

createQName

public QName createQName(String localName,
                String prefix)
                  throws SOAPException

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.

Specified by:

createQName in interface SOAPElement

Parameters:

localName - a String containing the local part of the name.

prefix - a String containing the prefix for the name.

Returns:

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 getNamespaceURI(String) if it were given prefix as it's parameter.

Throws:

SOAPException - if the QName cannot be created.

Since:

SAAJ 1.3

getChildElements

public Iterator<Node> getChildElements()

Returns an Iterator over all the immediate child Nodes 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 javax.xml.soap for more details.

Specified by:

getChildElements in interface SOAPElement

Returns:

an iterator with the content of this SOAPElement object

getFirstChildElementByLocalName

protected SOAPElement getFirstChildElementByLocalName(String localName)

getChildElements

public Iterator<SOAPElement> getChildElements(Name name)

Returns an Iterator over all the immediate child Nodes 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 javax.xml.soap for more details.

Specified by:

getChildElements in interface SOAPElement

Parameters:

name - a Name object with the name of the child elements to be returned

Returns:

an Iterator object over all the elements in this SOAPElement object with the specified name

getChildElements

public Iterator<SOAPElement> getChildElements(QName qname)

Specified by:

getChildElements in interface SOAPElement

getElementName

public Name getElementName()

Returns the name of this SOAPElement object.

Specified by:

getElementName in interface SOAPElement

Returns:

a Name object with the name of this SOAPElement object

getNamespacePrefixes

public Iterator<String> getNamespacePrefixes()

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.

Specified by:

getNamespacePrefixes in interface SOAPElement

Returns:

an iterator over the namespace prefixes in this SOAPElement object

getNamespaceURI

public String getNamespaceURI(String prefix)

Returns the URI of the namespace that has the given prefix.

Specified by:

getNamespaceURI in interface SOAPElement

Parameters:

prefix - a String giving the prefix of the namespace for which to search

Returns:

a String with the uri of the namespace that has the given prefix

getVisibleNamespacePrefixes

public Iterator<String> getVisibleNamespacePrefixes()

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.

Specified by:

getVisibleNamespacePrefixes in interface SOAPElement

Returns:

an iterator over the namespace prefixes are within scope of this SOAPElement object

removeAttribute

public boolean removeAttribute(Name name)

Removes the attribute with the specified name.

Specified by:

removeAttribute in interface SOAPElement

Parameters:

name - the Name object with the name of the attribute to be removed

Returns:

true if the attribute was removed successfully; false if it was not

removeAttribute

public boolean removeAttribute(QName qname)

Specified by:

removeAttribute in interface SOAPElement

removeContents

public void removeContents()

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.

Specified by:

removeContents in interface SOAPElement

removeNamespaceDeclaration

public boolean removeNamespaceDeclaration(String prefix)

Removes the namespace declaration corresponding to the given prefix.

Specified by:

removeNamespaceDeclaration in interface SOAPElement

Parameters:

prefix - a String giving the prefix for which to search

Returns:

true if the namespace declaration was removed successfully; false if it was not

getEncodingStyle

public String getEncodingStyle()

Returns the encoding style for this SOAPElement object.

Specified by:

getEncodingStyle in interface SOAPElement

Returns:

a String giving the encoding style

setEncodingStyle

public void setEncodingStyle(String encodingStyle)
                      throws SOAPException

Sets the encoding style for this SOAPElement object to one specified.

Specified by:

setEncodingStyle in interface SOAPElement

Parameters:

encodingStyle - a String giving the encoding style

Throws:

IllegalArgumentException - if there was a problem in the encoding style being set.

SOAPException - if setting the encodingStyle is invalid for this SOAPElement.

See Also:

http://www.w3.org/TR/2000/NOTE-SOAP-20000508/#_Toc478383495, http://www.w3.org/TR/soap12-part1/#soapencattr

getTagName

public String getTagName()

Specified by:

getTagName in interface Element

removeAttribute

public void removeAttribute(String name)
                     throws DOMException

Specified by:

removeAttribute in interface Element

Throws:

DOMException

hasAttribute

public boolean hasAttribute(String name)

Specified by:

hasAttribute in interface Element

getAttribute

public String getAttribute(String name)

Specified by:

getAttribute in interface Element

removeAttributeNS

public void removeAttributeNS(String namespaceURI,
                     String localName)
                       throws DOMException

Specified by:

removeAttributeNS in interface Element

Throws:

DOMException

setAttribute

public void setAttribute(String name,
                String value)
                  throws DOMException

Specified by:

setAttribute in interface Element

Throws:

DOMException

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI,
                     String localName)

Specified by:

hasAttributeNS in interface Element

getAttributeNode

public Attr getAttributeNode(String name)

Specified by:

getAttributeNode in interface Element

removeAttributeNode

public Attr removeAttributeNode(Attr oldAttr)
                         throws DOMException

Specified by:

removeAttributeNode in interface Element

Throws:

DOMException

setAttributeNode

public Attr setAttributeNode(Attr newAttr)
                      throws DOMException

Specified by:

setAttributeNode in interface Element

Throws:

DOMException

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr newAttr)
                        throws DOMException

Specified by:

setAttributeNodeNS in interface Element

Throws:

DOMException

getElementsByTagName

public NodeList getElementsByTagName(String name)

Specified by:

getElementsByTagName in interface Element

getAttributeNS

public String getAttributeNS(String namespaceURI,
                    String localName)

Specified by:

getAttributeNS in interface Element

setAttributeNS

public void setAttributeNS(String namespaceURI,
                  String qualifiedName,
                  String value)
                    throws DOMException

Specified by:

setAttributeNS in interface Element

Throws:

DOMException

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI,
                      String localName)

Specified by:

getAttributeNodeNS in interface Element

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                              String localName)

Specified by:

getElementsByTagNameNS in interface Element

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()

Specified by:

getSchemaTypeInfo in interface Element

setIdAttribute

public void setIdAttribute(String name,
                  boolean isId)
                    throws DOMException

Specified by:

setIdAttribute in interface Element

Throws:

DOMException

setIdAttributeNode

public void setIdAttributeNode(Attr idAttr,
                      boolean isId)
                        throws DOMException

Specified by:

setIdAttributeNode in interface Element

Throws:

DOMException

setIdAttributeNS

public void setIdAttributeNS(String namespaceURI,
                    String localName,
                    boolean isId)
                      throws DOMException

Specified by:

setIdAttributeNS in interface Element

Throws:

DOMException

setPrefix

public void setPrefix(String prefix)
               throws DOMException

Specified by:

setPrefix in interface Node

Overrides:

setPrefix in class NodeImpl

Throws:

DOMException

writeElement

public void writeElement(Writer writer)
                  throws IOException

The default implementation uses a DOMWriter. SOAPContentElements overwrite this to optimize DOM callbacks.

Throws:

IOException

writeElementContent

protected void writeElementContent(Writer out)
                            throws IOException

Throws:

IOException