| <!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:42 PDT 2006 --> |
| <TITLE> |
| SOAPEnvelope (Axis API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="javax.xml.soap.SOAPEnvelope interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="SOAPEnvelope (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/SOAPEnvelope.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/SOAPElement.html" title="interface in javax.xml.soap"><B>PREV CLASS</B></A> |
| <A HREF="../../../javax/xml/soap/SOAPFault.html" title="interface in javax.xml.soap"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SOAPEnvelope.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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> |
| Interface SOAPEnvelope</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD>org.w3c.dom.Element, <A HREF="../../../javax/xml/soap/Node.html" title="interface in javax.xml.soap">Node</A>, org.w3c.dom.Node, <A HREF="../../../javax/xml/soap/SOAPElement.html" title="interface in javax.xml.soap">SOAPElement</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/apache/axis/message/SOAPEnvelope.html" title="class in org.apache.axis.message">SOAPEnvelope</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public interface <B>SOAPEnvelope</B><DT>extends <A HREF="../../../javax/xml/soap/SOAPElement.html" title="interface in javax.xml.soap">SOAPElement</A></DL> |
| |
| <P> |
| The container for the SOAPHeader and SOAPBody portions of a |
| <CODE>SOAPPart</CODE> object. By default, a <CODE> |
| SOAPMessage</CODE> object is created with a <CODE> |
| SOAPPart</CODE> object that has a <CODE>SOAPEnvelope</CODE> |
| object. The <CODE>SOAPEnvelope</CODE> object by default has an |
| empty <CODE>SOAPBody</CODE> object and an empty <CODE> |
| SOAPHeader</CODE> object. The <CODE>SOAPBody</CODE> object is |
| required, and the <CODE>SOAPHeader</CODE> object, though |
| optional, is used in the majority of cases. If the <CODE> |
| SOAPHeader</CODE> object is not needed, it can be deleted, |
| which is shown later.</P> |
| |
| <P>A client can access the <CODE>SOAPHeader</CODE> and <CODE> |
| SOAPBody</CODE> objects by calling the methods <CODE> |
| SOAPEnvelope.getHeader</CODE> and <CODE> |
| SOAPEnvelope.getBody</CODE>. The following lines of code use |
| these two methods after starting with the <CODE> |
| SOAPMessage</CODE> object <I>message</I> to get the <CODE> |
| SOAPPart</CODE> object <I>sp</I>, which is then used to get the |
| <CODE>SOAPEnvelope</CODE> object <I>se</I>.</P> |
| <PRE> |
| SOAPPart sp = message.getSOAPPart(); |
| SOAPEnvelope se = sp.getEnvelope(); |
| SOAPHeader sh = se.getHeader(); |
| SOAPBody sb = se.getBody(); |
| </PRE> |
| |
| <P>It is possible to change the body or header of a <CODE> |
| SOAPEnvelope</CODE> object by retrieving the current one, |
| deleting it, and then adding a new body or header. The <CODE> |
| javax.xml.soap.Node</CODE> method <CODE>detachNode</CODE> |
| detaches the XML element (node) on which it is called. For |
| example, the following line of code deletes the <CODE> |
| SOAPBody</CODE> object that is retrieved by the method <CODE> |
| getBody</CODE>.</P> |
| <PRE> |
| se.getBody().detachNode(); |
| </PRE> |
| To create a <CODE>SOAPHeader</CODE> object to replace the one |
| that was removed, a client uses the method <CODE> |
| SOAPEnvelope.addHeader</CODE>, which creates a new header and |
| adds it to the <CODE>SOAPEnvelope</CODE> object. Similarly, the |
| method <CODE>addBody</CODE> creates a new <CODE>SOAPBody</CODE> |
| object and adds it to the <CODE>SOAPEnvelope</CODE> object. The |
| following code fragment retrieves the current header, removes |
| it, and adds a new one. Then it retrieves the current body, |
| removes it, and adds a new one. |
| <PRE> |
| SOAPPart sp = message.getSOAPPart(); |
| SOAPEnvelope se = sp.getEnvelope(); |
| se.getHeader().detachNode(); |
| SOAPHeader sh = se.addHeader(); |
| se.getBody().detachNode(); |
| SOAPBody sb = se.addBody(); |
| </PRE> |
| It is an error to add a <CODE>SOAPBody</CODE> or <CODE> |
| SOAPHeader</CODE> object if one already exists. |
| |
| <P>The <CODE>SOAPEnvelope</CODE> interface provides three |
| methods for creating <CODE>Name</CODE> objects. One method |
| creates <CODE>Name</CODE> objects with a local name, a |
| namespace prefix, and a namesapce URI. The second method |
| creates <CODE>Name</CODE> objects with a local name and a |
| namespace prefix, and the third creates <CODE>Name</CODE> |
| objects with just a local name. The following line of code, in |
| which <I>se</I> is a <CODE>SOAPEnvelope</CODE> object, creates |
| a new <CODE>Name</CODE> object with all three.</P> |
| <PRE> |
| Name name = se.createName("GetLastTradePrice", "WOMBAT", |
| "http://www.wombat.org/trader"); |
| </PRE> |
| <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 ======== --> |
| |
| |
| <!-- ========== 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> <A HREF="../../../javax/xml/soap/SOAPBody.html" title="interface in javax.xml.soap">SOAPBody</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPEnvelope.html#addBody()">addBody</A></B>()</CODE> |
| |
| <BR> |
| Creates a <CODE>SOAPBody</CODE> object and sets it as the |
| <CODE>SOAPBody</CODE> object for this <CODE> |
| SOAPEnvelope</CODE> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/xml/soap/SOAPHeader.html" title="interface in javax.xml.soap">SOAPHeader</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPEnvelope.html#addHeader()">addHeader</A></B>()</CODE> |
| |
| <BR> |
| Creates a <CODE>SOAPHeader</CODE> object and sets it as the |
| <CODE>SOAPHeader</CODE> object for this <CODE> |
| SOAPEnvelope</CODE> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/xml/soap/Name.html" title="interface in javax.xml.soap">Name</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPEnvelope.html#createName(java.lang.String)">createName</A></B>(java.lang.String localName)</CODE> |
| |
| <BR> |
| Creates a new <CODE>Name</CODE> object initialized with the |
| given local name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/xml/soap/Name.html" title="interface in javax.xml.soap">Name</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPEnvelope.html#createName(java.lang.String, java.lang.String, java.lang.String)">createName</A></B>(java.lang.String localName, |
| java.lang.String prefix, |
| java.lang.String uri)</CODE> |
| |
| <BR> |
| Creates a new <CODE>Name</CODE> object initialized with the |
| given local name, namespace prefix, and namespace URI.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/xml/soap/SOAPBody.html" title="interface in javax.xml.soap">SOAPBody</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPEnvelope.html#getBody()">getBody</A></B>()</CODE> |
| |
| <BR> |
| Returns the <CODE>SOAPBody</CODE> object associated with |
| this <CODE>SOAPEnvelope</CODE> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/xml/soap/SOAPHeader.html" title="interface in javax.xml.soap">SOAPHeader</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/xml/soap/SOAPEnvelope.html#getHeader()">getHeader</A></B>()</CODE> |
| |
| <BR> |
| Returns the <CODE>SOAPHeader</CODE> object for this <CODE> |
| SOAPEnvelope</CODE> object.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_javax.xml.soap.SOAPElement"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from interface javax.xml.soap.<A HREF="../../../javax/xml/soap/SOAPElement.html" title="interface in javax.xml.soap">SOAPElement</A></B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../javax/xml/soap/SOAPElement.html#addAttribute(javax.xml.soap.Name, java.lang.String)">addAttribute</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#addChildElement(javax.xml.soap.Name)">addChildElement</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#addChildElement(javax.xml.soap.SOAPElement)">addChildElement</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#addChildElement(java.lang.String)">addChildElement</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#addChildElement(java.lang.String, java.lang.String)">addChildElement</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#addChildElement(java.lang.String, java.lang.String, java.lang.String)">addChildElement</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#addNamespaceDeclaration(java.lang.String, java.lang.String)">addNamespaceDeclaration</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#addTextNode(java.lang.String)">addTextNode</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#getAllAttributes()">getAllAttributes</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#getAttributeValue(javax.xml.soap.Name)">getAttributeValue</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#getChildElements()">getChildElements</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#getChildElements(javax.xml.soap.Name)">getChildElements</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#getElementName()">getElementName</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#getEncodingStyle()">getEncodingStyle</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#getNamespacePrefixes()">getNamespacePrefixes</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#getNamespaceURI(java.lang.String)">getNamespaceURI</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#getVisibleNamespacePrefixes()">getVisibleNamespacePrefixes</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#removeAttribute(javax.xml.soap.Name)">removeAttribute</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#removeContents()">removeContents</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#removeNamespaceDeclaration(java.lang.String)">removeNamespaceDeclaration</A>, <A HREF="../../../javax/xml/soap/SOAPElement.html#setEncodingStyle(java.lang.String)">setEncodingStyle</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_javax.xml.soap.Node"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from interface javax.xml.soap.<A HREF="../../../javax/xml/soap/Node.html" title="interface in javax.xml.soap">Node</A></B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../javax/xml/soap/Node.html#detachNode()">detachNode</A>, <A HREF="../../../javax/xml/soap/Node.html#getParentElement()">getParentElement</A>, <A HREF="../../../javax/xml/soap/Node.html#getValue()">getValue</A>, <A HREF="../../../javax/xml/soap/Node.html#recycleNode()">recycleNode</A>, <A HREF="../../../javax/xml/soap/Node.html#setParentElement(javax.xml.soap.SOAPElement)">setParentElement</A>, <A HREF="../../../javax/xml/soap/Node.html#setValue(java.lang.String)">setValue</A></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> |
| <A NAME="methods_inherited_from_class_org.w3c.dom.Element"><!-- --></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.Element</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| |
| <!-- ============ 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="createName(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| createName</H3> |
| <PRE> |
| public <A HREF="../../../javax/xml/soap/Name.html" title="interface in javax.xml.soap">Name</A> <B>createName</B>(java.lang.String localName, |
| java.lang.String prefix, |
| java.lang.String uri) |
| throws <A HREF="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Creates a new <CODE>Name</CODE> object initialized with the |
| given local name, namespace prefix, and namespace URI. |
| |
| <P>This factory method creates <CODE>Name</CODE> objects |
| for use in the SOAP/XML document. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>localName</CODE> - a <CODE>String</CODE> giving |
| the local name<DD><CODE>prefix</CODE> - a <CODE>String</CODE> giving |
| the prefix of the namespace<DD><CODE>uri</CODE> - a <CODE>String</CODE> giving the |
| URI of the namespace |
| <DT><B>Returns:</B><DD>a <CODE>Name</CODE> object initialized with the given |
| local name, namespace prefix, and namespace URI |
| <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="createName(java.lang.String)"><!-- --></A><H3> |
| createName</H3> |
| <PRE> |
| public <A HREF="../../../javax/xml/soap/Name.html" title="interface in javax.xml.soap">Name</A> <B>createName</B>(java.lang.String localName) |
| throws <A HREF="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Creates a new <CODE>Name</CODE> object initialized with the |
| given local name. |
| |
| <P>This factory method creates <CODE>Name</CODE> objects |
| for use in the SOAP/XML document. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>localName</CODE> - a <CODE>String</CODE> giving |
| the local name |
| <DT><B>Returns:</B><DD>a <CODE>Name</CODE> object initialized with the given |
| local name |
| <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="getHeader()"><!-- --></A><H3> |
| getHeader</H3> |
| <PRE> |
| public <A HREF="../../../javax/xml/soap/SOAPHeader.html" title="interface in javax.xml.soap">SOAPHeader</A> <B>getHeader</B>() |
| throws <A HREF="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Returns the <CODE>SOAPHeader</CODE> object for this <CODE> |
| SOAPEnvelope</CODE> object. |
| |
| <P>A new <CODE>SOAPMessage</CODE> object is by default |
| created with a <CODE>SOAPEnvelope</CODE> object that |
| contains an empty <CODE>SOAPHeader</CODE> object. As a |
| result, the method <CODE>getHeader</CODE> will always |
| return a <CODE>SOAPHeader</CODE> object unless the header |
| has been removed and a new one has not been added. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <CODE>SOAPHeader</CODE> object or <CODE> |
| null</CODE> if there is none |
| <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 |
| obtaining the <CODE>SOAPHeader</CODE> object</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBody()"><!-- --></A><H3> |
| getBody</H3> |
| <PRE> |
| public <A HREF="../../../javax/xml/soap/SOAPBody.html" title="interface in javax.xml.soap">SOAPBody</A> <B>getBody</B>() |
| throws <A HREF="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Returns the <CODE>SOAPBody</CODE> object associated with |
| this <CODE>SOAPEnvelope</CODE> object. |
| |
| <P>A new <CODE>SOAPMessage</CODE> object is by default |
| created with a <CODE>SOAPEnvelope</CODE> object that |
| contains an empty <CODE>SOAPBody</CODE> object. As a |
| result, the method <CODE>getBody</CODE> will always return |
| a <CODE>SOAPBody</CODE> object unless the body has been |
| removed and a new one has not been added. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <CODE>SOAPBody</CODE> object for this <CODE> |
| SOAPEnvelope</CODE> object or <CODE>null</CODE> if there |
| is none |
| <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 |
| obtaining the <CODE>SOAPBody</CODE> object</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addHeader()"><!-- --></A><H3> |
| addHeader</H3> |
| <PRE> |
| public <A HREF="../../../javax/xml/soap/SOAPHeader.html" title="interface in javax.xml.soap">SOAPHeader</A> <B>addHeader</B>() |
| throws <A HREF="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Creates a <CODE>SOAPHeader</CODE> object and sets it as the |
| <CODE>SOAPHeader</CODE> object for this <CODE> |
| SOAPEnvelope</CODE> object. |
| |
| <P>It is illegal to add a header when the envelope already |
| contains a header. Therefore, this method should be called |
| only after the existing header has been removed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the new <CODE>SOAPHeader</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 this <CODE> |
| SOAPEnvelope</CODE> object already contains a valid |
| <CODE>SOAPHeader</CODE> object</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addBody()"><!-- --></A><H3> |
| addBody</H3> |
| <PRE> |
| public <A HREF="../../../javax/xml/soap/SOAPBody.html" title="interface in javax.xml.soap">SOAPBody</A> <B>addBody</B>() |
| throws <A HREF="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Creates a <CODE>SOAPBody</CODE> object and sets it as the |
| <CODE>SOAPBody</CODE> object for this <CODE> |
| SOAPEnvelope</CODE> object. |
| |
| <P>It is illegal to add a body when the envelope already |
| contains a body. Therefore, this method should be called |
| only after the existing body has been removed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the new <CODE>SOAPBody</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 this <CODE> |
| SOAPEnvelope</CODE> object already contains a valid |
| <CODE>SOAPBody</CODE> object</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/SOAPEnvelope.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/SOAPElement.html" title="interface in javax.xml.soap"><B>PREV CLASS</B></A> |
| <A HREF="../../../javax/xml/soap/SOAPFault.html" title="interface in javax.xml.soap"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SOAPEnvelope.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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> |