blob: b337ec68f4b7834298eabfd7032c56eece3e8678 [file] [log] [blame]
<!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 Axis2)</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 Axis2)";
}
//-->
</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/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/axis2/jaxws/message/OccurrenceArray.html" title="class in org.apache.axis2.jaxws.message"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis2/jaxws/message/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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.axis2.jaxws.message</div>
<h2 title="Interface Message" class="title">Interface Message</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html" title="interface in org.apache.axis2.jaxws.message">XMLPart</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/axis2/jaxws/message/impl/MessageImpl.html" title="class in org.apache.axis2.jaxws.message.impl">MessageImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Message</span>
extends <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html" title="interface in org.apache.axis2.jaxws.message">XMLPart</a></pre>
<div class="block">Message
<p/>
A Message represents the XML + Attachments
<p/>
Most of the methods available on a message are only applicable to the XML part of the Message.
See the XMLPart interface for an explantation of these methods.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html" title="interface in org.apache.axis2.jaxws.message"><code>XMLPart</code></a>,
<code>Attachment</code></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</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/axis2/jaxws/message/Message.html#addDataHandler(javax.activation.DataHandler, java.lang.String)">addDataHandler</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation">DataHandler</a>&nbsp;dh,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</code>
<div class="block">Add Attachment</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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">SOAPMessage</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#getAsSOAPMessage()">getAsSOAPMessage</a></strong>()</code>
<div class="block">getAsSOAPMessage Get the xml part as a read/write SOAPEnvelope</div>
</td>
</tr>
<tr 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">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#getAttachmentID(int)">getAttachmentID</a></strong>(int&nbsp;index)</code>
<div class="block">Get the indicated (non-soap part) attachment id</div>
</td>
</tr>
<tr class="rowColor">
<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">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#getAttachmentID(java.lang.String)">getAttachmentID</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;partName)</code>
<div class="block">Get the indicated (non-soap part) attachment id</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#getAttachmentIDs()">getAttachmentIDs</a></strong>()</code>
<div class="block">Get the list of attachment content ids for the message</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation">DataHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#getDataHandler(java.lang.String)">getDataHandler</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cid)</code>
<div class="block">Get the attachment identified by the contentID</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/axis2/jaxws/core/MessageContext.html" title="class in org.apache.axis2.jaxws.core">MessageContext</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#getMessageContext()">getMessageContext</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#getMimeHeaders()">getMimeHeaders</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/axis2/jaxws/message/Protocol.html" title="enum in org.apache.axis2.jaxws.message">Protocol</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#getProtocol()">getProtocol</a></strong>()</code>
<div class="block">Get the protocol for this Message (soap11, soap12, etc.)</div>
</td>
</tr>
<tr class="rowColor">
<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">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#getValue(java.lang.Object, org.apache.axis2.jaxws.message.factory.BlockFactory)">getValue</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;context,
<a href="../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a>&nbsp;blockFactory)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#isDoingSWA()">isDoingSWA</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#isMTOMEnabled()">isMTOMEnabled</a></strong>()</code>
<div class="block">A message is MTOM enabled if the
associated dispatch/client/impl/provider has a binding type
that enables MTOM.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#isPostPivot()">isPostPivot</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation">DataHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#removeDataHandler(java.lang.String)">removeDataHandler</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cid)</code>
<div class="block">Get the attachment and remove it from the Message</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#setDoingSWA(boolean)">setDoingSWA</a></strong>(boolean&nbsp;value)</code>
<div class="block">Indicate that an SWA DataHandler was added to the message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#setMessageContext(org.apache.axis2.jaxws.core.MessageContext)">setMessageContext</a></strong>(<a href="../../../../../org/apache/axis2/jaxws/core/MessageContext.html" title="class in org.apache.axis2.jaxws.core">MessageContext</a>&nbsp;messageContext)</code>
<div class="block">JAX-WS Message Context that owns the Message</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#setMimeHeaders(java.util.Map)">setMimeHeaders</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;map)</code>
<div class="block">Set the transport headers</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#setMTOMEnabled(boolean)">setMTOMEnabled</a></strong>(boolean&nbsp;b)</code>
<div class="block">A message is MTOM enabled if the
associated dispatch/client/impl/provider has a binding type
that enables MTOM.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/jaxws/message/Message.html#setPostPivot()">setPostPivot</a></strong>()</code>
<div class="block">Indicate that this message is passed the pivot point.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.axis2.jaxws.message.XMLPart">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.axis2.jaxws.message.<a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html" title="interface in org.apache.axis2.jaxws.message">XMLPart</a></h3>
<code><a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#appendHeaderBlock(java.lang.String, java.lang.String, org.apache.axis2.jaxws.message.Block)">appendHeaderBlock</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#close()">close</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getAsOMElement()">getAsOMElement</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getAsSOAPEnvelope()">getAsSOAPEnvelope</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getBodyBlock(int, java.lang.Object, org.apache.axis2.jaxws.message.factory.BlockFactory)">getBodyBlock</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getBodyBlock(java.lang.Object, org.apache.axis2.jaxws.message.factory.BlockFactory)">getBodyBlock</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getBodyBlockQNames()">getBodyBlockQNames</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getHeaderBlock(java.lang.String, java.lang.String, java.lang.Object, org.apache.axis2.jaxws.message.factory.BlockFactory)">getHeaderBlock</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getHeaderBlocks(java.lang.String, java.lang.String, java.lang.Object, org.apache.axis2.jaxws.message.factory.BlockFactory, org.apache.axiom.soap.RolePlayer)">getHeaderBlocks</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getHeaderQNames()">getHeaderQNames</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getIndirection()">getIndirection</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getNumBodyBlocks()">getNumBodyBlocks</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getNumHeaderBlocks()">getNumHeaderBlocks</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getOperationElement()">getOperationElement</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getParent()">getParent</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getStyle()">getStyle</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getXMLFault()">getXMLFault</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getXMLPartContentType()">getXMLPartContentType</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getXMLStreamReader(boolean)">getXMLStreamReader</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#isConsumed()">isConsumed</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#isFault()">isFault</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#outputTo(javax.xml.stream.XMLStreamWriter, boolean)">outputTo</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#removeBodyBlock(int)">removeBodyBlock</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#removeHeaderBlock(java.lang.String, java.lang.String)">removeHeaderBlock</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#setBodyBlock(org.apache.axis2.jaxws.message.Block)">setBodyBlock</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#setBodyBlock(int, org.apache.axis2.jaxws.message.Block)">setBodyBlock</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#setHeaderBlock(java.lang.String, java.lang.String, org.apache.axis2.jaxws.message.Block)">setHeaderBlock</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#setIndirection(int)">setIndirection</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#setOperationElement(javax.xml.namespace.QName)">setOperationElement</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#setParent(org.apache.axis2.jaxws.message.Message)">setParent</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#setStyle(javax.jws.soap.SOAPBinding.Style)">setStyle</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#setXMLFault(org.apache.axis2.jaxws.message.XMLFault)">setXMLFault</a>, <a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#traceString(java.lang.String)">traceString</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getProtocol()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocol</h4>
<pre><a href="../../../../../org/apache/axis2/jaxws/message/Protocol.html" title="enum in org.apache.axis2.jaxws.message">Protocol</a>&nbsp;getProtocol()</pre>
<div class="block">Get the protocol for this Message (soap11, soap12, etc.)</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html#getProtocol()">getProtocol</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/axis2/jaxws/message/XMLPart.html" title="interface in org.apache.axis2.jaxws.message">XMLPart</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>Protocl</dd></dl>
</li>
</ul>
<a name="getAsSOAPMessage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAsSOAPMessage</h4>
<pre><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">SOAPMessage</a>&nbsp;getAsSOAPMessage()
throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</a></pre>
<div class="block">getAsSOAPMessage Get the xml part as a read/write SOAPEnvelope</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>SOAPEnvelope</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</a></code></dd></dl>
</li>
</ul>
<a name="addDataHandler(javax.activation.DataHandler, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addDataHandler</h4>
<pre>void&nbsp;addDataHandler(<a href="https://docs.oracle.com/javase/7/docs/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation">DataHandler</a>&nbsp;dh,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</pre>
<div class="block">Add Attachment</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dh</code> - DataHandler (type of Attachment is inferred from dh.getContentType)</dd><dd><code>id</code> - String which is the Attachment content id</dd><dt><span class="strong">See Also:</span></dt><dd><code>addAttachment(Attachment)</code></dd></dl>
</li>
</ul>
<a name="getAttachmentIDs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachmentIDs</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getAttachmentIDs()</pre>
<div class="block">Get the list of attachment content ids for the message</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>List<String></dd></dl>
</li>
</ul>
<a name="getAttachmentID(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachmentID</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getAttachmentID(int&nbsp;index)</pre>
<div class="block">Get the indicated (non-soap part) attachment id</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>CID or null if not present</dd></dl>
</li>
</ul>
<a name="getAttachmentID(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachmentID</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getAttachmentID(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;partName)</pre>
<div class="block">Get the indicated (non-soap part) attachment id</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>partName</code> - (WS-I indicates that SWA attachments have a partName prefix)</dd>
<dt><span class="strong">Returns:</span></dt><dd>CID or null if not present</dd></dl>
</li>
</ul>
<a name="getDataHandler(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataHandler</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation">DataHandler</a>&nbsp;getDataHandler(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cid)</pre>
<div class="block">Get the attachment identified by the contentID</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cid</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="setDoingSWA(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDoingSWA</h4>
<pre>void&nbsp;setDoingSWA(boolean&nbsp;value)</pre>
<div class="block">Indicate that an SWA DataHandler was added to the message.
This information will be used to trigger SWA serialization.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - </dd></dl>
</li>
</ul>
<a name="isDoingSWA()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDoingSWA</h4>
<pre>boolean&nbsp;isDoingSWA()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if SWA DataHandler is present</dd></dl>
</li>
</ul>
<a name="removeDataHandler(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeDataHandler</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation">DataHandler</a>&nbsp;removeDataHandler(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cid)</pre>
<div class="block">Get the attachment and remove it from the Message</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cid</code> - </dd></dl>
</li>
</ul>
<a name="isMTOMEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMTOMEnabled</h4>
<pre>boolean&nbsp;isMTOMEnabled()</pre>
<div class="block">A message is MTOM enabled if the
associated dispatch/client/impl/provider has a binding type
that enables MTOM.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>if this is an MTOM message</dd></dl>
</li>
</ul>
<a name="setMTOMEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMTOMEnabled</h4>
<pre>void&nbsp;setMTOMEnabled(boolean&nbsp;b)</pre>
<div class="block">A message is MTOM enabled if the
associated dispatch/client/impl/provider has a binding type
that enables MTOM.
Indicate whether this is an MTOM message</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - </dd></dl>
</li>
</ul>
<a name="getMimeHeaders()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMimeHeaders</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;getMimeHeaders()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>get the transport headers map.</dd></dl>
</li>
</ul>
<a name="setMimeHeaders(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMimeHeaders</h4>
<pre>void&nbsp;setMimeHeaders(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;map)</pre>
<div class="block">Set the transport headers</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - Map</dd></dl>
</li>
</ul>
<a name="setPostPivot()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPostPivot</h4>
<pre>void&nbsp;setPostPivot()</pre>
<div class="block">Indicate that this message is passed the pivot point. For example, this is set in the JAX-WS
Dispatcher to indicate</div>
</li>
</ul>
<a name="isPostPivot()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPostPivot</h4>
<pre>boolean&nbsp;isPostPivot()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if post pivot</dd></dl>
</li>
</ul>
<a name="setMessageContext(org.apache.axis2.jaxws.core.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessageContext</h4>
<pre>void&nbsp;setMessageContext(<a href="../../../../../org/apache/axis2/jaxws/core/MessageContext.html" title="class in org.apache.axis2.jaxws.core">MessageContext</a>&nbsp;messageContext)</pre>
<div class="block">JAX-WS Message Context that owns the Message</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>messageContext</code> - </dd></dl>
</li>
</ul>
<a name="getMessageContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageContext</h4>
<pre><a href="../../../../../org/apache/axis2/jaxws/core/MessageContext.html" title="class in org.apache.axis2.jaxws.core">MessageContext</a>&nbsp;getMessageContext()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>JAX-WS MessageContext</dd></dl>
</li>
</ul>
<a name="getValue(java.lang.Object, org.apache.axis2.jaxws.message.factory.BlockFactory)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getValue</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getValue(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;context,
<a href="../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a>&nbsp;blockFactory)
throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><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/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/axis2/jaxws/message/OccurrenceArray.html" title="class in org.apache.axis2.jaxws.message"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis2/jaxws/message/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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>