Module com.sun.xml.messaging.saaj

Package com.sun.xml.messaging.saaj.soap

Class SOAPPartImpl

java.lang.Object

jakarta.xml.soap.SOAPPart

com.sun.xml.messaging.saaj.soap.SOAPPartImpl

All Implemented Interfaces:

SOAPDocument, Node, Document, Node

Direct Known Subclasses:

SOAPPart1_1Impl, SOAPPart1_2Impl

public abstract class SOAPPartImpl
extends SOAPPart
implements SOAPDocument

SOAPPartImpl is the first attachment. This contains the XML/SOAP document.

Field Summary

Fields

Modifier and Type	Field	Description
protected SOAPDocumentImpl	document
protected Envelope	envelope
protected MimeHeaders	headers
protected MessageImpl	message	Reference to containing message (may be null)
protected boolean	omitXmlDecl
protected Source	source
protected String	sourceCharsetEncoding

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	Description
protected	SOAPPartImpl()
protected	SOAPPartImpl(MessageImpl message)

Method Summary

Modifier and Type	Method	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)
protected abstract Envelope	createEmptyEnvelope(String prefix)
EntityReference	createEntityReference(String name)
protected abstract Envelope	createEnvelopeFromSource()
ProcessingInstruction	createProcessingInstruction(String target, String data)
Text	createTextNode(String data)
void	detachNode()	Removes this Node object from the tree.
protected SOAPPartImpl	doCloneNode()
protected void	doGetDocumentElement()
protected abstract SOAPPartImpl	duplicateType()
Iterator<MimeHeader>	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.
InputStream	getContentAsStream()
protected abstract String	getContentType()
protected String	getContentTypeString()
DocumentType	getDoctype()
SOAPDocumentImpl	getDocument()
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<MimeHeader>	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<MimeHeader>	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()
abstract String	getSOAPNamespace()
SOAPPartImpl	getSOAPPart()
String	getSourceCharsetEncoding()
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 arg0, Node arg1)
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node arg)
boolean	isFastInfoset()
boolean	isSameNode(Node other)
boolean	isSupported(String arg0, String arg1)
protected void	lookForEnvelope()
protected XMLDeclarationParser	lookForXmlDecl()
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 arg0)
void	removeMimeHeader(String header)	Removes all MIME headers that match the given name.
Node	renameNode(Node n, String namespaceURI, String qualifiedName)
Node	replaceChild(Node arg0, Node arg1)
void	setContent(Source source)	Sets the content of the SOAPEnvelope object with the data from the given Source object.
void	setDocumentURI(String documentURI)
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 arg0)
void	setParentElement(SOAPElement parent)	Sets the parent of this Node object to the given SOAPElement object.
void	setPrefix(String arg0)
void	setSourceCharsetEncoding(String charset)
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 jakarta.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

Field Details

headers

protected MimeHeaders headers

envelope

protected Envelope envelope

source

protected Source source

document

protected SOAPDocumentImpl document

omitXmlDecl

protected boolean omitXmlDecl

sourceCharsetEncoding

protected String sourceCharsetEncoding

message

protected MessageImpl message

Reference to containing message (may be null)

Constructor Details

SOAPPartImpl

protected SOAPPartImpl()

SOAPPartImpl

protected SOAPPartImpl(MessageImpl message)

Method Details

getContentType

protected abstract String getContentType()

createEnvelopeFromSource

protected abstract Envelope createEnvelopeFromSource()
                                              throws SOAPException

Throws:

SOAPException

createEmptyEnvelope

protected abstract Envelope createEmptyEnvelope(String prefix)
                                         throws SOAPException

Throws:

SOAPException

duplicateType

protected abstract SOAPPartImpl duplicateType()

getContentTypeString

protected String getContentTypeString()

isFastInfoset

public boolean isFastInfoset()

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

lookForEnvelope

protected void lookForEnvelope()
                        throws SOAPException

Throws:

SOAPException

removeAllMimeHeaders

public void removeAllMimeHeaders()

Description copied from class: SOAPPart

Removes all the MimeHeader objects for this SOAPEnvelope object.

Specified by:

removeAllMimeHeaders in class SOAPPart

removeMimeHeader

public void removeMimeHeader(String header)

