org.apache.axis2.saaj
Class SOAPPartImpl

java.lang.Object
  javax.xml.soap.SOAPPart
      org.apache.axis2.saaj.SOAPPartImpl

All Implemented Interfaces:

org.w3c.dom.Document, org.w3c.dom.Node

public class SOAPPartImpl
extends SOAPPart

Field Summary

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

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

SOAPPartImpl(SOAPMessageImpl parentSoapMsg, java.io.InputStream inputStream)

SOAPPartImpl(SOAPMessageImpl parentSoapMsg, java.io.InputStream inputStream, MimeHeaders mimeHeaders)

SOAPPartImpl(SOAPMessageImpl parentSoapMsg, SOAPEnvelopeImpl soapEnvelope)

Method Summary

void	addMimeHeader(java.lang.String header, java.lang.String value) Creates a MimeHeader object with the specified name and value and adds it to this SOAPPart object.
org.w3c.dom.Node	adoptNode(org.w3c.dom.Node source)
org.w3c.dom.Node	appendChild(org.w3c.dom.Node newChild) Adds the node newChild to the end of the list of children of this node.
org.w3c.dom.Node	cloneNode(boolean deep) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
short	compareDocumentPosition(org.w3c.dom.Node node)
org.w3c.dom.Attr	createAttribute(java.lang.String name) Creates an Attr of the given name.
org.w3c.dom.Attr	createAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName) Creates an attribute of the given qualified name and namespace URI.
org.w3c.dom.CDATASection	createCDATASection(java.lang.String data) Creates a CDATASection node whose value is the specified string.
org.w3c.dom.Comment	createComment(java.lang.String data) Creates a CDATASection node whose value is the specified string.
org.w3c.dom.DocumentFragment	createDocumentFragment() Creates an empty DocumentFragment object.
org.w3c.dom.Element	createElement(java.lang.String tagName) Creates an element of the type specified.
org.w3c.dom.Element	createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName) Creates an element of the given qualified name and namespace URI.
org.w3c.dom.EntityReference	createEntityReference(java.lang.String name) Creates an EntityReference object.
org.w3c.dom.ProcessingInstruction	createProcessingInstruction(java.lang.String target, java.lang.String data) Creates a ProcessingInstruction node given the specified name and data strings.
org.w3c.dom.Text	createTextNode(java.lang.String data) Creates a Text node given the specified string.
void	detachNode()
java.util.Iterator	getAllMimeHeaders() Retrieves all the headers for this SOAPPart object as an iterator over the MimeHeader objects.
org.w3c.dom.NamedNodeMap	getAttributes() A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
java.lang.String	getBaseURI()
org.w3c.dom.NodeList	getChildNodes() A NodeList that contains all children of this node.
javax.xml.transform.Source	getContent() Returns the content of the SOAPEnvelope as a JAXP Source object.
org.w3c.dom.DocumentType	getDoctype() The Document Type Declaration (see DocumentType) associated with this document.
org.w3c.dom.Element	getDocumentElement() This is a convenience attribute that allows direct access to the child node that is the root element of the document.
java.lang.String	getDocumentURI()
org.w3c.dom.DOMConfiguration	getDomConfig()
org.w3c.dom.Element	getElementById(java.lang.String elementId) Returns the Element whose ID is given by elementId.
org.w3c.dom.NodeList	getElementsByTagName(java.lang.String tagname) Returns a NodeList of all the Elements with a given tag name in the order in which they are encountered in a preorder traversal of the Document tree.
org.w3c.dom.NodeList	getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName) Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of the Document tree.
SOAPEnvelope	getEnvelope() Gets the SOAPEnvelope object associated with this SOAPPart object.
java.lang.Object	getFeature(java.lang.String feature, java.lang.String version)
org.w3c.dom.Node	getFirstChild() The first child of this node.
org.w3c.dom.DOMImplementation	getImplementation() The DOMImplementation object that handles this document.
java.lang.String	getInputEncoding()
org.w3c.dom.Node	getLastChild() The last child of this node.
java.lang.String	getLocalName() Returns the local part of the qualified name of this node.
java.util.Iterator	getMatchingMimeHeaders(java.lang.String[] names) Retrieves all MimeHeader objects that match a name in the given array.
java.lang.String[]	getMimeHeader(java.lang.String name) Gets all the values of the MimeHeader object in this SOAPPart object that is identified by the given String.
java.lang.String	getNamespaceURI() The namespace URI of this node, or null if it is unspecified.
org.w3c.dom.Node	getNextSibling() The node immediately following this node.
java.lang.String	getNodeName() The name of this node, depending on its type; see the table above.
short	getNodeType() A code representing the type of the underlying object, as defined above.
java.lang.String	getNodeValue() The value of this node, depending on its type; see the table above.
java.util.Iterator	getNonMatchingMimeHeaders(java.lang.String[] names) Retrieves all MimeHeader objects whose name does not match a name in the given array.
org.w3c.dom.Document	getOwnerDocument() The Document object associated with this node.
SOAPElement	getParentElement()
org.w3c.dom.Node	getParentNode() The parent of this node.
java.lang.String	getPrefix() The namespace prefix of this node, or null if it is unspecified.
org.w3c.dom.Node	getPreviousSibling() The node immediately preceding this node.
SOAPMessage	getSoapMessage() Obtain the SOAPMessage
boolean	getStrictErrorChecking()
java.lang.String	getTextContent()
java.lang.Object	getUserData(java.lang.String key)
java.lang.String	getValue()
java.lang.String	getXmlEncoding()
boolean	getXmlStandalone()
java.lang.String	getXmlVersion()
boolean	hasAttributes() Returns whether this node (if it is an element) has any attributes.
boolean	hasChildNodes() Returns whether this node has any children.
org.w3c.dom.Node	importNode(org.w3c.dom.Node importedNode, boolean deep) Imports a node from another document to this document.
org.w3c.dom.Node	insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild) Inserts the node newChild before the existing child node refChild.
boolean	isDefaultNamespace(java.lang.String namespaceURI)
boolean	isEqualNode(org.w3c.dom.Node node)
boolean	isSameNode(org.w3c.dom.Node other)
boolean	isSupported(java.lang.String feature, java.lang.String version) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
java.lang.String	lookupNamespaceURI(java.lang.String prefix)
java.lang.String	lookupPrefix(java.lang.String namespaceURI)
void	normalize() Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.
void	normalizeDocument()
void	recycleNode()
void	removeAllMimeHeaders() Removes all the MimeHeader objects for this SOAPEnvelope object.
org.w3c.dom.Node	removeChild(org.w3c.dom.Node oldChild) Removes the child node indicated by oldChild from the list of children, and returns it.
void	removeMimeHeader(java.lang.String header) Removes all MIME headers that match the given name.
org.w3c.dom.Node	renameNode(org.w3c.dom.Node n, java.lang.String namespaceURI, java.lang.String qualifiedName)
org.w3c.dom.Node	replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild) Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
void	setContent(javax.xml.transform.Source source) Sets the content of the SOAPEnvelope object with the data from the given Source object.
void	setDocumentURI(java.lang.String documentURI)
protected void	setMessage(SOAPMessageImpl message)
void	setMimeHeader(java.lang.String name, java.lang.String value) Changes the first header entry that matches the given header name so that its value is the given value, adding a new header with the given name and value if no existing header is a match.
void	setNodeValue(java.lang.String arg0) The value of this node, depending on its type; see the table above.
void	setParentElement(SOAPElement parent)
void	setPrefix(java.lang.String arg0) The namespace prefix of this node, or null if it is unspecified.
void	setStrictErrorChecking(boolean strictErrorChecking)
void	setTextContent(java.lang.String textContent)
java.lang.Object	setUserData(java.lang.String key, java.lang.Object data, org.w3c.dom.UserDataHandler handler)
void	setValue(java.lang.String value)
void	setXmlStandalone(boolean xmlStandalone)
void	setXmlVersion(java.lang.String xmlVersion)

