| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.4.2_08) on Sat Apr 22 18:56:43 PDT 2006 --> |
| <TITLE> |
| SOAPPart (Axis API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="javax.xml.soap.SOAPPart class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="SOAPPart (Axis API)"; |
| } |
| </SCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SOAPPart.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SOAPPart.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| javax.xml.soap</FONT> |
| <BR> |
| Class SOAPPart</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><B>javax.xml.soap.SOAPPart</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>org.w3c.dom.Document, org.w3c.dom.Node</DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../org/apache/axis/SOAPPart.html" title="class in org.apache.axis">SOAPPart</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public abstract class <B>SOAPPart</B><DT>extends java.lang.Object<DT>implements org.w3c.dom.Document</DL> |
| |
| <P> |
| <P>The container for the SOAP-specific portion of a <CODE> |
| SOAPMessage</CODE> object. All messages are required to have a |
| SOAP part, so when a <CODE>SOAPMessage</CODE> object is |
| created, it will automatically have a <CODE>SOAPPart</CODE> |
| object.</P> |
| |
| <P>A <CODE>SOAPPart</CODE> 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 <CODE> |
| SOAPPart</CODE> 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 <CODE>AttachmentPart</CODE> object rather than in |
| the <CODE>SOAPPart</CODE> object.</P> |
| |
| <P>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".</P> |
| |
| <P>A client can access the <CODE>SOAPPart</CODE> object of a |
| <CODE>SOAPMessage</CODE> object by calling the method <CODE> |
| SOAPMessage.getSOAPPart</CODE>. The following line of code, in |
| which <CODE>message</CODE> is a <CODE>SOAPMessage</CODE> |
| object, retrieves the SOAP part of a message.</P> |
| <PRE> |
| SOAPPart soapPart = message.getSOAPPart(); |
| </PRE> |
| |
| <P>A <CODE>SOAPPart</CODE> object contains a <CODE> |
| SOAPEnvelope</CODE> object, which in turn contains a <CODE> |
| SOAPBody</CODE> object and a <CODE>SOAPHeader</CODE> object. |
| The <CODE>SOAPPart</CODE> method <CODE>getEnvelope</CODE> can |
| be used to retrieve the <CODE>SOAPEnvelope</CODE> object.</P> |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.w3c.dom.Node"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Fields inherited from interface org.w3c.dom.Node</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#SOAPPart()">SOAPPart</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#addMimeHeader(java.lang.String, java.lang.String)">addMimeHeader</A></B>(java.lang.String name, |
| java.lang.String value)</CODE> |
| |
| <BR> |
| Creates a <CODE>MimeHeader</CODE> object with the specified |
| name and value and adds it to this <CODE>SOAPPart</CODE> |
| object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.util.Iterator</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#getAllMimeHeaders()">getAllMimeHeaders</A></B>()</CODE> |
| |
| <BR> |
| Retrieves all the headers for this <CODE>SOAPPart</CODE> |
| object as an iterator over the <CODE>MimeHeader</CODE> |
| objects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract javax.xml.transform.Source</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#getContent()">getContent</A></B>()</CODE> |
| |
| <BR> |
| Returns the content of the SOAPEnvelope as a JAXP <CODE> |
| Source</CODE> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#getContentId()">getContentId</A></B>()</CODE> |
| |
| <BR> |
| Retrieves the value of the MIME header whose name is |
| "Content-Id".</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#getContentLocation()">getContentLocation</A></B>()</CODE> |
| |
| <BR> |
| Retrieves the value of the MIME header whose name is |
| "Content-Location".</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract <A HREF="../../../javax/xml/soap/SOAPEnvelope.html" title="interface in javax.xml.soap">SOAPEnvelope</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#getEnvelope()">getEnvelope</A></B>()</CODE> |
| |
| <BR> |
| Gets the <CODE>SOAPEnvelope</CODE> object associated with |
| this <CODE>SOAPPart</CODE> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.util.Iterator</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#getMatchingMimeHeaders(java.lang.String[])">getMatchingMimeHeaders</A></B>(java.lang.String[] names)</CODE> |
| |
| <BR> |
| Retrieves all <CODE>MimeHeader</CODE> objects that match |
| a name in the given array.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.lang.String[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#getMimeHeader(java.lang.String)">getMimeHeader</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Gets all the values of the <CODE>MimeHeader</CODE> object |
| in this <CODE>SOAPPart</CODE> object that is identified by |
| the given <CODE>String</CODE>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.util.Iterator</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#getNonMatchingMimeHeaders(java.lang.String[])">getNonMatchingMimeHeaders</A></B>(java.lang.String[] names)</CODE> |
| |
| <BR> |
| Retrieves all <CODE>MimeHeader</CODE> objects whose name |
| does not match a name in the given array.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#removeAllMimeHeaders()">removeAllMimeHeaders</A></B>()</CODE> |
| |
| <BR> |
| Removes all the <CODE>MimeHeader</CODE> objects for this |
| <CODE>SOAPEnvelope</CODE> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#removeMimeHeader(java.lang.String)">removeMimeHeader</A></B>(java.lang.String header)</CODE> |
| |
| <BR> |
| Removes all MIME headers that match the given name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#setContent(javax.xml.transform.Source)">setContent</A></B>(javax.xml.transform.Source source)</CODE> |
| |
| <BR> |
| Sets the content of the <CODE>SOAPEnvelope</CODE> object |
| with the data from the given <CODE>Source</CODE> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#setContentId(java.lang.String)">setContentId</A></B>(java.lang.String contentId)</CODE> |
| |
| <BR> |
| Sets the value of the MIME header named "Content-Id" to |
| the given <CODE>String</CODE>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#setContentLocation(java.lang.String)">setContentLocation</A></B>(java.lang.String contentLocation)</CODE> |
| |
| <BR> |
| Sets the value of the MIME header "Content-Location" to |
| the given <CODE>String</CODE>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPPart.html#setMimeHeader(java.lang.String, java.lang.String)">setMimeHeader</A></B>(java.lang.String name, |
| java.lang.String value)</CODE> |
| |
| <BR> |
| 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.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.w3c.dom.Document"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from interface org.w3c.dom.Document</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, importNode</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.w3c.dom.Node"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from interface org.w3c.dom.Node</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>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</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="SOAPPart()"><!-- --></A><H3> |
| SOAPPart</H3> |
| <PRE> |
| public <B>SOAPPart</B>()</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getEnvelope()"><!-- --></A><H3> |
| getEnvelope</H3> |
| <PRE> |
| public abstract <A HREF="../../../javax/xml/soap/SOAPEnvelope.html" title="interface in javax.xml.soap">SOAPEnvelope</A> <B>getEnvelope</B>() |
| throws <A HREF="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Gets the <CODE>SOAPEnvelope</CODE> object associated with |
| this <CODE>SOAPPart</CODE> object. Once the SOAP envelope is |
| obtained, it can be used to get its contents. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <CODE>SOAPEnvelope</CODE> object for this <CODE> |
| SOAPPart</CODE> object |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</A></CODE> - if there is a SOAP error</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContentId()"><!-- --></A><H3> |
| getContentId</H3> |
| <PRE> |
| public java.lang.String <B>getContentId</B>()</PRE> |
| <DL> |
| <DD>Retrieves the value of the MIME header whose name is |
| "Content-Id". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a <CODE>String</CODE> giving the value of the MIME |
| header named "Content-Id"<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/soap/SOAPPart.html#setContentId(java.lang.String)"><CODE>setContentId(java.lang.String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContentLocation()"><!-- --></A><H3> |
| getContentLocation</H3> |
| <PRE> |
| public java.lang.String <B>getContentLocation</B>()</PRE> |
| <DL> |
| <DD>Retrieves the value of the MIME header whose name is |
| "Content-Location". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a <CODE>String</CODE> giving the value of the MIME |
| header whose name is "Content-Location"<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/soap/SOAPPart.html#setContentLocation(java.lang.String)"><CODE>setContentLocation(java.lang.String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setContentId(java.lang.String)"><!-- --></A><H3> |
| setContentId</H3> |
| <PRE> |
| public void <B>setContentId</B>(java.lang.String contentId)</PRE> |
| <DL> |
| <DD>Sets the value of the MIME header named "Content-Id" to |
| the given <CODE>String</CODE>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>contentId</CODE> - a <CODE>String</CODE> giving |
| the value of the MIME header "Content-Id" |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if |
| there is a problem in setting the content id<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/soap/SOAPPart.html#getContentId()"><CODE>getContentId()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setContentLocation(java.lang.String)"><!-- --></A><H3> |
| setContentLocation</H3> |
| <PRE> |
| public void <B>setContentLocation</B>(java.lang.String contentLocation)</PRE> |
| <DL> |
| <DD>Sets the value of the MIME header "Content-Location" to |
| the given <CODE>String</CODE>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>contentLocation</CODE> - a <CODE>String</CODE> |
| giving the value of the MIME header |
| "Content-Location" |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if |
| there is a problem in setting the content location.<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/soap/SOAPPart.html#getContentLocation()"><CODE>getContentLocation()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeMimeHeader(java.lang.String)"><!-- --></A><H3> |
| removeMimeHeader</H3> |
| <PRE> |
| public abstract void <B>removeMimeHeader</B>(java.lang.String header)</PRE> |
| <DL> |
| <DD>Removes all MIME headers that match the given name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>header</CODE> - a <CODE>String</CODE> giving |
| the name of the MIME header(s) to be removed</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeAllMimeHeaders()"><!-- --></A><H3> |
| removeAllMimeHeaders</H3> |
| <PRE> |
| public abstract void <B>removeAllMimeHeaders</B>()</PRE> |
| <DL> |
| <DD>Removes all the <CODE>MimeHeader</CODE> objects for this |
| <CODE>SOAPEnvelope</CODE> object. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMimeHeader(java.lang.String)"><!-- --></A><H3> |
| getMimeHeader</H3> |
| <PRE> |
| public abstract java.lang.String[] <B>getMimeHeader</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Gets all the values of the <CODE>MimeHeader</CODE> object |
| in this <CODE>SOAPPart</CODE> object that is identified by |
| the given <CODE>String</CODE>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the header; example: |
| "Content-Type" |
| <DT><B>Returns:</B><DD>a <CODE>String</CODE> array giving all the values for |
| the specified header<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/soap/SOAPPart.html#setMimeHeader(java.lang.String, java.lang.String)"><CODE>setMimeHeader(java.lang.String, java.lang.String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setMimeHeader(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| setMimeHeader</H3> |
| <PRE> |
| public abstract void <B>setMimeHeader</B>(java.lang.String name, |
| java.lang.String value)</PRE> |
| <DL> |
| <DD>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. |
| |
| <P>Note that RFC822 headers can contain only US-ASCII |
| characters.</P> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - a <CODE>String</CODE> giving the |
| header name for which to search<DD><CODE>value</CODE> - a <CODE>String</CODE> 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 <CODE>MimeHeader</CODE> object. |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if |
| there was a problem with the specified mime header name |
| or value |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if there was a problem with the specified mime header name or value<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/soap/SOAPPart.html#getMimeHeader(java.lang.String)"><CODE>getMimeHeader(java.lang.String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addMimeHeader(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| addMimeHeader</H3> |
| <PRE> |
| public abstract void <B>addMimeHeader</B>(java.lang.String name, |
| java.lang.String value)</PRE> |
| <DL> |
| <DD>Creates a <CODE>MimeHeader</CODE> object with the specified |
| name and value and adds it to this <CODE>SOAPPart</CODE> |
| object. If a <CODE>MimeHeader</CODE> with the specified |
| name already exists, this method adds the specified value |
| to the already existing value(s). |
| |
| <P>Note that RFC822 headers can contain only US-ASCII |
| characters.</P> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - a <CODE>String</CODE> giving the |
| header name<DD><CODE>value</CODE> - a <CODE>String</CODE> giving the |
| value to be set or added |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if |
| there was a problem with the specified mime header name |
| or value</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAllMimeHeaders()"><!-- --></A><H3> |
| getAllMimeHeaders</H3> |
| <PRE> |
| public abstract java.util.Iterator <B>getAllMimeHeaders</B>()</PRE> |
| <DL> |
| <DD>Retrieves all the headers for this <CODE>SOAPPart</CODE> |
| object as an iterator over the <CODE>MimeHeader</CODE> |
| objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an <CODE>Iterator</CODE> object with all of the Mime |
| headers for this <CODE>SOAPPart</CODE> object</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMatchingMimeHeaders(java.lang.String[])"><!-- --></A><H3> |
| getMatchingMimeHeaders</H3> |
| <PRE> |
| public abstract java.util.Iterator <B>getMatchingMimeHeaders</B>(java.lang.String[] names)</PRE> |
| <DL> |
| <DD>Retrieves all <CODE>MimeHeader</CODE> objects that match |
| a name in the given array. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>names</CODE> - a <CODE>String</CODE> array with |
| the name(s) of the MIME headers to be returned |
| <DT><B>Returns:</B><DD>all of the MIME headers that match one of the names |
| in the given array, returned as an <CODE>Iterator</CODE> |
| object</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getNonMatchingMimeHeaders(java.lang.String[])"><!-- --></A><H3> |
| getNonMatchingMimeHeaders</H3> |
| <PRE> |
| public abstract java.util.Iterator <B>getNonMatchingMimeHeaders</B>(java.lang.String[] names)</PRE> |
| <DL> |
| <DD>Retrieves all <CODE>MimeHeader</CODE> objects whose name |
| does not match a name in the given array. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>names</CODE> - a <CODE>String</CODE> array with |
| the name(s) of the MIME headers not to be returned |
| <DT><B>Returns:</B><DD>all of the MIME headers in this <CODE>SOAPPart</CODE> |
| object except those that match one of the names in the |
| given array. The nonmatching MIME headers are returned as |
| an <CODE>Iterator</CODE> object.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setContent(javax.xml.transform.Source)"><!-- --></A><H3> |
| setContent</H3> |
| <PRE> |
| public abstract void <B>setContent</B>(javax.xml.transform.Source source) |
| throws <A HREF="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Sets the content of the <CODE>SOAPEnvelope</CODE> object |
| with the data from the given <CODE>Source</CODE> object. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>source</CODE> - javax.xml.transform.Source</CODE> object with the data to |
| be set |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</A></CODE> - if there is a problem in |
| setting the source<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/soap/SOAPPart.html#getContent()"><CODE>getContent()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContent()"><!-- --></A><H3> |
| getContent</H3> |
| <PRE> |
| public abstract javax.xml.transform.Source <B>getContent</B>() |
| throws <A HREF="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Returns the content of the SOAPEnvelope as a JAXP <CODE> |
| Source</CODE> object. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the content as a <CODE> |
| javax.xml.transform.Source</CODE> object |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</A></CODE> - if the implementation cannot |
| convert the specified <CODE>Source</CODE> object<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/soap/SOAPPart.html#setContent(javax.xml.transform.Source)"><CODE>setContent(javax.xml.transform.Source)</CODE></A></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SOAPPart.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SOAPPart.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2005 Apache Web Services Project. All Rights Reserved. |
| </BODY> |
| </HTML> |
