Google Git
Sign in
apache / axis-site / 4f0291d5a8fb9397112130e7927cf2f4e55d8bf2 / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / transport / TransportSender.html
blob: 7be59fa41878a47ece808e35bfef703f8ef60478 [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>TransportSender (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="TransportSender (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/TransportSender.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/transport/TransportListener.html" title="interface in org.apache.axis2.transport"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis2/transport/TransportUtils.html" title="class in org.apache.axis2.transport"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/transport/TransportSender.html" target="_top">Frames</a></li>
<li><a href="TransportSender.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.transport</div>
<h2 title="Interface TransportSender" class="title">Interface TransportSender</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/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/axis2/transport/http/HTTPTransportSender.html" title="interface in org.apache.axis2.transport.http">HTTPTransportSender</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/axis2/transport/base/AbstractTransportSender.html" title="class in org.apache.axis2.transport.base">AbstractTransportSender</a>, <a href="../../../../org/apache/axis2/transport/http/CommonsHTTPTransportSender.html" title="class in org.apache.axis2.transport.http">CommonsHTTPTransportSender</a>, <a href="../../../../org/apache/axis2/transport/http/impl/httpclient3/HTTPClient3TransportSender.html" title="class in org.apache.axis2.transport.http.impl.httpclient3">HTTPClient3TransportSender</a>, <a href="../../../../org/apache/axis2/transport/http/impl/httpclient4/HTTPClient4TransportSender.html" title="class in org.apache.axis2.transport.http.impl.httpclient4">HTTPClient4TransportSender</a>, <a href="../../../../org/apache/axis2/transport/java/JavaTransportSender.html" title="class in org.apache.axis2.transport.java">JavaTransportSender</a>, <a href="../../../../org/apache/axis2/transport/jms/JMSSender.html" title="class in org.apache.axis2.transport.jms">JMSSender</a>, <a href="../../../../org/apache/axis2/transport/local/LocalResponder.html" title="class in org.apache.axis2.transport.local">LocalResponder</a>, <a href="../../../../org/apache/axis2/transport/local/LocalTransportSender.html" title="class in org.apache.axis2.transport.local">LocalTransportSender</a>, <a href="../../../../org/apache/axis2/transport/mail/MailTransportSender.html" title="class in org.apache.axis2.transport.mail">MailTransportSender</a>, <a href="../../../../org/apache/axis2/transport/tcp/TCPTransportSender.html" title="class in org.apache.axis2.transport.tcp">TCPTransportSender</a>, <a href="../../../../org/apache/axis2/transport/udp/UDPSender.html" title="class in org.apache.axis2.transport.udp">UDPSender</a>, <a href="../../../../org/apache/axis2/transport/xmpp/XMPPSender.html" title="class in org.apache.axis2.transport.xmpp">XMPPSender</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">TransportSender</span>
extends <a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></pre>
<div class="block">TransportSender sends the SOAP Message to other SOAP nodes. A TransportSender is responsible for
writing the SOAP Message to the wire. Out flow must be terminated end with a TransportSender</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.axis2.engine.Handler">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.axis2.engine.<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></h3>
<code><a href="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a></code></li>
</ul>
</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/transport/TransportSender.html#cleanup(org.apache.axis2.context.MessageContext)">cleanup</a></strong>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code>
<div class="block">Release resources associated with a given message context.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/transport/TransportSender.html#init(org.apache.axis2.context.ConfigurationContext, org.apache.axis2.description.TransportOutDescription)">init</a></strong>(<a href="../../../../org/apache/axis2/context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a>&nbsp;confContext,
<a href="../../../../org/apache/axis2/description/TransportOutDescription.html" title="class in org.apache.axis2.description">TransportOutDescription</a>&nbsp;transportOut)</code>
<div class="block">Initialize</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/transport/TransportSender.html#stop()">stop</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.axis2.engine.Handler">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.axis2.engine.<a href="../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></h3>
<code><a href="../../../../org/apache/axis2/engine/Handler.html#flowComplete(org.apache.axis2.context.MessageContext)">flowComplete</a>, <a href="../../../../org/apache/axis2/engine/Handler.html#getHandlerDesc()">getHandlerDesc</a>, <a href="../../../../org/apache/axis2/engine/Handler.html#getName()">getName</a>, <a href="../../../../org/apache/axis2/engine/Handler.html#getParameter(java.lang.String)">getParameter</a>, <a href="../../../../org/apache/axis2/engine/Handler.html#init(org.apache.axis2.description.HandlerDescription)">init</a>, <a href="../../../../org/apache/axis2/engine/Handler.html#invoke(org.apache.axis2.context.MessageContext)">invoke</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="cleanup(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanup</h4>
<pre>void&nbsp;cleanup(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">Release resources associated with a given message context.
This method is called after processing the response of an invocation of
a synchronous out-in operation to allow the transport to release any resources allocated
during that invocation.
<p>
This method is mainly useful for connection oriented transports that return from
<a href="../../../../org/apache/axis2/engine/Handler.html#invoke(org.apache.axis2.context.MessageContext)"><code>Handler.invoke(MessageContext)</code></a> before the entire response is available. A transport of
this type will construct an <a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a> object and set it as the
<a href="../../../../org/apache/axis2/context/MessageContext.html#TRANSPORT_IN"><code>MessageContext.TRANSPORT_IN</code></a> property on the
<a href="../../../../org/apache/axis2/context/OperationContext.html" title="class in org.apache.axis2.context"><code>OperationContext</code></a>). In order for this to work, the
connection must remain open until the response has been processed. This method is then
used to release the connection explicitly.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>msgContext</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl>
</li>
</ul>
<a name="init(org.apache.axis2.context.ConfigurationContext, org.apache.axis2.description.TransportOutDescription)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>void&nbsp;init(<a href="../../../../org/apache/axis2/context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a>&nbsp;confContext,
<a href="../../../../org/apache/axis2/description/TransportOutDescription.html" title="class in org.apache.axis2.description">TransportOutDescription</a>&nbsp;transportOut)
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">Initialize</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>confContext</code> - </dd><dd><code>transportOut</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl>
</li>
</ul>
<a name="stop()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stop</h4>
<pre>void&nbsp;stop()</pre>
</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/TransportSender.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/transport/TransportListener.html" title="interface in org.apache.axis2.transport"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis2/transport/TransportUtils.html" title="class in org.apache.axis2.transport"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/transport/TransportSender.html" target="_top">Frames</a></li>
<li><a href="TransportSender.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>