Methods inherited from class javax.xml.soap.SOAPPart

getContentId, getContentLocation, setContentId, setContentLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

SOAPPartImpl

public SOAPPartImpl(SOAPMessageImpl parentSoapMsg,
                    SOAPEnvelopeImpl soapEnvelope)

SOAPPartImpl

public SOAPPartImpl(SOAPMessageImpl parentSoapMsg,
                    java.io.InputStream inputStream,
                    MimeHeaders mimeHeaders)
             throws SOAPException

Throws:

SOAPException

SOAPPartImpl

public SOAPPartImpl(SOAPMessageImpl parentSoapMsg,
                    java.io.InputStream inputStream)
             throws SOAPException

Throws:

SOAPException

Method Detail

getSoapMessage

public SOAPMessage getSoapMessage()

Obtain the SOAPMessage

Returns:

the related SOAPMessage

getEnvelope

public SOAPEnvelope getEnvelope()
                         throws SOAPException

Gets the SOAPEnvelope object associated with this SOAPPart object. Once the SOAP envelope is obtained, it can be used to get its contents.

Specified by:

getEnvelope in class SOAPPart

Returns:

the SOAPEnvelope object for this SOAPPart object

Throws:

SOAPException - if there is a SOAP error

removeMimeHeader

public void removeMimeHeader(java.lang.String header)

