SOAPPart JDK 1.6)

Description

publicabstract abstract class SOAPPart

The container for the SOAP-specific portion of a SOAPMessage object.

The container for the SOAP-specific portion of a 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.

See also:

Methods

Hide/Show inherited methods

publicabstract void addMimeHeader (String name, String value)

Creates a MimeHeader object with the specified name and value and adds it to this SOAPPart object.

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.
Parameters:
- name - a String giving the header name
- value - a String giving the value to be set or added
Throws:
- IllegalArgumentException - if there was a problem with the specified mime header name or value

publicabstract Iterator getAllMimeHeaders ()

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

Retrieves all the headers for this SOAPPart object
as an iterator over the MimeHeader objects.
Returns: an Iterator object with all of the Mime headers for this SOAPPart object

publicabstract Source getContent () throws SOAPException

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

Returns the content of the SOAPEnvelope as a JAXP Source
object.
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),

public String getContentId ()

Retrieves the value of the MIME header whose name is "Content-Id".

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: SOAPPart.setContentId(java.lang.String),

public String getContentLocation ()

Retrieves the value of the MIME header whose name is "Content-Location".

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: SOAPPart.setContentLocation(java.lang.String),

publicabstract SOAPEnvelope getEnvelope () throws SOAPException

Gets the SOAPEnvelope object associated with this SOAPPart object.

Gets the SOAPEnvelope object associated with this
SOAPPart object. Once the SOAP envelope is obtained, it
can be used to get its contents.
Returns: the SOAPEnvelope object for this SOAPPart object
Throws:
- SOAPException - if there is a SOAP error

publicabstract Iterator getMatchingMimeHeaders (String names)

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

Retrieves all MimeHeader objects that match a name in
the given array.
Returns: all of the MIME headers that match one of the names in the given array, returned as an Iterator object
Parameters:
- names - a String array with the name(s) of the MIME headers to be returned

publicabstract String getMimeHeader (String name)

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

Gets all the values of the MimeHeader object
in this SOAPPart object that
is identified by the given String.
Returns: a String array giving all the values for the specified header
Parameters:
- name - the name of the header; example: "Content-Type"
See Also: SOAPPart.setMimeHeader(java.lang.String, java.lang.String),

publicabstract Iterator getNonMatchingMimeHeaders (String names)

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

Retrieves all MimeHeader objects whose name does
not match a name in the given array.
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.
Parameters:
- names - a String array with the name(s) of the MIME headers not to be returned

publicabstract void removeAllMimeHeaders ()

Removes all the MimeHeader objects for this SOAPEnvelope object.

publicabstract void removeMimeHeader (String header)

Removes all MIME headers that match the given name.

Removes all MIME headers that match the given name.
Parameters:
- header - a String giving the name of the MIME header(s) to be removed

publicabstract void setContent (Source source) throws SOAPException

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

Sets the content of the SOAPEnvelope object with the data
from the given Source object. This Source
must contain a valid SOAP document.
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(),

public void setContentId (String contentId)

Sets the value of the MIME header named "Content-Id" to the given String.

Sets the value of the MIME header named "Content-Id"
to the given String.
Parameters:
- contentId - a String giving the value of the MIME header "Content-Id"
Throws:
- IllegalArgumentException - if there is a problem in setting the content id
See Also: SOAPPart.getContentId(),

public void setContentLocation (String contentLocation)

Sets the value of the MIME header "Content-Location" to the given String.

Sets the value of the MIME header "Content-Location"
to the given String.
Parameters:
- contentLocation - a String giving the value of the MIME header "Content-Location"
Throws:
- IllegalArgumentException - if there is a problem in setting the content location.
See Also: SOAPPart.getContentLocation(),

publicabstract 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.

Fields

Hide/Show inherited fields

publicfinalstatic short ATTRIBUTE_NODE = "2" [Inherited From Node]

The node is an Attr.

publicfinalstatic short ATTRIBUTE_NODE = "2" [Inherited From Node]

The node is an Attr.

publicfinalstatic short CDATA_SECTION_NODE = "4" [Inherited From Node]