Description copied from class: SOAPPart

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

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 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<MimeHeader> 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 the Mime headers for this SOAPPart object

getMatchingMimeHeaders

public Iterator<MimeHeader> 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 the MIME headers that match one of the names in the given array, returned as an Iterator object

getNonMatchingMimeHeaders

public Iterator<MimeHeader> 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 the MIME headers in this SOAPPart object except those that match one of the names in the given array. The non-matching MIME headers are returned as an Iterator object.

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)

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()

getContentAsStream

public InputStream getContentAsStream()
                               throws IOException

Throws:

IOException

getDocument

public SOAPDocumentImpl getDocument()

Specified by:

getDocument in interface SOAPDocument

getSOAPPart

public SOAPPartImpl getSOAPPart()

Specified by:

getSOAPPart in interface SOAPDocument

getDoctype

public DocumentType getDoctype()

Specified by:

getDoctype in interface Document

getImplementation

public DOMImplementation getImplementation()

Specified by:

getImplementation in interface Document

getDocumentElement

public Element getDocumentElement()

Specified by:

getDocumentElement in interface Document

doGetDocumentElement

protected void doGetDocumentElement()

createElement

public Element createElement(String tagName)
                      throws DOMException

Specified by:

createElement in interface Document

Throws:

DOMException

createDocumentFragment

public DocumentFragment createDocumentFragment()

Specified by:

createDocumentFragment in interface Document

createTextNode

public Text createTextNode(String data)

Specified by:

createTextNode in interface Document

createComment

public Comment createComment(String data)

Specified by:

createComment in interface Document

createCDATASection

public CDATASection createCDATASection(String data)
                                throws DOMException

Specified by:

createCDATASection in interface Document

Throws:

DOMException

createProcessingInstruction

public ProcessingInstruction createProcessingInstruction(String target,
 String data)
                                                  throws DOMException

Specified by:

createProcessingInstruction in interface Document

Throws:

DOMException

createAttribute

public Attr createAttribute(String name)
                     throws DOMException

Specified by:

createAttribute in interface Document

Throws:

DOMException

createEntityReference

public EntityReference createEntityReference(String name)
                                      throws DOMException

Specified by:

createEntityReference in interface Document

Throws:

DOMException

getElementsByTagName

public NodeList getElementsByTagName(String tagname)

Specified by:

getElementsByTagName in interface Document

importNode

public Node importNode(Node importedNode,
 boolean deep)
                throws DOMException

Specified by:

importNode in interface Document

Throws:

DOMException

createElementNS

public Element createElementNS(String namespaceURI,
 String qualifiedName)
                        throws DOMException

Specified by:

createElementNS in interface Document

Throws:

DOMException

createAttributeNS

public Attr createAttributeNS(String namespaceURI,
 String qualifiedName)
                       throws DOMException

Specified by:

createAttributeNS in interface Document

Throws:

DOMException

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
 String localName)

Specified by:

getElementsByTagNameNS in interface Document

getElementById

public Element getElementById(String elementId)

Specified by:

getElementById in interface Document

appendChild

public Node appendChild(Node newChild)
                 throws DOMException

Specified by:

appendChild in interface Node

Throws:

DOMException

cloneNode

public Node cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

doCloneNode

protected SOAPPartImpl doCloneNode()

getAttributes

public NamedNodeMap getAttributes()

Specified by:

getAttributes in interface Node

getChildNodes

public NodeList getChildNodes()

Specified by:

getChildNodes in interface Node

getFirstChild

public Node getFirstChild()

Specified by:

getFirstChild in interface Node

getLastChild

public Node getLastChild()

Specified by:

getLastChild in interface Node

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface Node

getNamespaceURI

public String getNamespaceURI()

Specified by:

getNamespaceURI in interface Node

getNextSibling

public Node getNextSibling()

Specified by:

getNextSibling in interface Node

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface Node

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface Node

getNodeValue

public String getNodeValue()
                    throws DOMException

Specified by:

getNodeValue in interface Node

Throws:

DOMException

getOwnerDocument

public Document getOwnerDocument()

Specified by:

getOwnerDocument in interface Node

getParentNode

public Node getParentNode()

Specified by:

getParentNode in interface Node

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface Node

getPreviousSibling

public Node getPreviousSibling()

Specified by:

getPreviousSibling in interface Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface Node

insertBefore

public Node insertBefore(Node arg0,
 Node arg1)
                  throws DOMException

Specified by:

insertBefore in interface Node

Throws:

DOMException

isSupported

public boolean isSupported(String arg0,
 String arg1)

Specified by:

isSupported in interface Node

normalize

public void normalize()

Specified by:

normalize in interface Node

removeChild

public Node removeChild(Node arg0)
                 throws DOMException

Specified by:

removeChild in interface Node

Throws:

DOMException

replaceChild

public Node replaceChild(Node arg0,
 Node arg1)
                  throws DOMException

Specified by:

replaceChild in interface Node

Throws:

DOMException

setNodeValue

public void setNodeValue(String arg0)
                  throws DOMException

Specified by:

setNodeValue in interface Node

Throws:

DOMException

setPrefix

public void setPrefix(String arg0)
               throws DOMException

Specified by:

setPrefix in interface Node

Throws:

DOMException

lookForXmlDecl

protected XMLDeclarationParser lookForXmlDecl()
                                       throws SOAPException

Throws:

SOAPException

setSourceCharsetEncoding

public void setSourceCharsetEncoding(String charset)

renameNode

public Node renameNode(Node n,
 String namespaceURI,
 String qualifiedName)
                throws DOMException

Specified by:

renameNode in interface Document

Throws:

DOMException

normalizeDocument

public void normalizeDocument()

Specified by:

normalizeDocument in interface Document

getDomConfig

public DOMConfiguration getDomConfig()

Specified by:

getDomConfig in interface Document

adoptNode

public Node adoptNode(Node source)
               throws DOMException

Specified by:

adoptNode in interface Document

Throws:

DOMException

setDocumentURI

public void setDocumentURI(String documentURI)

Specified by:

setDocumentURI in interface Document

getDocumentURI

public String getDocumentURI()

Specified by:

getDocumentURI in interface Document

setStrictErrorChecking

public void setStrictErrorChecking(boolean strictErrorChecking)

Specified by:

setStrictErrorChecking in interface Document

getInputEncoding

public String getInputEncoding()

Specified by:

getInputEncoding in interface Document

getXmlEncoding

public String getXmlEncoding()

Specified by:

getXmlEncoding in interface Document

getXmlStandalone

public boolean getXmlStandalone()

Specified by:

getXmlStandalone in interface Document

setXmlStandalone

public void setXmlStandalone(boolean xmlStandalone)
                      throws DOMException

Specified by:

setXmlStandalone in interface Document

Throws:

DOMException

getXmlVersion

public String getXmlVersion()

Specified by:

getXmlVersion in interface Document

setXmlVersion

public void setXmlVersion(String xmlVersion)
                   throws DOMException

Specified by:

setXmlVersion in interface Document

Throws:

DOMException

getStrictErrorChecking

public boolean getStrictErrorChecking()

Specified by:

getStrictErrorChecking in interface Document

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Throws:

DOMException

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Throws:

DOMException

isSameNode

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Specified by:

isDefaultNamespace in interface Node

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Specified by:

lookupNamespaceURI in interface Node

isEqualNode

public boolean isEqualNode(Node arg)

Specified by:

isEqualNode in interface Node

getFeature

public Object getFeature(String feature,
 String version)

Specified by:

getFeature in interface Node

setUserData

public Object setUserData(String key,
 Object data,
 UserDataHandler handler)

Specified by:

setUserData in interface Node

getUserData

public Object getUserData(String key)

Specified by:

getUserData in interface Node

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.

Specified by:

recycleNode in interface Node

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.

Specified by:

getValue in interface Node

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.

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.

Specified by:

setValue in interface Node

Parameters:

value - value to set on the Text node

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.

Specified by:

setParentElement in interface Node

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()

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.

Specified by:

getParentElement in interface Node

Returns:

the SOAPElement object that is the parent of this Node object or null if this Node object is root

See Also:

• Node.setParentElement(jakarta.xml.soap.SOAPElement)

detachNode

public void detachNode()

Description copied from interface: Node

Removes this Node object from the tree.

Specified by:

detachNode in interface Node

getSourceCharsetEncoding

public String getSourceCharsetEncoding()

getSOAPNamespace

public abstract String getSOAPNamespace()