Removes all MIME headers that match the given name.

Specified by:

removeMimeHeader in class SOAPPart

Parameters:

header - a String giving the name of the MIME header(s) to be removed

removeAllMimeHeaders

public void removeAllMimeHeaders()

Removes all the MimeHeader objects for this SOAPEnvelope object.

Specified by:

removeAllMimeHeaders in class SOAPPart

getMimeHeader

public java.lang.String[] getMimeHeader(java.lang.String name)

Gets all the values of the MimeHeader object in this SOAPPart object that is identified by the given String.

Specified by:

getMimeHeader in class SOAPPart

Parameters:

name - the name of the header; example: "Content-Type"

Returns:

a String array giving all the values for the specified header

See Also:

setMimeHeader(java.lang.String, java.lang.String)

setMimeHeader

public void setMimeHeader(java.lang.String name,
                          java.lang.String value)

Changes the first header entry that matches the given header name so that its value is the given value, adding a new header with the given name and value if no existing header is a match. If there is a match, this method clears all existing values for the first header that matches and sets the given value instead. If more than one header has the given name, this method removes all of the matching headers after the first one.

Note that RFC822 headers can contain only US-ASCII characters.

Specified by:

setMimeHeader in class SOAPPart

Parameters:

name - a String giving the header name for which to search

value - a String giving the value to be set. This value will be substituted for the current value(s) of the first header that is a match if there is one. If there is no match, this value will be the value for a new MimeHeader object.

Throws:

java.lang.IllegalArgumentException - if there was a problem with the specified mime header name or value

java.lang.IllegalArgumentException - if there was a problem with the specified mime header name or value

See Also:

getMimeHeader(java.lang.String)

addMimeHeader

public void addMimeHeader(java.lang.String header,
                          java.lang.String value)

Creates a MimeHeader object with the specified name and value and adds it to this SOAPPart object. If a MimeHeader with the specified name already exists, this method adds the specified value to the already existing value(s).

Note that RFC822 headers can contain only US-ASCII characters.

Specified by:

addMimeHeader in class SOAPPart

Parameters:

header - a String giving the header name

value - a String giving the value to be set or added

Throws:

java.lang.IllegalArgumentException - if there was a problem with the specified mime header name or value

getAllMimeHeaders

public java.util.Iterator getAllMimeHeaders()

Retrieves all the headers for this SOAPPart object as an iterator over the MimeHeader objects.

Specified by:

getAllMimeHeaders in class SOAPPart

Returns:

an Iterator object with all of the Mime headers for this SOAPPart object

getMatchingMimeHeaders

public java.util.Iterator getMatchingMimeHeaders(java.lang.String[] names)

Retrieves all MimeHeader objects that match a name in the given array.

Specified by:

getMatchingMimeHeaders in class SOAPPart

Parameters:

names - a String array with the name(s) of the MIME headers to be returned

Returns:

all of the MIME headers that match one of the names in the given array, returned as an Iterator object

getNonMatchingMimeHeaders

public java.util.Iterator getNonMatchingMimeHeaders(java.lang.String[] names)

Retrieves all MimeHeader objects whose name does not match a name in the given array.

Specified by:

getNonMatchingMimeHeaders in class SOAPPart

Parameters:

names - a String array with the name(s) of the MIME headers not to be returned

Returns:

all of the MIME headers in this SOAPPart object except those that match one of the names in the given array. The nonmatching MIME headers are returned as an Iterator object.

setContent

public void setContent(javax.xml.transform.Source source)
                throws SOAPException

Description copied from class: SOAPPart

Sets the content of the SOAPEnvelope object with the data from the given Source object.

Specified by:

setContent in class SOAPPart

Parameters:

