Google Git
Sign in
apache / axis-site / f545f87a6b723b56329b1ebb949e3b91067c8436 / . / axis / java / apiDocs / org / apache / axis / attachments / Attachments.html
blob: d6593178f9d41b818f3515ac474d5bf40f4e53d1 [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>Attachments (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="Attachments (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/Attachments.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/attachments/AttachmentPart.html" title="class in org.apache.axis.attachments"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis/attachments/AttachmentsImpl.html" title="class in org.apache.axis.attachments"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis/attachments/Attachments.html" target="_top">Frames</a></li>
<li><a href="Attachments.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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.axis.attachments</div>
<h2 title="Interface Attachments" class="title">Interface Attachments</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</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>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/axis/attachments/AttachmentsImpl.html" title="class in org.apache.axis.attachments">AttachmentsImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Attachments</span>
extends <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">Access the Attachments of a Message. This interface essentially
firewalls the rest of Axis from any dependencies on javax.activation.
<p>
If javax.activation is not available, this is the *only* class that
will be compiled in org.apache.axis.attachments.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Rob Jellinghaus (robj@unrealities.com), Rick Rineholt</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">&nbsp;</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/attachments/Attachments.html#CIDprefix">CIDprefix</a></strong></code>
<div class="block">The prefix used to assoc. attachments as content-id</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#SEND_TYPE_DEFAULT">SEND_TYPE_DEFAULT</a></strong></code>
<div class="block">The default attatchment type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#SEND_TYPE_DIME">SEND_TYPE_DIME</a></strong></code>
<div class="block">Use the DIME attatchment type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#SEND_TYPE_MAX">SEND_TYPE_MAX</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#SEND_TYPE_MIME">SEND_TYPE_MIME</a></strong></code>
<div class="block">Use the SOAP with MIME attatchment send type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#SEND_TYPE_MTOM">SEND_TYPE_MTOM</a></strong></code>
<div class="block">Use the MTOM attatchment type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#SEND_TYPE_NONE">SEND_TYPE_NONE</a></strong></code>
<div class="block">Use the DIME attatchment type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#SEND_TYPE_NOTSET">SEND_TYPE_NOTSET</a></strong></code>
<div class="block">Use the default attatchment send type.</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">&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><a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#addAttachmentPart(org.apache.axis.Part)">addAttachmentPart</a></strong>(<a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a>&nbsp;newPart)</code>
<div class="block">Adds an existing attachment to this list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#createAttachmentPart()">createAttachmentPart</a></strong>()</code>
<div class="block">Create a new attachment Part in this Message.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#createAttachmentPart(java.lang.Object)">createAttachmentPart</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>&nbsp;part)</code>
<div class="block">Create a new attachment Part in this Message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#dispose()">dispose</a></strong>()</code>
<div class="block">dispose of the attachments and their files; do not use the object
after making this call.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#getAttachmentByReference(java.lang.String)">getAttachmentByReference</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>&nbsp;reference)</code>
<div class="block">This method should look at a refernce and determine if it is a CID: or url
to look for attachment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#getAttachmentCount()">getAttachmentCount</a></strong>()</code>
<div class="block">This is the number of attachments.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#getAttachments()">getAttachments</a></strong>()</code>
<div class="block">This method will return all attachments as a collection.</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/attachments/Attachments.html#getAttachments(javax.xml.soap.MimeHeaders)">getAttachments</a></strong>(<a href="../../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a>&nbsp;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="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#getContentLength()">getContentLength</a></strong>()</code>
<div class="block">Get the content length of the stream.</div>
</td>
</tr>
<tr class="rowColor">
<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/attachments/Attachments.html#getContentType()">getContentType</a></strong>()</code>
<div class="block">Write the content to the stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/axis/attachments/IncomingAttachmentStreams.html" title="class in org.apache.axis.attachments">IncomingAttachmentStreams</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#getIncomingAttachmentStreams()">getIncomingAttachmentStreams</a></strong>()</code>
<div class="block">Once this method is called, attachments can only be accessed via the InputStreams.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#getRootPart()">getRootPart</a></strong>()</code>
<div class="block">From the complex stream return the SOAP part.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#getSendType()">getSendType</a></strong>()</code>
<div class="block">Determine if an object is to be treated as an attchment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#isAttachment(java.lang.Object)">isAttachment</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>&nbsp;value)</code>
<div class="block">Determine if an object is to be treated as an attchment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.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="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#removeAttachmentPart(java.lang.String)">removeAttachmentPart</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>&nbsp;reference)</code>
<div class="block">This method uses getAttacmentByReference() to look for attachment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#setAttachmentParts(java.util.Collection)">setAttachmentParts</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;parts)</code>
<div class="block">Will the attachments of this message to that of the colleciton.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#setRootPart(org.apache.axis.Part)">setRootPart</a></strong>(<a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a>&nbsp;newRoot)</code>
<div class="block">Sets the root part of this multipart block</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#setSendType(int)">setSendType</a></strong>(int&nbsp;sendtype)</code>
<div class="block">Set the format for attachments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/attachments/Attachments.html#writeContentToStream(java.io.OutputStream)">writeContentToStream</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>&nbsp;os)</code>
<div class="block">Write the content to the stream.</div>
</td>
</tr>
</table>
</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="SEND_TYPE_NOTSET">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEND_TYPE_NOTSET</h4>
<pre>static final&nbsp;int SEND_TYPE_NOTSET</pre>
<div class="block">Use the default attatchment send type.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.axis.attachments.Attachments.SEND_TYPE_NOTSET">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SEND_TYPE_MIME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEND_TYPE_MIME</h4>
<pre>static final&nbsp;int SEND_TYPE_MIME</pre>
<div class="block">Use the SOAP with MIME attatchment send type.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.axis.attachments.Attachments.SEND_TYPE_MIME">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SEND_TYPE_DIME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEND_TYPE_DIME</h4>
<pre>static final&nbsp;int SEND_TYPE_DIME</pre>
<div class="block">Use the DIME attatchment type.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.axis.attachments.Attachments.SEND_TYPE_DIME">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SEND_TYPE_MTOM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEND_TYPE_MTOM</h4>
<pre>static final&nbsp;int SEND_TYPE_MTOM</pre>
<div class="block">Use the MTOM attatchment type.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.axis.attachments.Attachments.SEND_TYPE_MTOM">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SEND_TYPE_NONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEND_TYPE_NONE</h4>
<pre>static final&nbsp;int SEND_TYPE_NONE</pre>
<div class="block">Use the DIME attatchment type.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.axis.attachments.Attachments.SEND_TYPE_NONE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SEND_TYPE_MAX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEND_TYPE_MAX</h4>
<pre>static final&nbsp;int SEND_TYPE_MAX</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.axis.attachments.Attachments.SEND_TYPE_MAX">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SEND_TYPE_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEND_TYPE_DEFAULT</h4>
<pre>static final&nbsp;int SEND_TYPE_DEFAULT</pre>
<div class="block">The default attatchment type. MIME</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.axis.attachments.Attachments.SEND_TYPE_DEFAULT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CIDprefix">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CIDprefix</h4>
<pre>static final&nbsp;<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> CIDprefix</pre>
<div class="block">The prefix used to assoc. attachments as content-id</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.axis.attachments.Attachments.CIDprefix">Constant Field Values</a></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="addAttachmentPart(org.apache.axis.Part)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAttachmentPart</h4>
<pre><a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a>&nbsp;addAttachmentPart(<a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a>&nbsp;newPart)
throws <a href="../../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre>
<div class="block">Adds an existing attachment to this list.
Note: Passed part will be bound to this message.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newPart</code> - new part to add</dd>
<dt><span class="strong">Returns:</span></dt><dd>Part old attachment with the same Content-ID, or null.</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></dd></dl>
</li>
</ul>
<a name="removeAttachmentPart(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAttachmentPart</h4>
<pre><a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a>&nbsp;removeAttachmentPart(<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>&nbsp;reference)
throws <a href="../../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre>
<div class="block">This method uses getAttacmentByReference() to look for attachment.
If attachment has been found, it will be removed from the list, and
returned to the user.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - The reference that referers to an attachment.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The part associated with the removed attachment, or null.</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></dd></dl>
</li>
</ul>
<a name="removeAllAttachments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAllAttachments</h4>
<pre>void&nbsp;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>
</li>
</ul>
<a name="getAttachmentByReference(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachmentByReference</h4>
<pre><a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a>&nbsp;getAttachmentByReference(<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>&nbsp;reference)
throws <a href="../../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre>
<div class="block">This method should look at a refernce and determine if it is a CID: or url
to look for attachment.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - The reference in the xml that referers to an attachment.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The part associated with 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></dd></dl>
</li>
</ul>
<a name="getAttachments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachments</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;getAttachments()
throws <a href="../../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre>
<div class="block">This method will return all attachments as a collection.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A collection of attachments.</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></dd></dl>
</li>
</ul>
<a name="getAttachments(javax.xml.soap.MimeHeaders)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachments</h4>
<pre><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>&nbsp;getAttachments(<a href="../../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a>&nbsp;headers)</pre>
<div class="block">Retrieves all the <CODE>AttachmentPart</CODE> objects
that have header entries that match the specified headers.
Note that a returned attachment could have headers in
addition to those specified.</div>
<dl><dt><span class="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="createAttachmentPart(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAttachmentPart</h4>
<pre><a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a>&nbsp;createAttachmentPart(<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>&nbsp;part)
throws <a href="../../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre>
<div class="block">Create a new attachment Part in this Message.
Will actually, and always, return an AttachmentPart.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>part</code> - The part that is referenced</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new attachment part</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></dd></dl>
</li>
</ul>
<a name="createAttachmentPart()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAttachmentPart</h4>
<pre><a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a>&nbsp;createAttachmentPart()
throws <a href="../../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre>
<div class="block">Create a new attachment Part in this Message.
Will actually, and always, return an AttachmentPart.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a new attachment part</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></dd></dl>
</li>
</ul>
<a name="setAttachmentParts(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttachmentParts</h4>
<pre>void&nbsp;setAttachmentParts(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;parts)
throws <a href="../../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre>
<div class="block">Will the attachments of this message to that of the colleciton.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parts</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></dd></dl>
</li>
</ul>
<a name="getRootPart()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRootPart</h4>
<pre><a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a>&nbsp;getRootPart()</pre>
<div class="block">From the complex stream return the SOAP part.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>will return the root part if the stream is supported,
otherwise null.</dd></dl>
</li>
</ul>
<a name="setRootPart(org.apache.axis.Part)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRootPart</h4>
<pre>void&nbsp;setRootPart(<a href="../../../../org/apache/axis/Part.html" title="interface in org.apache.axis">Part</a>&nbsp;newRoot)</pre>
<div class="block">Sets the root part of this multipart block</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newRoot</code> - the new root <code>Part</code></dd></dl>
</li>
</ul>
<a name="getContentLength()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentLength</h4>
<pre>long&nbsp;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 of the stream.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the content length of</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></dd></dl>
</li>
</ul>
<a name="writeContentToStream(java.io.OutputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeContentToStream</h4>
<pre>void&nbsp;writeContentToStream(<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>&nbsp;os)
throws <a href="../../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre>
<div class="block">Write the content to the stream.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>os</code> - the stream</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></dd></dl>
</li>
</ul>
<a name="getContentType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentType</h4>
<pre><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>&nbsp;getContentType()
throws <a href="../../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</a></pre>
<div class="block">Write the content to the stream.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the content type</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></dd></dl>
</li>
</ul>
<a name="getAttachmentCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachmentCount</h4>
<pre>int&nbsp;getAttachmentCount()</pre>
<div class="block">This is the number of attachments.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of attachments</dd></dl>
</li>
</ul>
<a name="isAttachment(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAttachment</h4>
<pre>boolean&nbsp;isAttachment(<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>&nbsp;value)</pre>
<div class="block">Determine if an object is to be treated as an attchment.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value that is to be determined if
its an attachment.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if value should be treated as an attchment.</dd></dl>
</li>
</ul>
<a name="setSendType(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSendType</h4>
<pre>void&nbsp;setSendType(int&nbsp;sendtype)</pre>
<div class="block">Set the format for attachments.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sendtype</code> - the format to send.
SEND_TYPE_MIME for Multipart Releated Mail type attachments.
SEND_TYPE_DIME for DIME type attachments.</dd></dl>
</li>
</ul>
<a name="getSendType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSendType</h4>
<pre>int&nbsp;getSendType()</pre>
<div class="block">Determine if an object is to be treated as an attchment.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>SEND_TYPE_MIME, SEND_TYPE_DIME, SEND_TYPE_NOTSET</dd></dl>
</li>
</ul>
<a name="dispose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispose</h4>
<pre>void&nbsp;dispose()</pre>
<div class="block">dispose of the attachments and their files; do not use the object
after making this call.</div>
</li>
</ul>
<a name="getIncomingAttachmentStreams()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getIncomingAttachmentStreams</h4>
<pre><a href="../../../../org/apache/axis/attachments/IncomingAttachmentStreams.html" title="class in org.apache.axis.attachments">IncomingAttachmentStreams</a>&nbsp;getIncomingAttachmentStreams()</pre>
<div class="block">Once this method is called, attachments can only be accessed via the InputStreams.
Any other access to the attachments collection (e.g. via getAttachments()) is
prohibited and will cause a ConcurrentModificationException to be thrown.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>All of the attachment streams.</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/Attachments.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/attachments/AttachmentPart.html" title="class in org.apache.axis.attachments"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis/attachments/AttachmentsImpl.html" title="class in org.apache.axis.attachments"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis/attachments/Attachments.html" target="_top">Frames</a></li>
<li><a href="Attachments.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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 © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>