| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SOAPMessageImpl (Apache Axis2)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SOAPMessageImpl (Apache Axis2)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SOAPMessageImpl.html">Use</a></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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.axis2.saaj</a></div> |
| <h2 title="Class SOAPMessageImpl" class="title">Class SOAPMessageImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">javax.xml.soap.SOAPMessage</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.axis2.saaj.SOAPMessageImpl</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">SOAPMessageImpl</span> |
| extends <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.javax.xml.soap.SOAPMessage"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class javax.xml.soap.<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#CHARACTER_SET_ENCODING" title="class or interface in javax.xml.soap" class="externalLink">CHARACTER_SET_ENCODING</a>, <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#WRITE_XML_DECLARATION" title="class or interface in javax.xml.soap" class="externalLink">WRITE_XML_DECLARATION</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.io.InputStream,javax.xml.soap.MimeHeaders,boolean)">SOAPMessageImpl</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> inputstream, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">MimeHeaders</a> mimeHeaders, |
| boolean processMTOM)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.axis2.saaj.SOAPEnvelopeImpl)">SOAPMessageImpl</a></span>​(<a href="SOAPEnvelopeImpl.html" title="class in org.apache.axis2.saaj">SOAPEnvelopeImpl</a> soapEnvelope)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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="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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addAttachmentPart(javax.xml.soap.AttachmentPart)">addAttachmentPart</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">AttachmentPart</a> attachmentPart)</code></th> |
| <td class="colLast"> |
| <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>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countAttachments()">countAttachments</a></span>()</code></th> |
| <td class="colLast"> |
| <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><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">AttachmentPart</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAttachmentPart()">createAttachmentPart</a></span>()</code></th> |
| <td class="colLast"> |
| <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="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">AttachmentPart</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttachment(javax.xml.soap.SOAPElement)">getAttachment</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPElement.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPElement</a> soapelement)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an AttachmentPart object that is associated with an attachment that is referenced by |
| this SOAPElement or null if no such attachment exists.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttachments()">getAttachments</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Retrieves all the <CODE>AttachmentPart</CODE> objects that are part of this |
| <CODE>SOAPMessage</CODE> object.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttachments(javax.xml.soap.MimeHeaders)">getAttachments</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">MimeHeaders</a> headers)</code></th> |
| <td class="colLast"> |
| <div class="block">Retrieves all the AttachmentPart objects that have header entries that match the specified |
| headers.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContentDescription()">getContentDescription</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Retrieves a description of this <CODE>SOAPMessage</CODE> object's content.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">MimeHeaders</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMimeHeaders()">getMimeHeaders</a></span>()</code></th> |
| <td class="colLast"> |
| <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="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperty(java.lang.String)">getProperty</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> property)</code></th> |
| <td class="colLast"> |
| <div class="block">Retrieves value of the specified property.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPBody.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPBody</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSOAPBody()">getSOAPBody</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the SOAP Body contained in this <code>SOAPMessage</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPHeader.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPHeader</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSOAPHeader()">getSOAPHeader</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the SOAP Header contained in this <code>SOAPMessage</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPPart.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPPart</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSOAPPart()">getSOAPPart</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the SOAP part of this <CODE>SOAPMessage</CODE> object.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAllAttachments()">removeAllAttachments</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Removes all <CODE>AttachmentPart</CODE> objects that have been added to this |
| <CODE>SOAPMessage</CODE> object.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAttachments(javax.xml.soap.MimeHeaders)">removeAttachments</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">MimeHeaders</a> headers)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes all the AttachmentPart objects that have header entries that match the specified |
| headers.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#saveChanges()">saveChanges</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Updates this <CODE>SOAPMessage</CODE> object with all the changes that have been made to it.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#saveRequired()">saveRequired</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Indicates whether this <CODE>SOAPMessage</CODE> object has had the method <a href="#saveChanges()"><code>saveChanges()</code></a> called on it.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setContentDescription(java.lang.String)">setContentDescription</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> description)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the description of this <CODE>SOAPMessage</CODE> object's content with the given |
| description.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProperty(java.lang.String,java.lang.Object)">setProperty</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> property, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Associates the specified value with the specified property.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSaveRequired()">setSaveRequired</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeTo(java.io.OutputStream)">writeTo</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a> out)</code></th> |
| <td class="colLast"> |
| <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 id="methods.inherited.from.class.javax.xml.soap.SOAPMessage"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class javax.xml.soap.<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#createAttachmentPart(java.lang.Object,java.lang.String)" title="class or interface in javax.xml.soap" class="externalLink">createAttachmentPart</a>, <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#createAttachmentPart(javax.activation.DataHandler)" title="class or interface in javax.xml.soap" class="externalLink">createAttachmentPart</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.axis2.saaj.SOAPEnvelopeImpl)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SOAPMessageImpl</h4> |
| <pre>public SOAPMessageImpl​(<a href="SOAPEnvelopeImpl.html" title="class in org.apache.axis2.saaj">SOAPEnvelopeImpl</a> soapEnvelope)</pre> |
| </li> |
| </ul> |
| <a id="<init>(java.io.InputStream,javax.xml.soap.MimeHeaders,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SOAPMessageImpl</h4> |
| <pre>public SOAPMessageImpl​(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> inputstream, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">MimeHeaders</a> mimeHeaders, |
| boolean processMTOM) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getContentDescription()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentDescription</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getContentDescription()</pre> |
| <div class="block">Retrieves a description of this <CODE>SOAPMessage</CODE> object's content.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getContentDescription()" title="class or interface in javax.xml.soap" class="externalLink">getContentDescription</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <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="#setContentDescription(java.lang.String)"><code>setContentDescription(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setContentDescription(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentDescription</h4> |
| <pre class="methodSignature">public void setContentDescription​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> 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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#setContentDescription(java.lang.String)" title="class or interface in javax.xml.soap" class="externalLink">setContentDescription</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <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="#getContentDescription()"><code>getContentDescription()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSOAPPart()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSOAPPart</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPPart.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPPart</a> getSOAPPart()</pre> |
| <div class="block">Gets the SOAP part of this <CODE>SOAPMessage</CODE> object. |
| <p/> |
| <p/> |
| <P>If a <CODE>SOAPMessage</CODE> object contains one or more attachments, the SOAP Part must |
| be the first MIME body part in the message.</P></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getSOAPPart()" title="class or interface in javax.xml.soap" class="externalLink">getSOAPPart</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <CODE>SOAPPart</CODE> object for this <CODE> SOAPMessage</CODE> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeAllAttachments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAllAttachments</h4> |
| <pre class="methodSignature">public void removeAllAttachments()</pre> |
| <div class="block">Removes all <CODE>AttachmentPart</CODE> objects that have been added to this |
| <CODE>SOAPMessage</CODE> object. |
| <p/> |
| <P>This method does not touch the SOAP part.</P></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#removeAllAttachments()" title="class or interface in javax.xml.soap" class="externalLink">removeAllAttachments</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="countAttachments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>countAttachments</h4> |
| <pre class="methodSignature">public 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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#countAttachments()" title="class or interface in javax.xml.soap" class="externalLink">countAttachments</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <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 id="getAttachments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachments</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getAttachments()" title="class or interface in javax.xml.soap" class="externalLink">getAttachments</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over all the attachments in this message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttachments(javax.xml.soap.MimeHeaders)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachments</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a> getAttachments​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">MimeHeaders</a> headers)</pre> |
| <div class="block">Retrieves all the AttachmentPart 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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getAttachments(javax.xml.soap.MimeHeaders)" title="class or interface in javax.xml.soap" class="externalLink">getAttachments</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headers</code> - a <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink"><code>MimeHeaders</code></a> object containing the MIME headers for |
| which to search</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over all attachments(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink"><code>AttachmentPart</code></a>) that have a |
| header that matches one of the given headers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addAttachmentPart(javax.xml.soap.AttachmentPart)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttachmentPart</h4> |
| <pre class="methodSignature">public void addAttachmentPart​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#addAttachmentPart(javax.xml.soap.AttachmentPart)" title="class or interface in javax.xml.soap" class="externalLink">addAttachmentPart</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <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><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createAttachmentPart()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAttachmentPart</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#createAttachmentPart()" title="class or interface in javax.xml.soap" class="externalLink">createAttachmentPart</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <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 id="getMimeHeaders()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMimeHeaders</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getMimeHeaders()" title="class or interface in javax.xml.soap" class="externalLink">getMimeHeaders</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <CODE>MimeHeaders</CODE> object containing the <CODE>MimeHeader</CODE> objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="saveChanges()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>saveChanges</h4> |
| <pre class="methodSignature">public void saveChanges() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">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 message is sent or written to by the methods |
| <CODE>ProviderConnection.send</CODE>, <CODE> SOAPConnection.call</CODE>, or <CODE> |
| SOAPMessage.writeTo</CODE>. 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/> |
| <P>In addition, this method marks the point at which the data from all constituent |
| <CODE>AttachmentPart</CODE> objects are pulled into the message.</P></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#saveChanges()" title="class or interface in javax.xml.soap" class="externalLink">saveChanges</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a></code> - if there was a problem saving changes to this message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSaveRequired()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSaveRequired</h4> |
| <pre class="methodSignature">public void setSaveRequired()</pre> |
| </li> |
| </ul> |
| <a id="saveRequired()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>saveRequired</h4> |
| <pre class="methodSignature">public boolean saveRequired()</pre> |
| <div class="block">Indicates whether this <CODE>SOAPMessage</CODE> object has had the method <a href="#saveChanges()"><code>saveChanges()</code></a> called on it.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#saveRequired()" title="class or interface in javax.xml.soap" class="externalLink">saveRequired</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><CODE>true</CODE> if <CODE>saveChanges</CODE> has been called on this message at |
| least once; <CODE> false</CODE> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="writeTo(java.io.OutputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeTo</h4> |
| <pre class="methodSignature">public void writeTo​(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a> out) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a>, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></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/> |
| <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></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#writeTo(java.io.OutputStream)" title="class or interface in javax.xml.soap" class="externalLink">writeTo</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <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><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a></code> - if there was a problem in externalizing this SOAP message</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - if an I/O error occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setProperty(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperty</h4> |
| <pre class="methodSignature">public void setProperty​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> property, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</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 <code>WRITE_XML_DECLARATION</code> and |
| <code>CHARACTER_SET_ENCODING</code>. 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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#setProperty(java.lang.String,java.lang.Object)" title="class or interface in javax.xml.soap" class="externalLink">setProperty</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getProperty​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> property) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a></pre> |
| <div class="block">Retrieves value of the specified property.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getProperty(java.lang.String)" title="class or interface in javax.xml.soap" class="externalLink">getProperty</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <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 of the property or <code>null</code> if no such property exists</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a></code> - if the property name is not recognized</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttachment(javax.xml.soap.SOAPElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachment</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">AttachmentPart</a> getAttachment​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPElement.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPElement</a> soapelement) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a></pre> |
| <div class="block">Returns an AttachmentPart object that is associated with an attachment that is referenced by |
| this SOAPElement or null if no such attachment exists. References can be made via an href |
| attribute as described in SOAP Messages with Attachments (http://www.w3.org/TR/SOAPattachments#SOAPReferenceToAttachements) |
| , or via a single Text child node containing a URI as described in the WS-I Attachments |
| Profile 1.0 for elements of schema type ref:swaRef(ref:swaRef (http://www.wsi.org/Profiles/AttachmentsProfile-1.0-2004-08-24.html") |
| ). These two mechanisms must be supported. The support for references via href attribute also |
| implies that this method should also be supported on an element that is an xop:Include |
| element (XOP (http://www.w3.org/2000/xp/Group/3/06/Attachments/XOP.html) ). other reference |
| mechanisms may be supported by individual implementations of this standard. Contact your |
| vendor for details.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getAttachment(javax.xml.soap.SOAPElement)" title="class or interface in javax.xml.soap" class="externalLink">getAttachment</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>element</code> - - The SOAPElement containing the reference to an Attachment</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the referenced AttachmentPart or null if no such AttachmentPart exists or no |
| reference can be found in this SOAPElement.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a></code> - - if there is an error in the attempt to access the attachment</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeAttachments(javax.xml.soap.MimeHeaders)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAttachments</h4> |
| <pre class="methodSignature">public void removeAttachments​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">MimeHeaders</a> headers)</pre> |
| <div class="block">Removes all the AttachmentPart 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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#removeAttachments(javax.xml.soap.MimeHeaders)" title="class or interface in javax.xml.soap" class="externalLink">removeAttachments</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headers</code> - - a MimeHeaders object containing the MIME headers for which to search</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>SAAJ 1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSOAPHeader()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSOAPHeader</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPHeader.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPHeader</a> getSOAPHeader() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a></pre> |
| <div class="block">Gets the SOAP Header contained in this <code>SOAPMessage</code> object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getSOAPHeader()" title="class or interface in javax.xml.soap" class="externalLink">getSOAPHeader</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <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="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a></code> - if the SOAP Header does not exist or cannot be |
| retrieved</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSOAPBody()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSOAPBody</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPBody.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPBody</a> getSOAPBody() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a></pre> |
| <div class="block">Gets the SOAP Body contained in this <code>SOAPMessage</code> object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getSOAPBody()" title="class or interface in javax.xml.soap" class="externalLink">getSOAPBody</a></code> in class <code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a></code></dd> |
| <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="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPException</a></code> - if the SOAP Body does not exist or cannot be retrieved</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SOAPMessageImpl.html">Use</a></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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