source - javax.xml.transform.Source object with the data to be set

Throws:

SOAPException - if there is a problem in setting the source

See Also:

getContent()

getContent

public javax.xml.transform.Source getContent()
                                      throws SOAPException

Returns the content of the SOAPEnvelope as a JAXP Source object.

Specified by:

getContent in class SOAPPart

Returns:

the content as a javax.xml.transform.Source object

Throws:

SOAPException - if the implementation cannot convert the specified Source object

See Also:

setContent(javax.xml.transform.Source)

getDoctype

public org.w3c.dom.DocumentType getDoctype()

The Document Type Declaration (see DocumentType) associated with this document. For HTML documents as well as XML documents without a document type declaration this returns null. The DOM Level 2 does not support editing the Document Type Declaration. docType cannot be altered in any way, including through the use of methods inherited from the Node interface, such as insertNode or removeNode.

getImplementation

public org.w3c.dom.DOMImplementation getImplementation()

The DOMImplementation object that handles this document. A DOM application may use objects from multiple implementations.

getDocumentElement

public org.w3c.dom.Element getDocumentElement()

This is a convenience attribute that allows direct access to the child node that is the root element of the document. For HTML documents, this is the element with the tagName "HTML".

createElement

public org.w3c.dom.Element createElement(java.lang.String tagName)
                                  throws org.w3c.dom.DOMException

Creates an element of the type specified. Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object.
In addition, if there are known attributes with default values, Attr nodes representing them are automatically created and attached to the element.
To create an element with a qualified name and namespace URI, use the createElementNS method.

Parameters:

tagName - The name of the element type to instantiate. For XML, this is case-sensitive. For HTML, the tagName parameter may be provided in any case, but it must be mapped to the canonical uppercase form by the DOM implementation.

Returns:

A new Element object with the nodeName attribute set to tagName, and localName, prefix, and namespaceURI set to null.

Throws:

org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

createDocumentFragment

public org.w3c.dom.DocumentFragment createDocumentFragment()

Creates an empty DocumentFragment object.

Returns:

A new DocumentFragment.

createTextNode

public org.w3c.dom.Text createTextNode(java.lang.String data)

Creates a Text node given the specified string.

Parameters:

data - The data for the node.

Returns:

The new Text object.

createComment

public org.w3c.dom.Comment createComment(java.lang.String data)

Creates a CDATASection node whose value is the specified string.

Parameters:

data - The data for the CDATASection contents.

Returns:

The new CDATASection object.

Throws:

org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

createCDATASection

public org.w3c.dom.CDATASection createCDATASection(java.lang.String data)
                                            throws org.w3c.dom.DOMException

Creates a CDATASection node whose value is the specified string.

Parameters:

data - The data for the CDATASection contents.

Returns:

The new CDATASection object.

Throws:

org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

createProcessingInstruction

public org.w3c.dom.ProcessingInstruction createProcessingInstruction(java.lang.String target,
                                                                     java.lang.String data)
                                                              throws org.w3c.dom.DOMException

Creates a ProcessingInstruction node given the specified name and data strings.

Parameters:

target - The target part of the processing instruction.

data - The data for the node.

Returns:

The new ProcessingInstruction object.

Throws:

org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified target contains an illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

createAttribute

public org.w3c.dom.Attr createAttribute(java.lang.String name)
                                 throws org.w3c.dom.DOMException

Creates an Attr of the given name. Note that the Attr instance can then be set on an Element using the setAttributeNode method.
To create an attribute with a qualified name and namespace URI, use the createAttributeNS method.

Parameters:

name - The name of the attribute.

Returns:

A new Attr object with the nodeName attribute set to name, and localName, prefix, and namespaceURI set to null. The value of the attribute is the empty string.

Throws:

org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

createEntityReference

public org.w3c.dom.EntityReference createEntityReference(java.lang.String name)
                                                  throws org.w3c.dom.DOMException

Creates an EntityReference object. In addition, if the referenced entity is known, the child list of the EntityReference node is made the same as that of the corresponding Entity node.If any descendant of the Entity node has an unbound namespace prefix, the corresponding descendant of the created EntityReference node is also unbound; (its namespaceURI is null). The DOM Level 2 does not support any mechanism to resolve namespace prefixes.

Parameters:

name - The name of the entity to reference.

Returns:

The new EntityReference object.

Throws:

org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

getElementsByTagName

