| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SOAPPart</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SOAPPart"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":10,"i4":10,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":10,"i13":10,"i14":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/xml/soap/SOAPMessage.html" title="class in jakarta.xml.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/xml/soap/Text.html" title="interface in jakarta.xml.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/xml/soap/SOAPPart.html" target="_top">Frames</a></li> |
| <li><a href="SOAPPart.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.xml.soap</div> |
| <h2 title="Class SOAPPart" class="title">Class SOAPPart</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.xml.soap.SOAPPart</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.w3c.dom.Document, org.w3c.dom.Node</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">SOAPPart</span> |
| extends java.lang.Object |
| implements org.w3c.dom.Document, <a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap">Node</a></pre> |
| <div class="block">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> |
| 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> |
| 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> |
| 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. |
| <pre><code> |
| SOAPPart soapPart = message.getSOAPPart(); |
| </code></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.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.w3c.dom.Node"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.w3c.dom.Node</h3> |
| <code>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</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#SOAPPart--">SOAPPart</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#addMimeHeader-java.lang.String-java.lang.String-">addMimeHeader</a></span>(java.lang.String name, |
| java.lang.String value)</code> |
| <div class="block">Creates a <code>MimeHeader</code> object with the specified |
| name and value and adds it to this <code>SOAPPart</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.Iterator<<a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap">MimeHeader</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#getAllMimeHeaders--">getAllMimeHeaders</a></span>()</code> |
| <div class="block">Retrieves all the headers for this <code>SOAPPart</code> object |
| as an iterator over the <code>MimeHeader</code> objects.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract javax.xml.transform.Source</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#getContent--">getContent</a></span>()</code> |
| <div class="block">Returns the content of the SOAPEnvelope as a JAXP <code>Source</code> |
| object.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#getContentId--">getContentId</a></span>()</code> |
| <div class="block">Retrieves the value of the MIME header whose name is "Content-Id".</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#getContentLocation--">getContentLocation</a></span>()</code> |
| <div class="block">Retrieves the value of the MIME header whose name is "Content-Location".</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../jakarta/xml/soap/SOAPEnvelope.html" title="interface in jakarta.xml.soap">SOAPEnvelope</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#getEnvelope--">getEnvelope</a></span>()</code> |
| <div class="block">Gets the <code>SOAPEnvelope</code> object associated with this |
| <code>SOAPPart</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.Iterator<<a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap">MimeHeader</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#getMatchingMimeHeaders-java.lang.String:A-">getMatchingMimeHeaders</a></span>(java.lang.String[] names)</code> |
| <div class="block">Retrieves all <code>MimeHeader</code> objects that match a name in |
| the given array.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract java.lang.String[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#getMimeHeader-java.lang.String-">getMimeHeader</a></span>(java.lang.String name)</code> |
| <div class="block">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>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.Iterator<<a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap">MimeHeader</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#getNonMatchingMimeHeaders-java.lang.String:A-">getNonMatchingMimeHeaders</a></span>(java.lang.String[] names)</code> |
| <div class="block">Retrieves all <code>MimeHeader</code> objects whose name does |
| not match a name in the given array.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#removeAllMimeHeaders--">removeAllMimeHeaders</a></span>()</code> |
| <div class="block">Removes all the <code>MimeHeader</code> objects for this |
| <code>SOAPEnvelope</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#removeMimeHeader-java.lang.String-">removeMimeHeader</a></span>(java.lang.String header)</code> |
| <div class="block">Removes all MIME headers that match the given name.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#setContent-javax.xml.transform.Source-">setContent</a></span>(javax.xml.transform.Source source)</code> |
| <div class="block">Sets the content of the <code>SOAPEnvelope</code> object with the data |
| from the given <code>Source</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#setContentId-java.lang.String-">setContentId</a></span>(java.lang.String contentId)</code> |
| <div class="block">Sets the value of the MIME header named "Content-Id" |
| to the given <code>String</code>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#setContentLocation-java.lang.String-">setContentLocation</a></span>(java.lang.String contentLocation)</code> |
| <div class="block">Sets the value of the MIME header "Content-Location" |
| to the given <code>String</code>.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPPart.html#setMimeHeader-java.lang.String-java.lang.String-">setMimeHeader</a></span>(java.lang.String name, |
| java.lang.String value)</code> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.w3c.dom.Document"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.w3c.dom.Document</h3> |
| <code>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</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.jakarta.xml.soap.Node"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface jakarta.xml.soap.<a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap">Node</a></h3> |
| <code><a href="../../../jakarta/xml/soap/Node.html#detachNode--">detachNode</a>, <a href="../../../jakarta/xml/soap/Node.html#getParentElement--">getParentElement</a>, <a href="../../../jakarta/xml/soap/Node.html#getValue--">getValue</a>, <a href="../../../jakarta/xml/soap/Node.html#recycleNode--">recycleNode</a>, <a href="../../../jakarta/xml/soap/Node.html#setParentElement-jakarta.xml.soap.SOAPElement-">setParentElement</a>, <a href="../../../jakarta/xml/soap/Node.html#setValue-java.lang.String-">setValue</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.w3c.dom.Node"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.w3c.dom.Node</h3> |
| <code>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</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SOAPPart--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SOAPPart</h4> |
| <pre>public SOAPPart()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getEnvelope--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnvelope</h4> |
| <pre>public abstract <a href="../../../jakarta/xml/soap/SOAPEnvelope.html" title="interface in jakarta.xml.soap">SOAPEnvelope</a> getEnvelope() |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>SOAPEnvelope</code> object for this |
| <code>SOAPPart</code> object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is a SOAP error</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentId</h4> |
| <pre>public java.lang.String getContentId()</pre> |
| <div class="block">Retrieves the value of the MIME header whose name is "Content-Id".</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> giving the value of the MIME header |
| named "Content-Id"</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPPart.html#setContentId-java.lang.String-"><code>setContentId(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentLocation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentLocation</h4> |
| <pre>public java.lang.String getContentLocation()</pre> |
| <div class="block">Retrieves the value of the MIME header whose name is "Content-Location".</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> giving the value of the MIME header whose |
| name is "Content-Location"</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPPart.html#setContentLocation-java.lang.String-"><code>setContentLocation(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setContentId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentId</h4> |
| <pre>public void setContentId(java.lang.String contentId)</pre> |
| <div class="block">Sets the value of the MIME header named "Content-Id" |
| to the given <code>String</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>contentId</code> - a <code>String</code> giving the value of the MIME |
| header "Content-Id"</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there is a problem in |
| setting the content id</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPPart.html#getContentId--"><code>getContentId()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setContentLocation-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentLocation</h4> |
| <pre>public void setContentLocation(java.lang.String contentLocation)</pre> |
| <div class="block">Sets the value of the MIME header "Content-Location" |
| to the given <code>String</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>contentLocation</code> - a <code>String</code> giving the value |
| of the MIME |
| header "Content-Location"</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there is a problem in |
| setting the content location.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPPart.html#getContentLocation--"><code>getContentLocation()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeMimeHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeMimeHeader</h4> |
| <pre>public abstract void removeMimeHeader(java.lang.String header)</pre> |
| <div class="block">Removes all MIME headers that match the given name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>header</code> - a <code>String</code> giving the name of the MIME header(s) to |
| be removed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAllMimeHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAllMimeHeaders</h4> |
| <pre>public abstract void removeAllMimeHeaders()</pre> |
| <div class="block">Removes all the <code>MimeHeader</code> objects for this |
| <code>SOAPEnvelope</code> object.</div> |
| </li> |
| </ul> |
| <a name="getMimeHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMimeHeader</h4> |
| <pre>public abstract java.lang.String[] getMimeHeader(java.lang.String name)</pre> |
| <div class="block">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>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the header; example: "Content-Type"</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> array giving all the values for the |
| specified header</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPPart.html#setMimeHeader-java.lang.String-java.lang.String-"><code>setMimeHeader(java.lang.String, java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMimeHeader-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMimeHeader</h4> |
| <pre>public abstract void setMimeHeader(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a <code>String</code> giving the header name |
| for which to search</dd> |
| <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.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there was a problem with |
| the specified mime header name or value</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPPart.html#getMimeHeader-java.lang.String-"><code>getMimeHeader(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addMimeHeader-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMimeHeader</h4> |
| <pre>public abstract void addMimeHeader(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a <code>String</code> giving the header name</dd> |
| <dd><code>value</code> - a <code>String</code> giving the value to be set |
| or added</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there was a problem with |
| the specified mime header name or value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllMimeHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllMimeHeaders</h4> |
| <pre>public abstract java.util.Iterator<<a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap">MimeHeader</a>> getAllMimeHeaders()</pre> |
| <div class="block">Retrieves all the headers for this <code>SOAPPart</code> object |
| as an iterator over the <code>MimeHeader</code> objects.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>Iterator</code> object with all of the Mime |
| headers for this <code>SOAPPart</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMatchingMimeHeaders-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMatchingMimeHeaders</h4> |
| <pre>public abstract java.util.Iterator<<a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap">MimeHeader</a>> getMatchingMimeHeaders(java.lang.String[] names)</pre> |
| <div class="block">Retrieves all <code>MimeHeader</code> objects that match a name in |
| the given array.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - a <code>String</code> array with the name(s) of the |
| MIME headers to be returned</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all of the MIME headers that match one of the names in the |
| given array, returned as an <code>Iterator</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNonMatchingMimeHeaders-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNonMatchingMimeHeaders</h4> |
| <pre>public abstract java.util.Iterator<<a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap">MimeHeader</a>> getNonMatchingMimeHeaders(java.lang.String[] names)</pre> |
| <div class="block">Retrieves all <code>MimeHeader</code> objects whose name does |
| not match a name in the given array.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - a <code>String</code> array with the name(s) of the |
| MIME headers not to be returned</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <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.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setContent-javax.xml.transform.Source-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContent</h4> |
| <pre>public abstract void setContent(javax.xml.transform.Source source) |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Sets the content of the <code>SOAPEnvelope</code> object with the data |
| from the given <code>Source</code> object. This <code>Source</code> |
| must contain a valid SOAP document.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the <code>javax.xml.transform.Source</code> object with the |
| data to be set</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is a problem in setting the source</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPPart.html#getContent--"><code>getContent()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContent--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getContent</h4> |
| <pre>public abstract javax.xml.transform.Source getContent() |
| throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre> |
| <div class="block">Returns the content of the SOAPEnvelope as a JAXP <code>Source</code> |
| object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the content as a <code>javax.xml.transform.Source</code> object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if the implementation cannot convert |
| the specified <code>Source</code> object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPPart.html#setContent-javax.xml.transform.Source-"><code>setContent(javax.xml.transform.Source)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/xml/soap/SOAPMessage.html" title="class in jakarta.xml.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/xml/soap/Text.html" title="interface in jakarta.xml.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/xml/soap/SOAPPart.html" target="_top">Frames</a></li> |
| <li><a href="SOAPPart.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
