SOAPMessage
object. All messages are required to have a SOAP part, so when a
SOAPMessage
object is created, it will automatically
have a SOAPPart
object.
A SOAPPart
object is a MIME part and has the MIME headers
Content-Id, Content-Location, and Content-Type. Because the value of
Content-Type must be "text/xml", a SOAPPart
object automatically
has a MIME header of Content-Type with its value set to "text/xml".
The value must be "text/xml" because content in the SOAP part of a
message must be in XML format. Content that is not of type "text/xml"
must be in an AttachmentPart
object rather than in the
SOAPPart
object.
When a message is sent, its SOAP part must have the MIME header Content-Type set to "text/xml". Or, from the other perspective, the SOAP part of any message that is received must have the MIME header Content-Type with a value of "text/xml".
A client can access the SOAPPart
object of a
SOAPMessage
object by
calling the method SOAPMessage.getSOAPPart
. The
following line of code, in which message
is a
SOAPMessage
object, retrieves the SOAP part of a message.
SOAPPart soapPart = message.getSOAPPart();
A SOAPPart
object contains a SOAPEnvelope
object,
which in turn contains a SOAPBody
object and a
SOAPHeader
object.
The SOAPPart
method getEnvelope
can be used
to retrieve the SOAPEnvelope
object.
- Since:
- 1.6
-
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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract void
addMimeHeader
(String name, String value) Creates aMimeHeader
object with the specified name and value and adds it to thisSOAPPart
object.abstract Iterator
<MimeHeader> Retrieves all the headers for thisSOAPPart
object as an iterator over theMimeHeader
objects.abstract Source
Returns the content of the SOAPEnvelope as a JAXPSource
object.Retrieves the value of the MIME header whose name is "Content-Id".Retrieves the value of the MIME header whose name is "Content-Location".abstract SOAPEnvelope
Gets theSOAPEnvelope
object associated with thisSOAPPart
object.abstract Iterator
<MimeHeader> getMatchingMimeHeaders
(String[] names) Retrieves allMimeHeader
objects that match a name in the given array.abstract String[]
getMimeHeader
(String name) Gets all the values of theMimeHeader
object in thisSOAPPart
object that is identified by the givenString
.abstract Iterator
<MimeHeader> getNonMatchingMimeHeaders
(String[] names) Retrieves allMimeHeader
objects whose name does not match a name in the given array.abstract void
Removes all theMimeHeader
objects for thisSOAPEnvelope
object.abstract void
removeMimeHeader
(String header) Removes all MIME headers that match the given name.abstract void
setContent
(Source source) Sets the content of theSOAPEnvelope
object with the data from the givenSource
object.void
setContentId
(String contentId) Sets the value of the MIME header named "Content-Id" to the givenString
.void
setContentLocation
(String contentLocation) Sets the value of the MIME header "Content-Location" to the givenString
.abstract 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.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.w3c.dom.Document
adoptNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, normalizeDocument, renameNode, setDocumentURI, setStrictErrorChecking, setXmlStandalone, setXmlVersion
Methods inherited from interface jakarta.xml.soap.Node
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
-
Constructor Details
-
SOAPPart
protected SOAPPart()Default constructor.
-
-
Method Details
-
getEnvelope
Gets theSOAPEnvelope
object associated with thisSOAPPart
object. Once the SOAP envelope is obtained, it can be used to get its contents.- Returns:
- the
SOAPEnvelope
object for thisSOAPPart
object - Throws:
SOAPException
- if there is a SOAP error
-
getContentId
Retrieves the value of the MIME header whose name is "Content-Id".- Returns:
- a
String
giving the value of the MIME header named "Content-Id" - See Also:
-
getContentLocation
Retrieves the value of the MIME header whose name is "Content-Location".- Returns:
- a
String
giving the value of the MIME header whose name is "Content-Location" - See Also:
-
setContentId
Sets the value of the MIME header named "Content-Id" to the givenString
.- Parameters:
contentId
- aString
giving the value of the MIME header "Content-Id"- Throws:
IllegalArgumentException
- if there is a problem in setting the content id- See Also:
-
setContentLocation
Sets the value of the MIME header "Content-Location" to the givenString
.- Parameters:
contentLocation
- aString
giving the value of the MIME header "Content-Location"- Throws:
IllegalArgumentException
- if there is a problem in setting the content location.- See Also:
-
removeMimeHeader
Removes all MIME headers that match the given name.- Parameters:
header
- aString
giving the name of the MIME header(s) to be removed
-
removeAllMimeHeaders
public abstract void removeAllMimeHeaders()Removes all theMimeHeader
objects for thisSOAPEnvelope
object. -
getMimeHeader
Gets all the values of theMimeHeader
object in thisSOAPPart
object that is identified by the givenString
.- 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
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.
- Parameters:
name
- aString
giving the header name for which to searchvalue
- aString
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 newMimeHeader
object.- Throws:
IllegalArgumentException
- if there was a problem with the specified mime header name or value- See Also:
-
addMimeHeader
Creates aMimeHeader
object with the specified name and value and adds it to thisSOAPPart
object. If aMimeHeader
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.
- Parameters:
name
- aString
giving the header namevalue
- aString
giving the value to be set or added- Throws:
IllegalArgumentException
- if there was a problem with the specified mime header name or value
-
getAllMimeHeaders
Retrieves all the headers for thisSOAPPart
object as an iterator over theMimeHeader
objects.- Returns:
- an
Iterator
object with all the Mime headers for thisSOAPPart
object
-
getMatchingMimeHeaders
Retrieves allMimeHeader
objects that match a name in the given array.- Parameters:
names
- aString
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
Retrieves allMimeHeader
objects whose name does not match a name in the given array.- Parameters:
names
- aString
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 anIterator
object.
-
setContent
Sets the content of theSOAPEnvelope
object with the data from the givenSource
object. ThisSource
must contain a valid SOAP document.- Parameters:
source
- thejavax.xml.transform.Source
object with the data to be set- Throws:
SOAPException
- if there is a problem in setting the source- See Also:
-
getContent
Returns the content of the SOAPEnvelope as a JAXPSource
object.- Returns:
- the content as a
javax.xml.transform.Source
object - Throws:
SOAPException
- if the implementation cannot convert the specifiedSource
object- See Also:
-