public org.w3c.dom.NodeList getElementsByTagName(java.lang.String tagname)

Returns a NodeList of all the Elements with a given tag name in the order in which they are encountered in a preorder traversal of the Document tree.

Parameters:

tagname - The name of the tag to match on. The special value "*" matches all tags.

Returns:

A new NodeList object containing all the matched Elements.

importNode

public org.w3c.dom.Node importNode(org.w3c.dom.Node importedNode,
                                   boolean deep)
                            throws org.w3c.dom.DOMException

Imports a node from another document to this document. The returned node has no parent; (parentNode is null). The source node is not altered or removed from the original document; this method creates a new copy of the source node.
For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node's nodeName and nodeType, plus the attributes related to namespaces (prefix, localName, and namespaceURI). As in the cloneNode operation on a Node, the source node is not altered.
Additional information is copied as appropriate to the nodeType, attempting to mirror the behavior expected if a fragment of XML or HTML source was copied from one document to another, recognizing that the two documents may have different DTDs in the XML case. The following list describes the specifics for each type of node.

ATTRIBUTE_NODE

The ownerElement attribute is set to null and the specified flag is set to true on the generated Attr. The descendants of the source Attr are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Note that the deep parameter has no effect on Attr nodes; they always carry their children with them when imported.

DOCUMENT_FRAGMENT_NODE

If the deep option was set to true, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Otherwise, this simply generates an empty DocumentFragment.

DOCUMENT_NODE

Document nodes cannot be imported.

DOCUMENT_TYPE_NODE

DocumentType nodes cannot be imported.

ELEMENT_NODE

Specified attribute nodes of the source element are imported, and the generated Attr nodes are attached to the generated Element. Default attributes are not copied, though if the document being imported into defines default attributes for this element name, those are assigned. If the importNode deep parameter was set to true, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree.

ENTITY_NODE

Entity nodes can be imported, however in the current release of the DOM the DocumentType is readonly. Ability to add these imported nodes to a DocumentType will be considered for addition to a future release of the DOM.On import, the publicId, systemId, and notationName attributes are copied. If a deep import is requested, the descendants of the the source Entity are recursively imported and the resulting nodes reassembled to form the corresponding subtree.

ENTITY_REFERENCE_NODE

Only the EntityReference itself is copied, even if a deep import is requested, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned.

NOTATION_NODE

Notation nodes can be imported, however in the current release of the DOM the DocumentType is readonly. Ability to add these imported nodes to a DocumentType will be considered for addition to a future release of the DOM.On import, the publicId and systemId attributes are copied. Note that the deep parameter has no effect on Notation nodes since they never have any children.

PROCESSING_INSTRUCTION_NODE

The imported node copies its target and data values from those of the source node.

TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE

These three types of nodes inheriting from CharacterData copy their data and length attributes from those of the source node.

Parameters:

importedNode - The node to import.

deep - If true, recursively import the subtree under the specified node; if false, import only the node itself, as explained above. This has no effect on Attr , EntityReference, and Notation nodes.

Returns:

The imported node that belongs to this Document.

Throws:

org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.

Since:

DOM Level 2

createElementNS

public org.w3c.dom.Element createElementNS(java.lang.String namespaceURI,
                                           java.lang.String qualifiedName)
                                    throws org.w3c.dom.DOMException

Creates an element of the given qualified name and namespace URI.

Parameters:

namespaceURI - The namespace URI of the element to create.

qualifiedName - The qualified name of the element type to instantiate.

Returns:

A new Element object with the following attributes:

Attribute	Value
Node.nodeName	qualifiedName
Node.namespaceURI	namespaceURI
Node.prefix	prefix, extracted from qualifiedName, or null if there is no prefix
Node.localName	local name, extracted from qualifiedName
Element.tagName	qualifiedName

Throws:

org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character, per the XML 1.0 specification .
NAMESPACE_ERR: Raised if the qualifiedName is malformed per the Namespaces in XML specification, if the qualifiedName has a prefix and the namespaceURI is null, or if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace" .
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.

Since:

DOM Level 2

createAttributeNS

public org.w3c.dom.Attr createAttributeNS(java.lang.String namespaceURI,
                                          java.lang.String qualifiedName)
                                   throws org.w3c.dom.DOMException

Creates an attribute of the given qualified name and namespace URI.

Parameters:

namespaceURI - The namespace URI of the attribute to create.