The node is a CDATASection.

publicfinalstatic short CDATA_SECTION_NODE = "4" [Inherited From Node]

The node is a CDATASection.

publicfinalstatic short COMMENT_NODE = "8" [Inherited From Node]

The node is a Comment.

publicfinalstatic short COMMENT_NODE = "8" [Inherited From Node]

The node is a Comment.

publicfinalstatic short DOCUMENT_FRAGMENT_NODE = "11" [Inherited From Node]

The node is a DocumentFragment.

publicfinalstatic short DOCUMENT_FRAGMENT_NODE = "11" [Inherited From Node]

The node is a DocumentFragment.

publicfinalstatic short DOCUMENT_NODE = "9" [Inherited From Node]

The node is a Document.

publicfinalstatic short DOCUMENT_NODE = "9" [Inherited From Node]

The node is a Document.

publicfinalstatic short DOCUMENT_POSITION_CONTAINED_BY = "16" [Inherited From Node]

The node is contained by the reference node.

publicfinalstatic short DOCUMENT_POSITION_CONTAINED_BY = "16" [Inherited From Node]

The node is contained by the reference node.

publicfinalstatic short DOCUMENT_POSITION_CONTAINS = "8" [Inherited From Node]

The node contains the reference node.

publicfinalstatic short DOCUMENT_POSITION_CONTAINS = "8" [Inherited From Node]

The node contains the reference node.

publicfinalstatic short DOCUMENT_POSITION_DISCONNECTED = "1" [Inherited From Node]

The two nodes are disconnected.

publicfinalstatic short DOCUMENT_POSITION_DISCONNECTED = "1" [Inherited From Node]

The two nodes are disconnected.

publicfinalstatic short DOCUMENT_POSITION_FOLLOWING = "4" [Inherited From Node]

The node follows the reference node.

publicfinalstatic short DOCUMENT_POSITION_FOLLOWING = "4" [Inherited From Node]

The node follows the reference node.

publicfinalstatic short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = "32" [Inherited From Node]

The determination of preceding versus following is implementation-specific.

publicfinalstatic short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = "32" [Inherited From Node]

The determination of preceding versus following is implementation-specific.

publicfinalstatic short DOCUMENT_POSITION_PRECEDING = "2" [Inherited From Node]

The second node precedes the reference node.

publicfinalstatic short DOCUMENT_POSITION_PRECEDING = "2" [Inherited From Node]

The second node precedes the reference node.

publicfinalstatic short DOCUMENT_TYPE_NODE = "10" [Inherited From Node]

The node is a DocumentType.

publicfinalstatic short DOCUMENT_TYPE_NODE = "10" [Inherited From Node]

The node is a DocumentType.

publicfinalstatic short ELEMENT_NODE = "1" [Inherited From Node]

The node is an Element.

publicfinalstatic short ELEMENT_NODE = "1" [Inherited From Node]

The node is an Element.

publicfinalstatic short ENTITY_NODE = "6" [Inherited From Node]

The node is an Entity.

publicfinalstatic short ENTITY_NODE = "6" [Inherited From Node]

The node is an Entity.

publicfinalstatic short ENTITY_REFERENCE_NODE = "5" [Inherited From Node]

The node is an EntityReference.

publicfinalstatic short ENTITY_REFERENCE_NODE = "5" [Inherited From Node]

The node is an EntityReference.

publicfinalstatic short NOTATION_NODE = "12" [Inherited From Node]

The node is a Notation.

publicfinalstatic short NOTATION_NODE = "12" [Inherited From Node]

The node is a Notation.

publicfinalstatic short PROCESSING_INSTRUCTION_NODE = "7" [Inherited From Node]

The node is a ProcessingInstruction.

publicfinalstatic short PROCESSING_INSTRUCTION_NODE = "7" [Inherited From Node]

The node is a ProcessingInstruction.

publicfinalstatic short TEXT_NODE = "3" [Inherited From Node]

The node is a Text node.

publicfinalstatic short TEXT_NODE = "3" [Inherited From Node]

The node is a Text node.