javax.xml.soap

Class SOAPPart

Implemented Interfaces:
org.w3c.dom.Document
Known Direct Subclasses:
SOAPPart

public abstract class SOAPPart
extends java.lang.Object
implements org.w3c.dom.Document

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.

Constructor Summary

SOAPPart()

Method Summary

void
addMimeHeader(String name, String value)
Creates a MimeHeader object with the specified name and value and adds it to this SOAPPart object.
Iterator
getAllMimeHeaders()
Retrieves all the headers for this SOAPPart object as an iterator over the MimeHeader objects.
Source
getContent()
Returns the content of the SOAPEnvelope as a JAXP Source object.
String
getContentId()
Retrieves the value of the MIME header whose name is "Content-Id".
String
getContentLocation()
Retrieves the value of the MIME header whose name is "Content-Location".
SOAPEnvelope
getEnvelope()
Gets the SOAPEnvelope object associated with this SOAPPart object.
Iterator
getMatchingMimeHeaders(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.
Iterator
getNonMatchingMimeHeaders(names[] )
Retrieves all MimeHeader objects whose name does not match a name in the given array.
void
removeAllMimeHeaders()
Removes all the MimeHeader objects for this SOAPEnvelope object.
void
removeMimeHeader(String header)
Removes all MIME headers that match the given name.
void
setContent(Source source)
Sets the content of the SOAPEnvelope object with the data from the given Source object.
void
setContentId(String contentId)
Sets the value of the MIME header named "Content-Id" to the given String.
void
setContentLocation(String contentLocation)
Sets the value of the MIME header "Content-Location" to the given String.
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.

Constructor Details

SOAPPart

public SOAPPart()

Method Details

addMimeHeader

public void addMimeHeader(String name,
                          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.

Parameters:
name - a String giving the header name
value - a String giving the value to be set or added


getAllMimeHeaders

public Iterator getAllMimeHeaders()
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


getContent

public Source getContent()
            throws SOAPException
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:
setContent(javax.xml.transform.Source)


getContentId

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


getContentLocation

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


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.

Returns:
the SOAPEnvelope object for this SOAPPart object

Throws:
SOAPException - if there is a SOAP error


getMatchingMimeHeaders

public Iterator getMatchingMimeHeaders(names[] )
Retrieves all MimeHeader objects that match a name in the given array.

Parameters:

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


getMimeHeader

public String[] getMimeHeader(String name)
Gets all the values of the MimeHeader object in this SOAPPart object that is identified by the given String.

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)


getNonMatchingMimeHeaders

public Iterator getNonMatchingMimeHeaders(names[] )
Retrieves all MimeHeader objects whose name does not match a name in the given array.

Parameters:

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.


removeAllMimeHeaders

public void removeAllMimeHeaders()
Removes all the MimeHeader objects for this SOAPEnvelope object.


removeMimeHeader

public void removeMimeHeader(String header)
Removes all MIME headers that match the given name.

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


setContent

public void setContent(Source source)
            throws SOAPException
Sets the content of the SOAPEnvelope object with the data from the given Source object.

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


setContentId

public void setContentId(String contentId)
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"

See Also:
getContentId()


setContentLocation

public void setContentLocation(String contentLocation)
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"

See Also:
getContentLocation()


setMimeHeader

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

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:
getMimeHeader(java.lang.String)


Copyright B) 2005 Apache Web Services Project. All Rights Reserved.