qualifiedName - The qualified name of the attribute to instantiate.

Returns:

A new Attr object with the following attributes:

Attribute	Value
Node.nodeName	qualifiedName
Node.namespaceURI	namespaceURI
Node.prefix	prefix, extracted from qualifiedName, or null if there is no prefix
Node.localName	local name, extracted from qualifiedName
Attr.name	qualifiedName
Node.nodeValue	the empty string

Throws:

org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character, per the XML 1.0 specification .
NAMESPACE_ERR: Raised if the qualifiedName is malformed per the Namespaces in XML specification, if the qualifiedName has a prefix and the namespaceURI is null, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace", or if the qualifiedName, or its prefix, is "xmlns" and the namespaceURI is different from " http://www.w3.org/2000/xmlns/".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.

Since:

DOM Level 2

getElementsByTagNameNS

public org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String namespaceURI,
                                                   java.lang.String localName)

Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of the Document tree.

Parameters:

namespaceURI - The namespace URI of the elements to match on. The special value "*" matches all namespaces.

localName - The local name of the elements to match on. The special value "*" matches all local names.

Returns:

A new NodeList object containing all the matched Elements.

Since:

DOM Level 2

getElementById

public org.w3c.dom.Element getElementById(java.lang.String elementId)

Returns the Element whose ID is given by elementId. If no such element exists, returns null. Behavior is not defined if more than one element has this ID. The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return null.

Parameters:

elementId - The unique id value for an element.

Returns:

The matching element.

Since:

DOM Level 2

getInputEncoding

public java.lang.String getInputEncoding()

getXmlEncoding

public java.lang.String getXmlEncoding()

getXmlStandalone

public boolean getXmlStandalone()

setXmlStandalone

public void setXmlStandalone(boolean xmlStandalone)
                      throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getXmlVersion

public java.lang.String getXmlVersion()

setXmlVersion

public void setXmlVersion(java.lang.String xmlVersion)
                   throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getStrictErrorChecking

public boolean getStrictErrorChecking()

setStrictErrorChecking

public void setStrictErrorChecking(boolean strictErrorChecking)

getDocumentURI

public java.lang.String getDocumentURI()

setDocumentURI

public void setDocumentURI(java.lang.String documentURI)

adoptNode

public org.w3c.dom.Node adoptNode(org.w3c.dom.Node source)
                           throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getDomConfig

public org.w3c.dom.DOMConfiguration getDomConfig()

normalizeDocument

public void normalizeDocument()

renameNode

public org.w3c.dom.Node renameNode(org.w3c.dom.Node n,
                                   java.lang.String namespaceURI,
                                   java.lang.String qualifiedName)
                            throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getNodeName

public java.lang.String getNodeName()

The name of this node, depending on its type; see the table above.

getNodeValue

public java.lang.String getNodeValue()
                              throws org.w3c.dom.DOMException

The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect.

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

org.w3c.dom.DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

setNodeValue

public void setNodeValue(java.lang.String arg0)
                  throws org.w3c.dom.DOMException

The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect.

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

org.w3c.dom.DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

getNodeType

public short getNodeType()

A code representing the type of the underlying object, as defined above.

getParentNode

public org.w3c.dom.Node getParentNode()

The parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is null.

getChildNodes

public org.w3c.dom.NodeList getChildNodes()

A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

getFirstChild

public org.w3c.dom.Node getFirstChild()

The first child of this node. If there is no such node, this returns null.

getLastChild

public org.w3c.dom.Node getLastChild()

The last child of this node. If there is no such node, this returns null.

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()

The node immediately preceding this node. If there is no such node, this returns null.

getNextSibling

public org.w3c.dom.Node getNextSibling()

The node immediately following this node. If there is no such node, this returns null.

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()

A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()

The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.

insertBefore

public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node refChild)
                              throws org.w3c.dom.DOMException

Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children.
If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed.

Parameters:

newChild - The node to insert.

refChild - The reference node, i.e., the node before which the new node must be inserted.

Returns:

The node being inserted.

Throws:

org.w3c.dom.DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to insert is one of this node's ancestors or this node itself.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.

replaceChild

public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node oldChild)
                              throws org.w3c.dom.DOMException

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed.

Parameters:

newChild - The new node to put in the child list.

oldChild - The node being replaced in the list.

Returns:

The node replaced.

