| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SOAPMessage</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="SOAPMessage"; |
| } |
| } |
| 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":10,"i11":10,"i12":10,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":10,"i20":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="../../../javax/xml/soap/SOAPHeaderElement.html" title="interface in javax.xml.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/xml/soap/SOAPPart.html" title="class in javax.xml.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/xml/soap/SOAPMessage.html" target="_top">Frames</a></li> |
| <li><a href="SOAPMessage.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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">javax.xml.soap</div> |
| <h2 title="Class SOAPMessage" class="title">Class SOAPMessage</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.xml.soap.SOAPMessage</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">SOAPMessage</span> |
| extends java.lang.Object</pre> |
| <div class="block">The root class for all SOAP messages. As transmitted on the "wire", a SOAP |
| message is an XML document or a MIME message whose first body part is an |
| XML/SOAP document. |
| <P> |
| A <code>SOAPMessage</code> object consists of a SOAP part and optionally |
| one or more attachment parts. The SOAP part for a <code>SOAPMessage</code> |
| object is a <code>SOAPPart</code> object, which contains information used |
| for message routing and identification, and which can contain |
| application-specific content. All data in the SOAP Part of a message must be |
| in XML format. |
| <P> |
| A new <code>SOAPMessage</code> object contains the following by default: |
| <UL> |
| <LI>A <code>SOAPPart</code> object |
| <LI>A <code>SOAPEnvelope</code> object |
| <LI>A <code>SOAPBody</code> object |
| <LI>A <code>SOAPHeader</code> object |
| </UL> |
| The SOAP part of a message can be retrieved by calling the method <code>SOAPMessage.getSOAPPart()</code>. |
| The <code>SOAPEnvelope</code> object is retrieved from the <code>SOAPPart</code> |
| object, and the <code>SOAPEnvelope</code> object is used to retrieve the |
| <code>SOAPBody</code> and <code>SOAPHeader</code> objects. |
| |
| <pre><code> |
| SOAPPart sp = message.getSOAPPart(); |
| SOAPEnvelope se = sp.getEnvelope(); |
| SOAPBody sb = se.getBody(); |
| SOAPHeader sh = se.getHeader(); |
| </code></pre> |
| |
| <P> |
| In addition to the mandatory <code>SOAPPart</code> object, a <code>SOAPMessage</code> |
| object may contain zero or more <code>AttachmentPart</code> objects, each |
| of which contains application-specific data. The <code>SOAPMessage</code> |
| interface provides methods for creating <code>AttachmentPart</code> |
| objects and also for adding them to a <code>SOAPMessage</code> object. A |
| party that has received a <code>SOAPMessage</code> object can examine its |
| contents by retrieving individual attachment parts. |
| <P> |
| Unlike the rest of a SOAP message, an attachment is not required to be in |
| XML format and can therefore be anything from simple text to an image file. |
| Consequently, any message content that is not in XML format must be in an |
| <code>AttachmentPart</code> object. |
| <P> |
| A <code>MessageFactory</code> object may create <code>SOAPMessage</code> |
| objects with behavior that is specialized to a particular implementation or |
| application of SAAJ. For instance, a <code>MessageFactory</code> object |
| may produce <code>SOAPMessage</code> objects that conform to a particular |
| Profile such as ebXML. In this case a <code>MessageFactory</code> object |
| might produce <code>SOAPMessage</code> objects that are initialized with |
| ebXML headers. |
| <P> |
| In order to ensure backward source compatibility, methods that are added to |
| this class after version 1.1 of the SAAJ specification are all concrete |
| instead of abstract and they all have default implementations. Unless |
| otherwise noted in the JavaDocs for those methods the default |
| implementations simply throw an <code>UnsupportedOperationException</code> |
| and the SAAJ implementation code must override them with methods that |
| provide the specified behavior. Legacy client code does not have this |
| restriction, however, so long as there is no claim made that it conforms to |
| some later version of the specification than it was originally written for. |
| A legacy class that extends the SOAPMessage class can be compiled and/or run |
| against succeeding versions of the SAAJ API without modification. If such a |
| class was correctly implemented then it will continue to behave correctly |
| relative to the version of the specification against which it was written.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/xml/soap/MessageFactory.html" title="class in javax.xml.soap"><code>MessageFactory</code></a>, |
| <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap"><code>AttachmentPart</code></a></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> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#CHARACTER_SET_ENCODING">CHARACTER_SET_ENCODING</a></span></code> |
| <div class="block">Specifies the character type encoding for the SOAP Message.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#WRITE_XML_DECLARATION">WRITE_XML_DECLARATION</a></span></code> |
| <div class="block">Specifies whether the SOAP Message will contain an XML declaration when |
| it is sent.</div> |
| </td> |
| </tr> |
| </table> |
| </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="../../../javax/xml/soap/SOAPMessage.html#SOAPMessage--">SOAPMessage</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="../../../javax/xml/soap/SOAPMessage.html#addAttachmentPart-javax.xml.soap.AttachmentPart-">addAttachmentPart</a></span>(<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a> attachmentPart)</code> |
| <div class="block">Adds the given <code>AttachmentPart</code> object to this <code>SOAPMessage</code> |
| object.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#countAttachments--">countAttachments</a></span>()</code> |
| <div class="block">Gets a count of the number of attachments in this message.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#createAttachmentPart--">createAttachmentPart</a></span>()</code> |
| <div class="block">Creates a new empty <code>AttachmentPart</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#createAttachmentPart-javax.activation.DataHandler-">createAttachmentPart</a></span>(javax.activation.DataHandler dataHandler)</code> |
| <div class="block">Creates an <code>AttachmentPart</code> object and populates it using |
| the given <code>DataHandler</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#createAttachmentPart-java.lang.Object-java.lang.String-">createAttachmentPart</a></span>(java.lang.Object content, |
| java.lang.String contentType)</code> |
| <div class="block">Creates an <code>AttachmentPart</code> object and populates it with |
| the specified data of the specified content type.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getAttachment-javax.xml.soap.SOAPElement-">getAttachment</a></span>(<a href="../../../javax/xml/soap/SOAPElement.html" title="interface in javax.xml.soap">SOAPElement</a> element)</code> |
| <div class="block">Returns an <code>AttachmentPart</code> object that is associated with an |
| attachment that is referenced by this <code>SOAPElement</code> or |
| <code>null</code> if no such attachment exists.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.Iterator<<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getAttachments--">getAttachments</a></span>()</code> |
| <div class="block">Retrieves all the <code>AttachmentPart</code> objects that are part of |
| this <code>SOAPMessage</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.Iterator<<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getAttachments-javax.xml.soap.MimeHeaders-">getAttachments</a></span>(<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> headers)</code> |
| <div class="block">Retrieves all the <code>AttachmentPart</code> objects that have header |
| entries that match the specified headers.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getContentDescription--">getContentDescription</a></span>()</code> |
| <div class="block">Retrieves a description of this <code>SOAPMessage</code> object's |
| content.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getMimeHeaders--">getMimeHeaders</a></span>()</code> |
| <div class="block">Returns all the transport-specific MIME headers for this <code>SOAPMessage</code> |
| object in a transport-independent fashion.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getProperty-java.lang.String-">getProperty</a></span>(java.lang.String property)</code> |
| <div class="block">Retrieves value of the specified property.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/xml/soap/SOAPBody.html" title="interface in javax.xml.soap">SOAPBody</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPBody--">getSOAPBody</a></span>()</code> |
| <div class="block">Gets the SOAP Body contained in this <code>SOAPMessage</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/xml/soap/SOAPHeader.html" title="interface in javax.xml.soap">SOAPHeader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPHeader--">getSOAPHeader</a></span>()</code> |
| <div class="block">Gets the SOAP Header contained in this <code>SOAPMessage</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../javax/xml/soap/SOAPPart.html" title="class in javax.xml.soap">SOAPPart</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPPart--">getSOAPPart</a></span>()</code> |
| <div class="block">Gets the SOAP part of this <code>SOAPMessage</code> object.</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="../../../javax/xml/soap/SOAPMessage.html#removeAllAttachments--">removeAllAttachments</a></span>()</code> |
| <div class="block">Removes all <code>AttachmentPart</code> objects that have been added |
| to this <code>SOAPMessage</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#removeAttachments-javax.xml.soap.MimeHeaders-">removeAttachments</a></span>(<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> headers)</code> |
| <div class="block">Removes all the <code>AttachmentPart</code> objects that have header |
| entries that match the specified headers.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#saveChanges--">saveChanges</a></span>()</code> |
| <div class="block">Updates this <code>SOAPMessage</code> object with all the changes that |
| have been made to it.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#saveRequired--">saveRequired</a></span>()</code> |
| <div class="block">Indicates whether this <code>SOAPMessage</code> object needs to have |
| the method <code>saveChanges</code> called on it.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#setContentDescription-java.lang.String-">setContentDescription</a></span>(java.lang.String description)</code> |
| <div class="block">Sets the description of this <code>SOAPMessage</code> object's |
| content with the given description.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#setProperty-java.lang.String-java.lang.Object-">setProperty</a></span>(java.lang.String property, |
| java.lang.Object value)</code> |
| <div class="block">Associates the specified value with the specified property.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPMessage.html#writeTo-java.io.OutputStream-">writeTo</a></span>(java.io.OutputStream out)</code> |
| <div class="block">Writes this <code>SOAPMessage</code> object to the given output |
| stream.</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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="CHARACTER_SET_ENCODING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CHARACTER_SET_ENCODING</h4> |
| <pre>public static final java.lang.String CHARACTER_SET_ENCODING</pre> |
| <div class="block">Specifies the character type encoding for the SOAP Message. Valid values |
| include "utf-8" and "utf-16". See vendor documentation for additional |
| supported values. The default is "utf-8".</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/xml/soap/SOAPMessage.html#setProperty-java.lang.String-java.lang.Object-"><code>SOAPMessage.setProperty</code></a>, |
| <a href="../../../constant-values.html#javax.xml.soap.SOAPMessage.CHARACTER_SET_ENCODING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="WRITE_XML_DECLARATION"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WRITE_XML_DECLARATION</h4> |
| <pre>public static final java.lang.String WRITE_XML_DECLARATION</pre> |
| <div class="block">Specifies whether the SOAP Message will contain an XML declaration when |
| it is sent. The only valid values are "true" and "false". The default is |
| "false".</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/xml/soap/SOAPMessage.html#setProperty-java.lang.String-java.lang.Object-"><code>SOAPMessage.setProperty</code></a>, |
| <a href="../../../constant-values.html#javax.xml.soap.SOAPMessage.WRITE_XML_DECLARATION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SOAPMessage--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SOAPMessage</h4> |
| <pre>public SOAPMessage()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setContentDescription-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentDescription</h4> |
| <pre>public abstract void setContentDescription(java.lang.String description)</pre> |
| <div class="block">Sets the description of this <code>SOAPMessage</code> object's |
| content with the given description.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - a <code>String</code> describing the content of this |
| message</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/xml/soap/SOAPMessage.html#getContentDescription--"><code>getContentDescription()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentDescription--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentDescription</h4> |
| <pre>public abstract java.lang.String getContentDescription()</pre> |
| <div class="block">Retrieves a description of this <code>SOAPMessage</code> object's |
| content.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> describing the content of this |
| message or <code>null</code> if no description has been set</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/xml/soap/SOAPMessage.html#setContentDescription-java.lang.String-"><code>setContentDescription(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSOAPPart--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSOAPPart</h4> |
| <pre>public abstract <a href="../../../javax/xml/soap/SOAPPart.html" title="class in javax.xml.soap">SOAPPart</a> getSOAPPart()</pre> |
| <div class="block">Gets the SOAP part of this <code>SOAPMessage</code> object. |
| <p> |
| <code>SOAPMessage</code> object contains one or more attachments, the |
| SOAP Part must be the first MIME body part in the message.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>SOAPPart</code> object for this <code>SOAPMessage</code> |
| object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSOAPBody--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSOAPBody</h4> |
| <pre>public <a href="../../../javax/xml/soap/SOAPBody.html" title="interface in javax.xml.soap">SOAPBody</a> getSOAPBody() |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Gets the SOAP Body contained in this <code>SOAPMessage</code> object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>SOAPBody</code> object contained by this <code>SOAPMessage</code> |
| object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if the SOAP Body does not exist or cannot be retrieved</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSOAPHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSOAPHeader</h4> |
| <pre>public <a href="../../../javax/xml/soap/SOAPHeader.html" title="interface in javax.xml.soap">SOAPHeader</a> getSOAPHeader() |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Gets the SOAP Header contained in this <code>SOAPMessage</code> object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>SOAPHeader</code> object contained |
| by this <code>SOAPMessage</code> object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if the SOAP Header does not exist or cannot be retrieved</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAllAttachments--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAllAttachments</h4> |
| <pre>public abstract void removeAllAttachments()</pre> |
| <div class="block">Removes all <code>AttachmentPart</code> objects that have been added |
| to this <code>SOAPMessage</code> object. |
| <p> |
| This method does not touch the SOAP part.</div> |
| </li> |
| </ul> |
| <a name="countAttachments--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>countAttachments</h4> |
| <pre>public abstract int countAttachments()</pre> |
| <div class="block">Gets a count of the number of attachments in this message. This count |
| does not include the SOAP part.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of <code>AttachmentPart</code> objects that are |
| part of this <code>SOAPMessage</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttachments--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachments</h4> |
| <pre>public abstract java.util.Iterator<<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a>> getAttachments()</pre> |
| <div class="block">Retrieves all the <code>AttachmentPart</code> objects that are part of |
| this <code>SOAPMessage</code> object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over all the attachments in this message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttachments-javax.xml.soap.MimeHeaders-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachments</h4> |
| <pre>public abstract java.util.Iterator<<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a>> getAttachments(<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> headers)</pre> |
| <div class="block">Retrieves all the <code>AttachmentPart</code> objects that have header |
| entries that match the specified headers. Note that a returned |
| attachment could have headers in addition to those specified.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headers</code> - a <code>MimeHeaders</code> object containing the MIME |
| headers for which to search</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over all attachments that have a header that matches |
| one of the given headers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAttachments-javax.xml.soap.MimeHeaders-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAttachments</h4> |
| <pre>public abstract void removeAttachments(<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> headers)</pre> |
| <div class="block">Removes all the <code>AttachmentPart</code> objects that have header |
| entries that match the specified headers. Note that the removed |
| attachment could have headers in addition to those specified.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headers</code> - a <code>MimeHeaders</code> object containing the MIME |
| headers for which to search</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttachment-javax.xml.soap.SOAPElement-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachment</h4> |
| <pre>public abstract <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a> getAttachment(<a href="../../../javax/xml/soap/SOAPElement.html" title="interface in javax.xml.soap">SOAPElement</a> element) |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Returns an <code>AttachmentPart</code> object that is associated with an |
| attachment that is referenced by this <code>SOAPElement</code> or |
| <code>null</code> if no such attachment exists. References can be made |
| via an <code>href</code> attribute as described in |
| <a href="http://www.w3.org/TR/SOAP-attachments#SOAPReferenceToAttachements">SOAP Messages with Attachments</a>, |
| or via a single <code>Text</code> child node containing a URI as |
| described in the WS-I Attachments Profile 1.0 for elements of schema |
| type <a href="http://www.ws-i.org/Profiles/AttachmentsProfile-1.0-2004-08-24.html">ref:swaRef</a>. |
| These two mechanisms must be supported. |
| The support for references via <code>href</code> attribute also implies that |
| this method should also be supported on an element that is an |
| <i>xop:Include</i> element ( |
| <a href="http://www.w3.org/2000/xp/Group/3/06/Attachments/XOP.html">XOP</a>). |
| other reference mechanisms may be supported by individual |
| implementations of this standard. Contact your vendor for details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>element</code> - The <code>SOAPElement</code> containing the reference to an Attachment</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the referenced <code>AttachmentPart</code> or null if no such |
| <code>AttachmentPart</code> exists or no reference can be |
| found in this <code>SOAPElement</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if there is an error in the attempt to access the |
| attachment</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAttachmentPart-javax.xml.soap.AttachmentPart-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttachmentPart</h4> |
| <pre>public abstract void addAttachmentPart(<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a> attachmentPart)</pre> |
| <div class="block">Adds the given <code>AttachmentPart</code> object to this <code>SOAPMessage</code> |
| object. An <code>AttachmentPart</code> object must be created before |
| it can be added to a message.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>attachmentPart</code> - an <code>attachmentPart</code> object that is to become part |
| of this <code>SOAPMessage</code> object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there was a problem with the specified <code>attachmentPart</code> |
| object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createAttachmentPart--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAttachmentPart</h4> |
| <pre>public abstract <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a> createAttachmentPart()</pre> |
| <div class="block">Creates a new empty <code>AttachmentPart</code> object. Note that the |
| method <code>addAttachmentPart</code> must be called with this new |
| <code>AttachmentPart</code> object as the parameter in order for it to |
| become an attachment to this <code>SOAPMessage</code> object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <code>AttachmentPart</code> object that can be populated |
| and added to this <code>SOAPMessage</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createAttachmentPart-javax.activation.DataHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAttachmentPart</h4> |
| <pre>public <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a> createAttachmentPart(javax.activation.DataHandler dataHandler)</pre> |
| <div class="block">Creates an <code>AttachmentPart</code> object and populates it using |
| the given <code>DataHandler</code> object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataHandler</code> - the <code>javax.activation.DataHandler</code> object that |
| will generate the content for this <code>SOAPMessage</code> |
| object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <code>AttachmentPart</code> object that contains data |
| generated by the given <code>DataHandler</code> object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there was a problem with the specified <code>DataHandler</code> |
| object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>DataHandler</code>, |
| <code>DataContentHandler</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMimeHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMimeHeaders</h4> |
| <pre>public abstract <a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> getMimeHeaders()</pre> |
| <div class="block">Returns all the transport-specific MIME headers for this <code>SOAPMessage</code> |
| object in a transport-independent fashion.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>MimeHeaders</code> object containing the <code>MimeHeader</code> |
| objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createAttachmentPart-java.lang.Object-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAttachmentPart</h4> |
| <pre>public <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a> createAttachmentPart(java.lang.Object content, |
| java.lang.String contentType)</pre> |
| <div class="block">Creates an <code>AttachmentPart</code> object and populates it with |
| the specified data of the specified content type. The type of the |
| <code>Object</code> should correspond to the value given for the |
| <code>Content-Type</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>content</code> - an <code>Object</code> containing the content for the |
| <code>AttachmentPart</code> object to be created</dd> |
| <dd><code>contentType</code> - a <code>String</code> object giving the type of content; |
| examples are "text/xml", "text/plain", and "image/jpeg"</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <code>AttachmentPart</code> object that contains the |
| given data</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - may be thrown if the contentType does not match the type |
| of the content object, or if there was no |
| <code>DataContentHandler</code> object for the given |
| content object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>DataHandler</code>, |
| <code>DataContentHandler</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="saveChanges--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>saveChanges</h4> |
| <pre>public abstract void saveChanges() |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Updates this <code>SOAPMessage</code> object with all the changes that |
| have been made to it. This method is called automatically when |
| <a href="../../../javax/xml/soap/SOAPMessage.html#writeTo-java.io.OutputStream-"><code>writeTo(OutputStream)</code></a> is called. However, if |
| changes are made to a message that was received or to one that has |
| already been sent, the method <code>saveChanges</code> needs to be |
| called explicitly in order to save the changes. The method <code>saveChanges</code> |
| also generates any changes that can be read back (for example, a |
| MessageId in profiles that support a message id). All MIME headers in a |
| message that is created for sending purposes are guaranteed to have |
| valid values only after <code>saveChanges</code> has been called. |
| <P> |
| In addition, this method marks the point at which the data from all |
| constituent <code>AttachmentPart</code> objects are pulled into the |
| message.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if there was a problem saving |
| changes to this message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="saveRequired--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>saveRequired</h4> |
| <pre>public abstract boolean saveRequired()</pre> |
| <div class="block">Indicates whether this <code>SOAPMessage</code> object needs to have |
| the method <code>saveChanges</code> called on it.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if <code>saveChanges</code> needs to be |
| called; <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeTo-java.io.OutputStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeTo</h4> |
| <pre>public abstract void writeTo(java.io.OutputStream out) |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a>, |
| java.io.IOException</pre> |
| <div class="block">Writes this <code>SOAPMessage</code> object to the given output |
| stream. The externalization format is as defined by the SOAP 1.1 with |
| Attachments specification. |
| <P> |
| If there are no attachments, just an XML stream is written out. For |
| those messages that have attachments, <code>writeTo</code> writes a |
| MIME-encoded byte stream. |
| <P> |
| Note that this method does not write the transport-specific MIME Headers |
| of the Message</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>out</code> - the <code>OutputStream</code> object to which this <code>SOAPMessage</code> |
| object will be written</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if an I/O error occurs</dd> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if there was a problem in externalizing this SOAP message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setProperty-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperty</h4> |
| <pre>public void setProperty(java.lang.String property, |
| java.lang.Object value) |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Associates the specified value with the specified property. If there was |
| already a value associated with this property, the old value is |
| replaced. |
| <p> |
| The valid property names include |
| <a href="../../../javax/xml/soap/SOAPMessage.html#WRITE_XML_DECLARATION"><code>WRITE_XML_DECLARATION</code></a> and |
| <a href="../../../javax/xml/soap/SOAPMessage.html#CHARACTER_SET_ENCODING"><code>CHARACTER_SET_ENCODING</code></a>. All of these standard SAAJ |
| properties are prefixed by "javax.xml.soap". Vendors may also add |
| implementation specific properties. These properties must be prefixed |
| with package names that are unique to the vendor. |
| <p> |
| Setting the property <code>WRITE_XML_DECLARATION</code> to <code>"true"</code> |
| will cause an XML Declaration to be written out at the start of the SOAP |
| message. The default value of "false" suppresses this declaration. |
| <p> |
| The property <code>CHARACTER_SET_ENCODING</code> defaults to the value |
| <code>"utf-8"</code> which causes the SOAP message to be encoded using |
| UTF-8. Setting <code>CHARACTER_SET_ENCODING</code> to <code>"utf-16"</code> |
| causes the SOAP message to be encoded using UTF-16. |
| <p> |
| Some implementations may allow encodings in addition to UTF-8 and |
| UTF-16. Refer to your vendor's documentation for details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>property</code> - the property with which the specified value is to be |
| associated.</dd> |
| <dd><code>value</code> - the value to be associated with the specified property</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if the property name is not recognized.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProperty-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre>public java.lang.Object getProperty(java.lang.String property) |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Retrieves value of the specified property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>property</code> - the name of the property to retrieve</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value associated with the named property or <code>null</code> |
| if no such property exists.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if the property name is not recognized.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.2</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="../../../javax/xml/soap/SOAPHeaderElement.html" title="interface in javax.xml.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/xml/soap/SOAPPart.html" title="class in javax.xml.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/xml/soap/SOAPMessage.html" target="_top">Frames</a></li> |
| <li><a href="SOAPMessage.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> |
