blob: c9a9117b2f54a4c011125ccf0d37e3dab085c329 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Message (Apache Axis2)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Message (Apache Axis2)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.axis2.jaxws.message</a></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><code><a href="XMLPart.html" title="interface in org.apache.axis2.jaxws.message">XMLPart</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="impl/MessageImpl.html" title="class in org.apache.axis2.jaxws.message.impl">MessageImpl</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Message</span>
extends <a href="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="seeLabel">See Also:</span></dt>
<dd><a href="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 =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDataHandler(javax.activation.DataHandler,java.lang.String)">addDataHandler</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation" class="externalLink">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" class="externalLink">String</a>&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Add Attachment</div>
</td>
</tr>
<tr id="i1" 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" class="externalLink">SOAPMessage</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAsSOAPMessage()">getAsSOAPMessage</a></span>()</code></th>
<td class="colLast">
<div class="block">getAsSOAPMessage Get the xml part as a read/write SOAPEnvelope</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttachmentID(int)">getAttachmentID</a></span>&#8203;(int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Get the indicated (non-soap part) attachment id</div>
</td>
</tr>
<tr id="i3" 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" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttachmentID(java.lang.String)">getAttachmentID</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;partName)</code></th>
<td class="colLast">
<div class="block">Get the indicated (non-soap part) attachment id</div>
</td>
</tr>
<tr id="i4" 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" class="externalLink">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" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttachmentIDs()">getAttachmentIDs</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the list of attachment content ids for the message</div>
</td>
</tr>
<tr id="i5" 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" class="externalLink">DataHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDataHandler(java.lang.String)">getDataHandler</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;cid)</code></th>
<td class="colLast">
<div class="block">Get the attachment identified by the contentID</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../core/MessageContext.html" title="class in org.apache.axis2.jaxws.core">MessageContext</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageContext()">getMessageContext</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" 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" class="externalLink">Map</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMimeHeaders()">getMimeHeaders</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="Protocol.html" title="enum in org.apache.axis2.jaxws.message">Protocol</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocol()">getProtocol</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the protocol for this Message (soap11, soap12, etc.)</div>
</td>
</tr>
<tr id="i9" 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" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue(java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)">getValue</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;context,
<a href="factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a>&nbsp;blockFactory)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDoingSWA()">isDoingSWA</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMTOMEnabled()">isMTOMEnabled</a></span>()</code></th>
<td class="colLast">
<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 id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPostPivot()">isPostPivot</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" 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" class="externalLink">DataHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeDataHandler(java.lang.String)">removeDataHandler</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;cid)</code></th>
<td class="colLast">
<div class="block">Get the attachment and remove it from the Message</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDoingSWA(boolean)">setDoingSWA</a></span>&#8203;(boolean&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Indicate that an SWA DataHandler was added to the message.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageContext(org.apache.axis2.jaxws.core.MessageContext)">setMessageContext</a></span>&#8203;(<a href="../core/MessageContext.html" title="class in org.apache.axis2.jaxws.core">MessageContext</a>&nbsp;messageContext)</code></th>
<td class="colLast">
<div class="block">JAX-WS Message Context that owns the Message</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMimeHeaders(java.util.Map)">setMimeHeaders</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&nbsp;map)</code></th>
<td class="colLast">
<div class="block">Set the transport headers</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMTOMEnabled(boolean)">setMTOMEnabled</a></span>&#8203;(boolean&nbsp;b)</code></th>
<td class="colLast">
<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 id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPostPivot()">setPostPivot</a></span>()</code></th>
<td class="colLast">
<div class="block">Indicate that this message is passed the pivot point.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.axis2.jaxws.message.XMLPart">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.axis2.jaxws.message.<a href="XMLPart.html" title="interface in org.apache.axis2.jaxws.message">XMLPart</a></h3>
<code><a href="XMLPart.html#appendHeaderBlock(java.lang.String,java.lang.String,org.apache.axis2.jaxws.message.Block)">appendHeaderBlock</a>, <a href="XMLPart.html#close()">close</a>, <a href="XMLPart.html#getAsOMElement()">getAsOMElement</a>, <a href="XMLPart.html#getAsSOAPEnvelope()">getAsSOAPEnvelope</a>, <a href="XMLPart.html#getBodyBlock(int,java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)">getBodyBlock</a>, <a href="XMLPart.html#getBodyBlock(java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)">getBodyBlock</a>, <a href="XMLPart.html#getBodyBlockQNames()">getBodyBlockQNames</a>, <a href="XMLPart.html#getHeaderBlock(java.lang.String,java.lang.String,java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)">getHeaderBlock</a>, <a href="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="XMLPart.html#getHeaderQNames()">getHeaderQNames</a>, <a href="XMLPart.html#getIndirection()">getIndirection</a>, <a href="XMLPart.html#getNumBodyBlocks()">getNumBodyBlocks</a>, <a href="XMLPart.html#getNumHeaderBlocks()">getNumHeaderBlocks</a>, <a href="XMLPart.html#getOperationElement()">getOperationElement</a>, <a href="XMLPart.html#getParent()">getParent</a>, <a href="XMLPart.html#getStyle()">getStyle</a>, <a href="XMLPart.html#getXMLFault()">getXMLFault</a>, <a href="XMLPart.html#getXMLPartContentType()">getXMLPartContentType</a>, <a href="XMLPart.html#getXMLStreamReader(boolean)">getXMLStreamReader</a>, <a href="XMLPart.html#isConsumed()">isConsumed</a>, <a href="XMLPart.html#isFault()">isFault</a>, <a href="XMLPart.html#outputTo(javax.xml.stream.XMLStreamWriter,boolean)">outputTo</a>, <a href="XMLPart.html#removeBodyBlock(int)">removeBodyBlock</a>, <a href="XMLPart.html#removeHeaderBlock(java.lang.String,java.lang.String)">removeHeaderBlock</a>, <a href="XMLPart.html#setBodyBlock(int,org.apache.axis2.jaxws.message.Block)">setBodyBlock</a>, <a href="XMLPart.html#setBodyBlock(org.apache.axis2.jaxws.message.Block)">setBodyBlock</a>, <a href="XMLPart.html#setHeaderBlock(java.lang.String,java.lang.String,org.apache.axis2.jaxws.message.Block)">setHeaderBlock</a>, <a href="XMLPart.html#setIndirection(int)">setIndirection</a>, <a href="XMLPart.html#setOperationElement(javax.xml.namespace.QName)">setOperationElement</a>, <a href="XMLPart.html#setParent(org.apache.axis2.jaxws.message.Message)">setParent</a>, <a href="XMLPart.html#setStyle(javax.jws.soap.SOAPBinding.Style)">setStyle</a>, <a href="XMLPart.html#setXMLFault(org.apache.axis2.jaxws.message.XMLFault)">setXMLFault</a>, <a href="XMLPart.html#traceString(java.lang.String)">traceString</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getProtocol()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocol</h4>
<pre class="methodSignature"><a href="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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="XMLPart.html#getProtocol()">getProtocol</a></code>&nbsp;in interface&nbsp;<code><a href="XMLPart.html" title="interface in org.apache.axis2.jaxws.message">XMLPart</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Protocl</dd>
</dl>
</li>
</ul>
<a id="getAsSOAPMessage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAsSOAPMessage</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPMessage</a>&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" class="externalLink">WebServiceException</a></pre>
<div class="block">getAsSOAPMessage Get the xml part as a read/write SOAPEnvelope</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SOAPEnvelope</dd>
<dt><span class="throwsLabel">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" class="externalLink">WebServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="addDataHandler(javax.activation.DataHandler,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addDataHandler</h4>
<pre class="methodSignature">void&nbsp;addDataHandler&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation" class="externalLink">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" class="externalLink">String</a>&nbsp;id)</pre>
<div class="block">Add Attachment</div>
<dl>
<dt><span class="paramLabel">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="seeLabel">See Also:</span></dt>
<dd><code>addAttachment(Attachment)</code></dd>
</dl>
</li>
</ul>
<a id="getAttachmentIDs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachmentIDs</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">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" class="externalLink">String</a>&gt;&nbsp;getAttachmentIDs()</pre>
<div class="block">Get the list of attachment content ids for the message</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List<String></dd>
</dl>
</li>
</ul>
<a id="getAttachmentID(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachmentID</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getAttachmentID&#8203;(int&nbsp;index)</pre>
<div class="block">Get the indicated (non-soap part) attachment id</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>CID or null if not present</dd>
</dl>
</li>
</ul>
<a id="getAttachmentID(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachmentID</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getAttachmentID&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;partName)</pre>
<div class="block">Get the indicated (non-soap part) attachment id</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>partName</code> - (WS-I indicates that SWA attachments have a partName prefix)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>CID or null if not present</dd>
</dl>
</li>
</ul>
<a id="getDataHandler(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataHandler</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation" class="externalLink">DataHandler</a>&nbsp;getDataHandler&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;cid)</pre>
<div class="block">Get the attachment identified by the contentID</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cid</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a id="setDoingSWA(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDoingSWA</h4>
<pre class="methodSignature">void&nbsp;setDoingSWA&#8203;(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="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - </dd>
</dl>
</li>
</ul>
<a id="isDoingSWA()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDoingSWA</h4>
<pre class="methodSignature">boolean&nbsp;isDoingSWA()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if SWA DataHandler is present</dd>
</dl>
</li>
</ul>
<a id="removeDataHandler(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeDataHandler</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation" class="externalLink">DataHandler</a>&nbsp;removeDataHandler&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;cid)</pre>
<div class="block">Get the attachment and remove it from the Message</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cid</code> - </dd>
</dl>
</li>
</ul>
<a id="isMTOMEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMTOMEnabled</h4>
<pre class="methodSignature">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="returnLabel">Returns:</span></dt>
<dd>if this is an MTOM message</dd>
</dl>
</li>
</ul>
<a id="setMTOMEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMTOMEnabled</h4>
<pre class="methodSignature">void&nbsp;setMTOMEnabled&#8203;(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="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - </dd>
</dl>
</li>
</ul>
<a id="getMimeHeaders()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMimeHeaders</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&nbsp;getMimeHeaders()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>get the transport headers map.</dd>
</dl>
</li>
</ul>
<a id="setMimeHeaders(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMimeHeaders</h4>
<pre class="methodSignature">void&nbsp;setMimeHeaders&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&nbsp;map)</pre>
<div class="block">Set the transport headers</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>map</code> - Map</dd>
</dl>
</li>
</ul>
<a id="setPostPivot()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPostPivot</h4>
<pre class="methodSignature">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 id="isPostPivot()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPostPivot</h4>
<pre class="methodSignature">boolean&nbsp;isPostPivot()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if post pivot</dd>
</dl>
</li>
</ul>
<a id="setMessageContext(org.apache.axis2.jaxws.core.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessageContext</h4>
<pre class="methodSignature">void&nbsp;setMessageContext&#8203;(<a href="../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="paramLabel">Parameters:</span></dt>
<dd><code>messageContext</code> - </dd>
</dl>
</li>
</ul>
<a id="getMessageContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageContext</h4>
<pre class="methodSignature"><a href="../core/MessageContext.html" title="class in org.apache.axis2.jaxws.core">MessageContext</a>&nbsp;getMessageContext()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>JAX-WS MessageContext</dd>
</dl>
</li>
</ul>
<a id="getValue(java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getValue</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;getValue&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;context,
<a href="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" class="externalLink">WebServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">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" class="externalLink">WebServiceException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</footer>
</body>
</html>