Throws:

org.w3c.dom.DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to put in is one of this node's ancestors or this node itself.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

removeChild

public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
                             throws org.w3c.dom.DOMException

Removes the child node indicated by oldChild from the list of children, and returns it.

Parameters:

oldChild - The node being removed.

Returns:

The node removed.

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

appendChild

public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
                             throws org.w3c.dom.DOMException

Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed.

Parameters:

newChild - The node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node

Returns:

The node added.

Throws:

org.w3c.dom.DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to append is one of this node's ancestors or this node itself.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the previous parent of the node being inserted is readonly.

hasChildNodes

public boolean hasChildNodes()

Returns whether this node has any children.

Returns:

true if this node has any children, false otherwise.

cloneNode

public org.w3c.dom.Node cloneNode(boolean deep)

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent; ( parentNode is null.).
Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning an Attribute directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute ( specified is true). Cloning any other type of node simply returns a copy of this node.
Note that cloning an immutable subtree results in a mutable copy, but the children of an EntityReference clone are readonly . In addition, clones of unspecified Attr nodes are specified. And, cloning Document, DocumentType, Entity, and Notation nodes is implementation dependent.

Parameters:

deep - If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).

Returns:

The duplicate node.

normalize

public void normalize()

Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used.In cases where the document contains CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text nodes and CDATASection nodes.

isSupported

public boolean isSupported(java.lang.String feature,
                           java.lang.String version)

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

Parameters:

feature - The name of the feature to test. This is the same name which can be passed to the method hasFeature on DOMImplementation.

version - This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true.

Returns:

Returns true if the specified feature is supported on this node, false otherwise.

Since:

DOM Level 2

getNamespaceURI

public java.lang.String getNamespaceURI()

The namespace URI of this node, or null if it is unspecified.
This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.Per the Namespaces in XML Specification an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.

Since:

DOM Level 2

getPrefix

public java.lang.String getPrefix()

The namespace prefix of this node, or null if it is unspecified.
Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Throws:

org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character, per the XML 1.0 specification .
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specified prefix is malformed per the Namespaces in XML specification, if the namespaceURI of this node is null, if the specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from " http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of this node is "xmlns" .

Since:

DOM Level 2

setPrefix

public void setPrefix(java.lang.String arg0)
               throws org.w3c.dom.DOMException

The namespace prefix of this node, or null if it is unspecified.
Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Throws:

org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character, per the XML 1.0 specification .
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specified prefix is malformed per the Namespaces in XML specification, if the namespaceURI of this node is null, if the specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from " http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of this node is "xmlns" .

Since:

DOM Level 2

getLocalName

public java.lang.String getLocalName()

Returns the local part of the qualified name of this node.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Since:

DOM Level 2

hasAttributes

public boolean hasAttributes()

Returns whether this node (if it is an element) has any attributes.

Returns:

true if this node has any attributes, false otherwise.

Since:

DOM Level 2

setMessage

protected void setMessage(SOAPMessageImpl message)

getBaseURI

public java.lang.String getBaseURI()

compareDocumentPosition

public short compareDocumentPosition(org.w3c.dom.Node node)
                              throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getTextContent

public java.lang.String getTextContent()
                                throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

setTextContent

public void setTextContent(java.lang.String textContent)
                    throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

isSameNode

public boolean isSameNode(org.w3c.dom.Node other)

lookupPrefix

public java.lang.String lookupPrefix(java.lang.String namespaceURI)

isDefaultNamespace

public boolean isDefaultNamespace(java.lang.String namespaceURI)

lookupNamespaceURI

public java.lang.String lookupNamespaceURI(java.lang.String prefix)

isEqualNode

public boolean isEqualNode(org.w3c.dom.Node node)

getFeature

public java.lang.Object getFeature(java.lang.String feature,
                                   java.lang.String version)

setUserData

public java.lang.Object setUserData(java.lang.String key,
                                    java.lang.Object data,
                                    org.w3c.dom.UserDataHandler handler)

getUserData

public java.lang.Object getUserData(java.lang.String key)

getValue

public java.lang.String getValue()

setParentElement

public void setParentElement(SOAPElement parent)
                      throws SOAPException

Throws:

SOAPException

getParentElement

public SOAPElement getParentElement()

detachNode

public void detachNode()

recycleNode

public void recycleNode()

setValue

public void setValue(java.lang.String value)