| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Message (Apache Axis)</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Message (Apache Axis)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/Message.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"> |
| <li><a href="../../../org/apache/axis/InternalException.html" title="class in org.apache.axis"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/axis/Message.html" target="_top">Frames</a></li> |
| <li><a href="Message.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">org.apache.axis</div> |
| <h2 title="Class Message" class="title">Class Message</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">javax.xml.soap.SOAPMessage</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.axis.Message</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">Message</span> |
| extends <a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a> |
| implements <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block">A complete SOAP (and/or XML-RPC, eventually) message. |
| Includes both the root part (as a SOAPPart), and zero or |
| more MIME attachments (as AttachmentParts). |
| <p> |
| Eventually should be refactored to generalize SOAPPart |
| for multiple protocols (XML-RPC?).</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Rob Jellinghaus (robj@unrealities.com), Doug Davis (dug@us.ibm.com), Glen Daniels (gdaniels@allaire.com), Rick Rineholt, Heejune Ahn (cityboy@tmax.co.kr)</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#org.apache.axis.Message">Serialized Form</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="overviewSummary" 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 <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#CONTENT_TYPE_MTOM">CONTENT_TYPE_MTOM</a></strong></code> |
| <div class="block">Content Type for MTOM/XOP</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#DEFAULT_ATTACHMNET_IMPL">DEFAULT_ATTACHMNET_IMPL</a></strong></code> |
| <div class="block">Default Attachments Implementation class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static org.apache.commons.logging.Log</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#log">log</a></strong></code> |
| <div class="block">The <code>Log</code> that this class uses for logging all messages.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#MIME_APPLICATION_DIME">MIME_APPLICATION_DIME</a></strong></code> |
| <div class="block">DIME parts defined for messages.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#MIME_MULTIPART_RELATED">MIME_MULTIPART_RELATED</a></strong></code> |
| <div class="block">MIME parts defined for messages.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#MIME_UNKNOWN">MIME_UNKNOWN</a></strong></code> |
| <div class="block">Look at the input stream to find the headers to decide the mime type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#REQUEST">REQUEST</a></strong></code> |
| <div class="block">Message is a request.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#RESPONSE">RESPONSE</a></strong></code> |
| <div class="block">Message is a a response.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_javax.xml.soap.SOAPMessage"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class javax.xml.soap.<a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></h3> |
| <code><a href="../../../javax/xml/soap/SOAPMessage.html#CHARACTER_SET_ENCODING">CHARACTER_SET_ENCODING</a>, <a href="../../../javax/xml/soap/SOAPMessage.html#WRITE_XML_DECLARATION">WRITE_XML_DECLARATION</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" 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><strong><a href="../../../org/apache/axis/Message.html#Message(java.lang.Object)">Message</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> initialContents)</code> |
| <div class="block">Construct a Message.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../org/apache/axis/Message.html#Message(java.lang.Object,%20boolean)">Message</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> initialContents, |
| boolean bodyInStream)</code> |
| <div class="block">Construct a Message, using the provided initialContents as the |
| contents of the Message's SOAPPart.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../org/apache/axis/Message.html#Message(java.lang.Object,%20boolean,%20javax.xml.soap.MimeHeaders)">Message</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> initialContents, |
| boolean bodyInStream, |
| <a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> headers)</code> |
| <div class="block">Construct a Message, using the provided initialContents as the |
| contents of the Message's SOAPPart.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../org/apache/axis/Message.html#Message(java.lang.Object,%20boolean,%20java.lang.String,%20java.lang.String)">Message</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> initialContents, |
| boolean bodyInStream, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contentType, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contentLocation)</code> |
| <div class="block">Construct a Message, using the provided initialContents as the |
| contents of the Message's SOAPPart.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../org/apache/axis/Message.html#Message(java.lang.Object,%20org.apache.axis.message.MimeHeaders)">Message</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> initialContents, |
| <a href="../../../org/apache/axis/message/MimeHeaders.html" title="class in org.apache.axis.message">MimeHeaders</a> headers)</code> |
| <div class="block">Construct a Message, using the provided initialContents as the |
| contents of the Message's SOAPPart.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#addAttachmentPart(javax.xml.soap.AttachmentPart)">addAttachmentPart</a></strong>(<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 class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#countAttachments()">countAttachments</a></strong>()</code> |
| <div class="block">Gets a count of the number of attachments in this |
| message.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../org/apache/axis/Message.html#createAttachmentPart()">createAttachmentPart</a></strong>()</code> |
| <div class="block">Creates a new empty <CODE>AttachmentPart</CODE> object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#dispose()">dispose</a></strong>()</code> |
| <div class="block">Dispose of attachments.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getAttachmentImplClassName()">getAttachmentImplClassName</a></strong>()</code> |
| <div class="block">Returns the name of the class prividing Attachment Implementation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getAttachments()">getAttachments</a></strong>()</code> |
| <div class="block">Retrieves all the <CODE>AttachmentPart</CODE> objects |
| that are part of this <CODE>SOAPMessage</CODE> object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getAttachments(javax.xml.soap.MimeHeaders)">getAttachments</a></strong>(<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 class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/axis/attachments/Attachments.html" title="interface in org.apache.axis.attachments">Attachments</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getAttachmentsImpl()">getAttachmentsImpl</a></strong>()</code> |
| <div class="block">Get the Attachments of this Message.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getContentDescription()">getContentDescription</a></strong>()</code> |
| <div class="block">Retrieves a description of this <CODE>SOAPMessage</CODE> |
| object's content.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getContentLength()">getContentLength</a></strong>()</code> |
| <div class="block">Get the content length, including both soap and any attachments.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getContentType(org.apache.axis.soap.SOAPConstants)">getContentType</a></strong>(<a href="../../../org/apache/axis/soap/SOAPConstants.html" title="interface in org.apache.axis.soap">SOAPConstants</a> sc)</code> |
| <div class="block">Get the content type of the attachments.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getMessageContext()">getMessageContext</a></strong>()</code> |
| <div class="block">Get the context associated with this message.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getMessageType()">getMessageType</a></strong>()</code> |
| <div class="block">Get the message type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getMimeHeaders()">getMimeHeaders</a></strong>()</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 class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getProperty(java.lang.String)">getProperty</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> property)</code> |
| <div class="block">Retrieves value of the specified property.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../org/apache/axis/Message.html#getSOAPBody()">getSOAPBody</a></strong>()</code> |
| <div class="block">Gets the SOAP Body contained in this <code>SOAPMessage</code> object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/axis/message/SOAPEnvelope.html" title="class in org.apache.axis.message">SOAPEnvelope</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getSOAPEnvelope()">getSOAPEnvelope</a></strong>()</code> |
| <div class="block">Get this message's SOAPPart as a SOAPEnvelope.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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><strong><a href="../../../org/apache/axis/Message.html#getSOAPHeader()">getSOAPHeader</a></strong>()</code> |
| <div class="block">Gets the SOAP Header contained in this <code>SOAPMessage</code> object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/xml/soap/SOAPPart.html" title="class in javax.xml.soap">SOAPPart</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getSOAPPart()">getSOAPPart</a></strong>()</code> |
| <div class="block">Get this message's SOAPPart.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getSOAPPartAsBytes()">getSOAPPartAsBytes</a></strong>()</code> |
| <div class="block">Get a byte array representation of this message's SOAPPart.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#getSOAPPartAsString()">getSOAPPartAsString</a></strong>()</code> |
| <div class="block">Get a string representation of this message's SOAPPart.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#removeAllAttachments()">removeAllAttachments</a></strong>()</code> |
| <div class="block">Removes all <CODE>AttachmentPart</CODE> objects that have |
| been added to this <CODE>SOAPMessage</CODE> object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#saveChanges()">saveChanges</a></strong>()</code> |
| <div class="block">Updates this <CODE>SOAPMessage</CODE> object with all the |
| changes that have been made to it.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#saveRequired()">saveRequired</a></strong>()</code> |
| <div class="block">Indicates whether this <CODE>SOAPMessage</CODE> object |
| has had the method <CODE>saveChanges</CODE> called on |
| it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#setContentDescription(java.lang.String)">setContentDescription</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code> |
| <div class="block">Sets the description of this <CODE>SOAPMessage</CODE> |
| object's content with the given description.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#setMessageContext(org.apache.axis.MessageContext)">setMessageContext</a></strong>(<a href="../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a> msgContext)</code> |
| <div class="block">Set the context associated with this message.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#setMessageType(java.lang.String)">setMessageType</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> messageType)</code> |
| <div class="block">Set the message type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#setProperty(java.lang.String,%20java.lang.Object)">setProperty</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> property, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Associates the specified value with the specified property.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/axis/Message.html#writeTo(java.io.OutputStream)">writeTo</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os)</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_javax.xml.soap.SOAPMessage"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class javax.xml.soap.<a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></h3> |
| <code><a href="../../../javax/xml/soap/SOAPMessage.html#createAttachmentPart(javax.activation.DataHandler)">createAttachmentPart</a>, <a href="../../../javax/xml/soap/SOAPMessage.html#createAttachmentPart(java.lang.Object,%20java.lang.String)">createAttachmentPart</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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="log"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>log</h4> |
| <pre>protected static org.apache.commons.logging.Log log</pre> |
| <div class="block">The <code>Log</code> that this class uses for logging all messages.</div> |
| </li> |
| </ul> |
| <a name="REQUEST"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REQUEST</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> REQUEST</pre> |
| <div class="block">Message is a request.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.apache.axis.Message.REQUEST">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="RESPONSE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RESPONSE</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> RESPONSE</pre> |
| <div class="block">Message is a a response.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.apache.axis.Message.RESPONSE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="MIME_MULTIPART_RELATED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MIME_MULTIPART_RELATED</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MIME_MULTIPART_RELATED</pre> |
| <div class="block">MIME parts defined for messages.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.apache.axis.Message.MIME_MULTIPART_RELATED">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="MIME_APPLICATION_DIME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MIME_APPLICATION_DIME</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MIME_APPLICATION_DIME</pre> |
| <div class="block">DIME parts defined for messages.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.apache.axis.Message.MIME_APPLICATION_DIME">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="CONTENT_TYPE_MTOM"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONTENT_TYPE_MTOM</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CONTENT_TYPE_MTOM</pre> |
| <div class="block">Content Type for MTOM/XOP</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.apache.axis.Message.CONTENT_TYPE_MTOM">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_ATTACHMNET_IMPL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_ATTACHMNET_IMPL</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_ATTACHMNET_IMPL</pre> |
| <div class="block">Default Attachments Implementation class.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.apache.axis.Message.DEFAULT_ATTACHMNET_IMPL">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="MIME_UNKNOWN"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MIME_UNKNOWN</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MIME_UNKNOWN</pre> |
| <div class="block">Look at the input stream to find the headers to decide the mime type.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.apache.axis.Message.MIME_UNKNOWN">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="Message(java.lang.Object, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Message</h4> |
| <pre>public Message(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> initialContents, |
| boolean bodyInStream)</pre> |
| <div class="block">Construct a Message, using the provided initialContents as the |
| contents of the Message's SOAPPart. |
| <p> |
| Eventually, genericize this to |
| return the RootPart instead, which will have some kind of |
| EnvelopeFactory to enable support for things other than SOAP. |
| But that all will come later, with lots of additional refactoring.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialContents</code> - may be String, byte[], InputStream, SOAPEnvelope, |
| or AxisFault.</dd><dd><code>bodyInStream</code> - is true if initialContents is an InputStream |
| containing just the SOAP body (no SOAP-ENV).</dd></dl> |
| </li> |
| </ul> |
| <a name="Message(java.lang.Object, boolean, javax.xml.soap.MimeHeaders)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Message</h4> |
| <pre>public Message(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> initialContents, |
| boolean bodyInStream, |
| <a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> headers)</pre> |
| <div class="block">Construct a Message, using the provided initialContents as the |
| contents of the Message's SOAPPart. |
| <p> |
| Eventually, genericize this to |
| return the RootPart instead, which will have some kind of |
| EnvelopeFactory to enable support for things other than SOAP. |
| But that all will come later, with lots of additional refactoring.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialContents</code> - may be String, byte[], InputStream, SOAPEnvelope, |
| or AxisFault.</dd><dd><code>bodyInStream</code> - is true if initialContents is an InputStream |
| containing just the SOAP body (no SOAP-ENV).</dd><dd><code>headers</code> - Mime Headers.</dd></dl> |
| </li> |
| </ul> |
| <a name="Message(java.lang.Object, org.apache.axis.message.MimeHeaders)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Message</h4> |
| <pre>public Message(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> initialContents, |
| <a href="../../../org/apache/axis/message/MimeHeaders.html" title="class in org.apache.axis.message">MimeHeaders</a> headers)</pre> |
| <div class="block">Construct a Message, using the provided initialContents as the |
| contents of the Message's SOAPPart. |
| <p> |
| Eventually, genericize this to |
| return the RootPart instead, which will have some kind of |
| EnvelopeFactory to enable support for things other than SOAP. |
| But that all will come later, with lots of additional refactoring.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialContents</code> - may be String, byte[], InputStream, SOAPEnvelope, |
| or AxisFault.</dd><dd><code>headers</code> - Mime Headers.</dd></dl> |
| </li> |
| </ul> |
| <a name="Message(java.lang.Object, boolean, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Message</h4> |
| <pre>public Message(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> initialContents, |
| boolean bodyInStream, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contentType, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contentLocation)</pre> |
| <div class="block">Construct a Message, using the provided initialContents as the |
| contents of the Message's SOAPPart. |
| <p> |
| Eventually, genericize this to |
| return the RootPart instead, which will have some kind of |
| EnvelopeFactory to enable support for things other than SOAP. |
| But that all will come later, with lots of additional refactoring.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialContents</code> - may be String, byte[], InputStream, SOAPEnvelope, |
| or AxisFault</dd><dd><code>bodyInStream</code> - is true if initialContents is an InputStream |
| containing just the SOAP body (no SOAP-ENV)</dd><dd><code>contentType</code> - this if the contentType has been already determined |
| (as in the case of servlets)</dd><dd><code>contentLocation</code> - the location of the content</dd></dl> |
| </li> |
| </ul> |
| <a name="Message(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Message</h4> |
| <pre>public Message(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> initialContents)</pre> |
| <div class="block">Construct a Message. An overload of Message(Object, boolean), |
| defaulting bodyInStream to false.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialContents</code> - may be String, byte[], InputStream, SOAPEnvelope, |
| or AxisFault</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getAttachmentImplClassName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachmentImplClassName</h4> |
| <pre>public static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAttachmentImplClassName()</pre> |
| <div class="block">Returns the name of the class prividing Attachment Implementation.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>class name</dd></dl> |
| </li> |
| </ul> |
| <a name="getMessageType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageType</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getMessageType()</pre> |
| <div class="block">Get the message type.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the message type <code>String</code></dd></dl> |
| </li> |
| </ul> |
| <a name="setMessageType(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMessageType</h4> |
| <pre>public void setMessageType(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> messageType)</pre> |
| <div class="block">Set the message type.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>messageType</code> - the message type <code>String</code></dd></dl> |
| </li> |
| </ul> |
| <a name="getMessageContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageContext</h4> |
| <pre>public <a href="../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a> getMessageContext()</pre> |
| <div class="block">Get the context associated with this message.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the message context for this message</dd></dl> |
| </li> |
| </ul> |
| <a name="setMessageContext(org.apache.axis.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMessageContext</h4> |
| <pre>public void setMessageContext(<a href="../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a> msgContext)</pre> |
| <div class="block">Set the context associated with this message.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>msgContext</code> - the message context for this message</dd></dl> |
| </li> |
| </ul> |
| <a name="getSOAPPart()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSOAPPart</h4> |
| <pre>public <a href="../../../javax/xml/soap/SOAPPart.html" title="class in javax.xml.soap">SOAPPart</a> getSOAPPart()</pre> |
| <div class="block">Get this message's SOAPPart. |
| <p> |
| Eventually, this should be generalized beyond just SOAP, |
| but it's hard to know how to do that without necessitating |
| a lot of casts in client code. Refactoring keeps getting |
| easier anyhow.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPPart()">getSOAPPart</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the soap part of this message</dd></dl> |
| </li> |
| </ul> |
| <a name="getSOAPPartAsString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSOAPPartAsString</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSOAPPartAsString() |
| throws <a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre> |
| <div class="block">Get a string representation of this message's SOAPPart.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the soap part of this message as a <code>String</code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></code> - if the stringification failed</dd></dl> |
| </li> |
| </ul> |
| <a name="getSOAPPartAsBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSOAPPartAsBytes</h4> |
| <pre>public byte[] getSOAPPartAsBytes() |
| throws <a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre> |
| <div class="block">Get a byte array representation of this message's SOAPPart.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the soap part of this message as a <code>byte[]</code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></code> - if creating the byte[] failed</dd></dl> |
| </li> |
| </ul> |
| <a name="getSOAPEnvelope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSOAPEnvelope</h4> |
| <pre>public <a href="../../../org/apache/axis/message/SOAPEnvelope.html" title="class in org.apache.axis.message">SOAPEnvelope</a> getSOAPEnvelope() |
| throws <a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre> |
| <div class="block">Get this message's SOAPPart as a SOAPEnvelope.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a SOAPEnvelope containing this message's SOAPPart</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></code> - if this failed</dd></dl> |
| </li> |
| </ul> |
| <a name="getAttachmentsImpl()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachmentsImpl</h4> |
| <pre>public <a href="../../../org/apache/axis/attachments/Attachments.html" title="interface in org.apache.axis.attachments">Attachments</a> getAttachmentsImpl()</pre> |
| <div class="block">Get the Attachments of this Message. |
| <p> |
| If this returns null, then NO ATTACHMENT SUPPORT EXISTS in this |
| configuration of Axis, and no attachment operations may be |
| performed.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the <code>Attachments</code> if attachments are supported, null |
| otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="getContentType(org.apache.axis.soap.SOAPConstants)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentType</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getContentType(<a href="../../../org/apache/axis/soap/SOAPConstants.html" title="interface in org.apache.axis.soap">SOAPConstants</a> sc) |
| throws <a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre> |
| <div class="block">Get the content type of the attachments.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sc</code> - provides the default content type</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> giving the content type of the |
| attachment</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></code> - if there was an error deducing the content type from |
| this message</dd></dl> |
| </li> |
| </ul> |
| <a name="getContentLength()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentLength</h4> |
| <pre>public long getContentLength() |
| throws <a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre> |
| <div class="block">Get the content length, including both soap and any attachments.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the total length of this message in bytes</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></code> - if there was a problem that prevented |
| the length being calculated</dd></dl> |
| </li> |
| </ul> |
| <a name="writeTo(java.io.OutputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeTo</h4> |
| <pre>public void writeTo(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os) |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a>, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">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>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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#writeTo(java.io.OutputStream)">writeTo</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>os</code> - the <CODE>OutputStream</CODE> |
| object to which this <CODE>SOAPMessage</CODE> object will |
| be written</dd> |
| <dt><span class="strong">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 in |
| externalizing this SOAP message</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error |
| occurs</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"><strong>Description copied from class: <code><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPBody()">SOAPMessage</a></code></strong></div> |
| <div class="block">Gets the SOAP Body contained in this <code>SOAPMessage</code> object.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPBody()">getSOAPBody</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the <code>SOAPBody</code> object contained by this |
| <code>SOAPMessage</code> object</dd> |
| <dt><span class="strong">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></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"><strong>Description copied from class: <code><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPHeader()">SOAPMessage</a></code></strong></div> |
| <div class="block">Gets the SOAP Header contained in this <code>SOAPMessage</code> object.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPHeader()">getSOAPHeader</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the <code>SOAPHeader</code> object contained by this |
| <code>SOAPMessage</code> object</dd> |
| <dt><span class="strong">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></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(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> property, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value) |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../javax/xml/soap/SOAPMessage.html#setProperty(java.lang.String,%20java.lang.Object)">SOAPMessage</a></code></strong></div> |
| <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><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#setProperty(java.lang.String,%20java.lang.Object)">setProperty</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">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="strong">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></dl> |
| </li> |
| </ul> |
| <a name="getProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getProperty(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> property) |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../javax/xml/soap/SOAPMessage.html#getProperty(java.lang.String)">SOAPMessage</a></code></strong></div> |
| <div class="block">Retrieves value of the specified property.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#getProperty(java.lang.String)">getProperty</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - the name of the property to retrieve</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the value of the property or <code>null</code> if no such |
| property exists</dd> |
| <dt><span class="strong">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></dl> |
| </li> |
| </ul> |
| <a name="getContentDescription()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentDescription</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getContentDescription()</pre> |
| <div class="block">Retrieves a description of this <CODE>SOAPMessage</CODE> |
| object's content.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#getContentDescription()">getContentDescription</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">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="strong">See Also:</span></dt><dd><a href="../../../org/apache/axis/Message.html#setContentDescription(java.lang.String)"><code>setContentDescription(java.lang.String)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setContentDescription(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentDescription</h4> |
| <pre>public void setContentDescription(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#setContentDescription(java.lang.String)">setContentDescription</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>description</code> - a <CODE>String</CODE> |
| describing the content of this message</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/apache/axis/Message.html#getContentDescription()"><code>getContentDescription()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="saveChanges()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>saveChanges</h4> |
| <pre>public 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 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>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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#saveChanges()">saveChanges</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">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 boolean saveRequired()</pre> |
| <div class="block">Indicates whether this <CODE>SOAPMessage</CODE> object |
| has had the method <CODE>saveChanges</CODE> called on |
| it.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#saveRequired()">saveRequired</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">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 name="getMimeHeaders()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMimeHeaders</h4> |
| <pre>public <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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#getMimeHeaders()">getMimeHeaders</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a <CODE>MimeHeaders</CODE> object containing the |
| <CODE>MimeHeader</CODE> objects</dd></dl> |
| </li> |
| </ul> |
| <a name="removeAllAttachments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAllAttachments</h4> |
| <pre>public 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.</P></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#removeAllAttachments()">removeAllAttachments</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="countAttachments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>countAttachments</h4> |
| <pre>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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#countAttachments()">countAttachments</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">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 <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#getAttachments()">getAttachments</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">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 <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#getAttachments(javax.xml.soap.MimeHeaders)">getAttachments</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>headers</code> - a <CODE>MimeHeaders</CODE> |
| object containing the MIME headers for which to |
| search</dd> |
| <dt><span class="strong">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="addAttachmentPart(javax.xml.soap.AttachmentPart)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttachmentPart</h4> |
| <pre>public 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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#addAttachmentPart(javax.xml.soap.AttachmentPart)">addAttachmentPart</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">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="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="createAttachmentPart()"> |
| <!-- --> |
| </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()</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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPMessage.html#createAttachmentPart()">createAttachmentPart</a></code> in class <code><a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></dd> |
| <dt><span class="strong">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="dispose()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>dispose</h4> |
| <pre>public void dispose()</pre> |
| <div class="block">Dispose of attachments.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/Message.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"> |
| <li><a href="../../../org/apache/axis/InternalException.html" title="class in org.apache.axis"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/axis/Message.html" target="_top">Frames</a></li> |
| <li><a href="Message.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 ======= --> |
| <p class="legalCopy"><small>Copyright © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |