SOAPPartImpl (Red Hat JBoss Enterprise Application Platform 6.4.19.GA public API)

java.lang.Object
- javax.xml.soap.SOAPPart
- - org.jboss.ws.core.soap.SOAPPartImpl

All Implemented Interfaces:

Document, Node
```
public class SOAPPartImpl
extends SOAPPart
```
An implementation of SOAPPart.

Author:

Thomas.Diesler@jboss.org, Richard Opalka

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMimeHeader(String name, String value)` Creates a `MimeHeader` object with the specified name and value and adds it to this `SOAPPart` object.
`Node`	`adoptNode(Node source)`
`Node`	`appendChild(Node newChild)`
`Node`	`cloneNode(boolean deep)`
`short`	`compareDocumentPosition(Node other)`
`Attr`	`createAttribute(String name)`
`Attr`	`createAttributeNS(String namespaceURI, String qualifiedName)`
`CDATASection`	`createCDATASection(String data)`
`Comment`	`createComment(String data)`
`DocumentFragment`	`createDocumentFragment()`
`Element`	`createElement(String tagName)`
`Element`	`createElementNS(String namespaceURI, String qualifiedName)`
`EntityReference`	`createEntityReference(String name)`
`ProcessingInstruction`	`createProcessingInstruction(String target, String data)`
`Text`	`createTextNode(String data)`
`void`	`detachNode()` Removes this `Node` object from the tree.
`Iterator`	`getAllMimeHeaders()` Retrieves all the headers for this `SOAPPart` object as an iterator over the `MimeHeader` objects.
`NamedNodeMap`	`getAttributes()`
`String`	`getBaseURI()`
`NodeList`	`getChildNodes()`
`Source`	`getContent()` Returns the content of the SOAPEnvelope as a JAXP `Source` object.
`DocumentType`	`getDoctype()`
`Element`	`getDocumentElement()`
`String`	`getDocumentURI()`
`DOMConfiguration`	`getDomConfig()`
`Element`	`getElementById(String elementId)`
`NodeList`	`getElementsByTagName(String tagname)`
`NodeList`	`getElementsByTagNameNS(String namespaceURI, String localName)`
`SOAPEnvelope`	`getEnvelope()` Gets the `SOAPEnvelope` object associated with this `SOAPPart` object.
`Object`	`getFeature(String feature, String version)`
`Node`	`getFirstChild()`
`DOMImplementation`	`getImplementation()`
`String`	`getInputEncoding()`
`Node`	`getLastChild()`
`String`	`getLocalName()`
`Iterator`	`getMatchingMimeHeaders(String[] names)` Retrieves all `MimeHeader` objects that match a name in the given array.
`String[]`	`getMimeHeader(String name)` Gets all the values of the `MimeHeader` object in this `SOAPPart` object that is identified by the given `String`.
`String`	`getNamespaceURI()`
`Node`	`getNextSibling()`
`String`	`getNodeName()`
`short`	`getNodeType()`
`String`	`getNodeValue()`
`Iterator`	`getNonMatchingMimeHeaders(String[] names)` Retrieves all `MimeHeader` objects whose name does not match a name in the given array.
`Document`	`getOwnerDocument()`
`SOAPElement`	`getParentElement()` Returns the parent element of this `Node` object.
`Node`	`getParentNode()`
`String`	`getPrefix()`
`Node`	`getPreviousSibling()`
`SOAPMessage`	`getSOAPMessage()`
`boolean`	`getStrictErrorChecking()`
`String`	`getTextContent()`
`Object`	`getUserData(String key)`
`String`	`getValue()` Returns the value of this node if this is a `Text` node or the value of the immediate child of this node otherwise.
`String`	`getXmlEncoding()`
`boolean`	`getXmlStandalone()`
`String`	`getXmlVersion()`
`boolean`	`hasAttributes()`
`boolean`	`hasChildNodes()`
`Node`	`importNode(Node importedNode, boolean deep)`
`Node`	`insertBefore(Node newChild, Node refChild)`
`boolean`	`isDefaultNamespace(String namespaceURI)`
`boolean`	`isEqualNode(Node arg)`
`boolean`	`isSameNode(Node other)`
`boolean`	`isSupported(String feature, String version)`
`String`	`lookupNamespaceURI(String prefix)`
`String`	`lookupPrefix(String namespaceURI)`
`void`	`normalize()`
`void`	`normalizeDocument()`
`void`	`recycleNode()` Notifies the implementation that this `Node` object is no longer being used by the application and that the implementation is free to reuse this object for nodes that may be created later.
`void`	`removeAllMimeHeaders()` Removes all the `MimeHeader` objects for this `SOAPEnvelope` object.
`Node`	`removeChild(Node oldChild)`
`void`	`removeMimeHeader(String s)` Removes all MIME headers that match the given name.
`Node`	`renameNode(Node n, String namespaceURI, String qualifiedName)`
`Node`	`replaceChild(Node newChild, Node oldChild)`
`void`	`setContent(Source source)` Sets the content of the `SOAPEnvelope` object with the data from the given `Source` object.
`void`	`setDocumentURI(String documentURI)`
`void`	`setEnvelope(SOAPEnvelope soapEnvelope)`
`void`	`setMimeHeader(String name, 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(String nodeValue)`
`void`	`setParentElement(SOAPElement parent)` Sets the parent of this `Node` object to the given `SOAPElement` object.
`void`	`setPrefix(String s)`
`void`	`setStrictErrorChecking(boolean strictErrorChecking)`
`void`	`setTextContent(String textContent)`
`Object`	`setUserData(String key, Object data, UserDataHandler handler)`
`void`	`setValue(String value)` If this is a Text node then this method will set its value, otherwise it sets the value of the immediate (Text) child of this node.
`void`	`setXmlStandalone(boolean xmlStandalone)`
`void`	`setXmlVersion(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

- Method Detail
  - getSOAPMessage
```
public SOAPMessage getSOAPMessage()
```
  - getEnvelope
```
public SOAPEnvelope getEnvelope()
                         throws SOAPException
```
    Description copied from class: SOAPPart
    
    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
  - setEnvelope
```
public void setEnvelope(SOAPEnvelope soapEnvelope)
```
  - removeMimeHeader
```
public void removeMimeHeader(String s)
```
    Description copied from class: SOAPPart
    
    Removes all MIME headers that match the given name.
    
    Specified by:
    
    removeMimeHeader in class SOAPPart
    
    Parameters:
    s - a String giving the name of the MIME header(s) to be removed
  - removeAllMimeHeaders
```
public void removeAllMimeHeaders()
```
    Description copied from class: SOAPPart
    
    Removes all the MimeHeader objects for this SOAPEnvelope object.
    
    Specified by:
    
    removeAllMimeHeaders in class SOAPPart
  - getMimeHeader
```
public String[] getMimeHeader(String name)
```
    Description copied from class: SOAPPart
    
    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:
    SOAPPart.setMimeHeader(java.lang.String, java.lang.String)
  - setMimeHeader
```
public void setMimeHeader(String name,
                 String value)
```
    Description copied from class: SOAPPart
    
    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.
    See Also:
    SOAPPart.getMimeHeader(java.lang.String)
  - addMimeHeader
```
public void addMimeHeader(String name,
                 String value)
```
    Description copied from class: SOAPPart
    
    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:
    name - a String giving the header name
    value - a String giving the value to be set or added
  - getAllMimeHeaders
```
public Iterator getAllMimeHeaders()
```
    Description copied from class: SOAPPart
    
    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 Iterator getMatchingMimeHeaders(String[] names)
```
    Description copied from class: SOAPPart
    
    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 Iterator getNonMatchingMimeHeaders(String[] names)
```
    Description copied from class: SOAPPart
    
    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(Source source)
                throws SOAPException
```
    Description copied from class: SOAPPart
    
    Sets the content of the SOAPEnvelope object with the data from the given Source object. This Source must contain a valid SOAP document.
    
    Specified by:
    
    setContent in class SOAPPart
    
    Parameters:
    source - the javax.xml.transform.Source object with the data to be set
    
    Throws:
    
    SOAPException - if there is a problem in setting the source
    See Also:
    SOAPPart.getContent()
  - getContent
```
public Source getContent()
                  throws SOAPException
```
    Description copied from class: SOAPPart
    
    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:
    SOAPPart.setContent(javax.xml.transform.Source)
  - getImplementation
```
public DOMImplementation getImplementation()
```
  - createDocumentFragment
```
public DocumentFragment createDocumentFragment()
```
  - getDoctype
```
public DocumentType getDoctype()
```
  - getDocumentElement
```
public Element getDocumentElement()
```
  - createAttribute
```
public Attr createAttribute(String name)
                     throws DOMException
```
    Throws:
    
    DOMException
  - createCDATASection
```
public CDATASection createCDATASection(String data)
                                throws DOMException
```
    Throws:
    
    DOMException
  - createComment
```
public Comment createComment(String data)
```
  - createElement
```
public Element createElement(String tagName)
                      throws DOMException
```
    Throws:
    
    DOMException
  - getElementById
```
public Element getElementById(String elementId)
```
  - createEntityReference
```
public EntityReference createEntityReference(String name)
                                      throws DOMException
```
    Throws:
    
    DOMException
  - importNode
```
public Node importNode(Node importedNode,
              boolean deep)
                throws DOMException
```
    Throws:
    
    DOMException
  - getElementsByTagName
```
public NodeList getElementsByTagName(String tagname)
```
  - createTextNode
```
public Text createTextNode(String data)
```
  - createAttributeNS
```
public Attr createAttributeNS(String namespaceURI,
                     String qualifiedName)
                       throws DOMException
```
    Throws:
    
    DOMException
  - createElementNS
```
public Element createElementNS(String namespaceURI,
                      String qualifiedName)
                        throws DOMException
```
    Throws:
    
    DOMException
  - getElementsByTagNameNS
```
public NodeList getElementsByTagNameNS(String namespaceURI,
                              String localName)
```
  - createProcessingInstruction
```
public ProcessingInstruction createProcessingInstruction(String target,
                                                String data)
                                                  throws DOMException
```
    Throws:
    
    DOMException
  - appendChild
```
public Node appendChild(Node newChild)
                 throws DOMException
```
    Throws:
    
    DOMException
  - cloneNode
```
public Node cloneNode(boolean deep)
```
  - getAttributes
```
public NamedNodeMap getAttributes()
```
  - getChildNodes
```
public NodeList getChildNodes()
```
  - getFirstChild
```
public Node getFirstChild()
```
  - getLastChild
```
public Node getLastChild()
```
  - getLocalName
```
public String getLocalName()
```
  - getNamespaceURI
```
public String getNamespaceURI()
```
  - getNextSibling
```
public Node getNextSibling()
```
  - getNodeName
```
public String getNodeName()
```
  - getNodeType
```
public short getNodeType()
```
  - getNodeValue
```
public String getNodeValue()
                    throws DOMException
```
    Throws:
    
    DOMException
  - getOwnerDocument
```
public Document getOwnerDocument()
```
  - getParentNode
```
public Node getParentNode()
```
  - getPrefix
```
public String getPrefix()
```
  - getPreviousSibling
```
public Node getPreviousSibling()
```
  - hasAttributes
```
public boolean hasAttributes()
```
  - hasChildNodes
```
public boolean hasChildNodes()
```
  - insertBefore
```
public Node insertBefore(Node newChild,
                Node refChild)
                  throws DOMException
```
    Throws:
    
    DOMException
  - isSupported
```
public boolean isSupported(String feature,
                  String version)
```
  - normalize
```
public void normalize()
```
  - removeChild
```
public Node removeChild(Node oldChild)
                 throws DOMException
```
    Throws:
    
    DOMException
  - replaceChild
```
public Node replaceChild(Node newChild,
                Node oldChild)
                  throws DOMException
```
    Throws:
    
    DOMException
  - setNodeValue
```
public void setNodeValue(String nodeValue)
                  throws DOMException
```
    Throws:
    
    DOMException
  - setPrefix
```
public void setPrefix(String s)
               throws DOMException
```
    Throws:
    
    DOMException
  - adoptNode
```
public Node adoptNode(Node source)
               throws DOMException
```
    Throws:
    
    DOMException
  - getDocumentURI
```
public String getDocumentURI()
```
  - getDomConfig
```
public DOMConfiguration getDomConfig()
```
  - getInputEncoding
```
public String getInputEncoding()
```
  - getStrictErrorChecking
```
public boolean getStrictErrorChecking()
```
  - getXmlEncoding
```
public String getXmlEncoding()
```
  - getXmlStandalone
```
public boolean getXmlStandalone()
```
  - getXmlVersion
```
public String getXmlVersion()
```
  - normalizeDocument
```
public void normalizeDocument()
```
  - renameNode
```
public Node renameNode(Node n,
              String namespaceURI,
              String qualifiedName)
                throws DOMException
```
    Throws:
    
    DOMException
  - setDocumentURI
```
public void setDocumentURI(String documentURI)
```
  - setStrictErrorChecking
```
public void setStrictErrorChecking(boolean strictErrorChecking)
```
  - setXmlStandalone
```
public void setXmlStandalone(boolean xmlStandalone)
                      throws DOMException
```
    Throws:
    
    DOMException
  - setXmlVersion
```
public void setXmlVersion(String xmlVersion)
                   throws DOMException
```
    Throws:
    
    DOMException
  - compareDocumentPosition
```
public short compareDocumentPosition(Node other)
                              throws DOMException
```
    Throws:
    
    DOMException
  - getBaseURI
```
public String getBaseURI()
```
  - getFeature
```
public Object getFeature(String feature,
                String version)
```
  - getTextContent
```
public String getTextContent()
                      throws DOMException
```
    Throws:
    
    DOMException
  - getUserData
```
public Object getUserData(String key)
```
  - isDefaultNamespace
```
public boolean isDefaultNamespace(String namespaceURI)
```
  - isEqualNode
```
public boolean isEqualNode(Node arg)
```
  - isSameNode
```
public boolean isSameNode(Node other)
```
  - lookupNamespaceURI
```
public String lookupNamespaceURI(String prefix)
```
  - lookupPrefix
```
public String lookupPrefix(String namespaceURI)
```
  - setTextContent
```
public void setTextContent(String textContent)
                    throws DOMException
```
    Throws:
    
    DOMException
  - setUserData
```
public Object setUserData(String key,
                 Object data,
                 UserDataHandler handler)
```
  - detachNode
```
public void detachNode()
```
    Description copied from interface: Node
    
    Removes this Node object from the tree.
  - getParentElement
```
public SOAPElement getParentElement()
```
    Description copied from interface: Node
    
    Returns the parent element of this Node object. This method can throw an UnsupportedOperationException if the tree is not kept in memory.
    
    Returns:
    the SOAPElement object that is the parent of this Node object or null if this Node object is root
    See Also:
    Node.setParentElement(javax.xml.soap.SOAPElement)
  - getValue
```
public String getValue()
```
    Description copied from interface: Node
    
    Returns the value of this node if this is a Text node or the value of the immediate child of this node otherwise. If there is an immediate child of this Node that it is a Text node then it's value will be returned. If there is more than one Text node then the value of the first Text Node will be returned. Otherwise null is returned.
    
    Returns:
    a String with the text of this node if this is a Text node or the text contained by the first immediate child of this Node object that is a Text object if such a child exists; null otherwise.
  - recycleNode
```
public void recycleNode()
```
    Description copied from interface: Node
    
    Notifies the implementation that this Node object is no longer being used by the application and that the implementation is free to reuse this object for nodes that may be created later.
    Calling the method recycleNode implies that the method detachNode has been called previously.
  - setParentElement
```
public void setParentElement(SOAPElement parent)
                      throws SOAPException
```
    Description copied from interface: Node
    
    Sets the parent of this Node object to the given SOAPElement object.
    
    Parameters:
    parent - the SOAPElement object to be set as the parent of this Node object
    
    Throws:
    
    SOAPException - if there is a problem in setting the parent to the given element
    See Also:
    Node.getParentElement()
  - setValue
```
public void setValue(String value)
```
    Description copied from interface: Node
    
    If this is a Text node then this method will set its value, otherwise it sets the value of the immediate (Text) child of this node. The value of the immediate child of this node can be set only if, there is one child node and that node is a Text node, or if there are no children in which case a child Text node will be created.

Class SOAPPartImpl

Field Summary

Fields inherited from interface org.w3c.dom.Node

Method Summary

Methods inherited from class javax.xml.soap.SOAPPart

Methods inherited from class java.lang.Object

Method Detail

getSOAPMessage

getEnvelope

setEnvelope

removeMimeHeader

removeAllMimeHeaders

getMimeHeader

setMimeHeader

addMimeHeader

getAllMimeHeaders

getMatchingMimeHeaders

getNonMatchingMimeHeaders

setContent

getContent

getImplementation

createDocumentFragment

getDoctype

getDocumentElement

createAttribute

createCDATASection

createComment

createElement

getElementById

createEntityReference

importNode

getElementsByTagName

createTextNode

createAttributeNS

createElementNS

getElementsByTagNameNS

createProcessingInstruction

appendChild

cloneNode

getAttributes

getChildNodes

getFirstChild

getLastChild

getLocalName

getNamespaceURI

getNextSibling

getNodeName

getNodeType

getNodeValue

getOwnerDocument

getParentNode

getPrefix

getPreviousSibling

hasAttributes

hasChildNodes

insertBefore

isSupported

normalize

removeChild

replaceChild

setNodeValue

setPrefix

adoptNode

getDocumentURI

getDomConfig

getInputEncoding

getStrictErrorChecking

getXmlEncoding

getXmlStandalone

getXmlVersion

normalizeDocument

renameNode

setDocumentURI

setStrictErrorChecking

setXmlStandalone

setXmlVersion

compareDocumentPosition

getBaseURI

getFeature

getTextContent