| <!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>RequestResponseTransport (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="RequestResponseTransport (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/RequestResponseTransport.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/OutTransportInfo.html" title="interface in org.apache.axis2.transport"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/axis2/transport/RequestResponseTransport.RequestResponseTransportStatus.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/RequestResponseTransport.html" target="_top">Frames</a></li> |
| <li><a href="RequestResponseTransport.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </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 RequestResponseTransport" class="title">Interface RequestResponseTransport</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/axis2/transport/http/AxisServlet.ServletRequestResponseTransport.html" title="class in org.apache.axis2.transport.http">AxisServlet.ServletRequestResponseTransport</a>, <a href="../../../../org/apache/axis2/transport/mail/MailRequestResponseTransport.html" title="class in org.apache.axis2.transport.mail">MailRequestResponseTransport</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">RequestResponseTransport</span></pre> |
| <div class="block">This interface represents a control object for a Request/Response transport. |
| The normal flow of Axis2 is rooted at the transport -- this does not |
| allow for an acknowledgement to be transmitted before processing has |
| completed, nor does it allow for processing to be paused and resumed |
| on a separate thread without having a response be sent back. This interface |
| enables both of those scenarios by allowing the transport to expose |
| controls to the rest of the engine via a callback.</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> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/transport/RequestResponseTransport.RequestResponseTransportStatus.html" title="class in org.apache.axis2.transport">RequestResponseTransport.RequestResponseTransportStatus</a></strong></code> |
| <div class="block">Used to give the current status of the RequestResponseTransport object.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/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/transport/RequestResponseTransport.html#HOLD_RESPONSE">HOLD_RESPONSE</a></strong></code> |
| <div class="block">If this property is set to true in a message transport will call the awaitResponse method |
| of the RequestResponseTransport instead of returning.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/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/transport/RequestResponseTransport.html#TRANSPORT_CONTROL">TRANSPORT_CONTROL</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/transport/RequestResponseTransport.html#acknowledgeMessage(org.apache.axis2.context.MessageContext)">acknowledgeMessage</a></strong>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> msgContext)</code> |
| <div class="block">Notify the transport that a message should be acknowledged at this time.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/transport/RequestResponseTransport.html#awaitResponse()">awaitResponse</a></strong>()</code> |
| <div class="block">Pause execution and wait for a response message to be ready.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/axis2/transport/RequestResponseTransport.RequestResponseTransportStatus.html" title="class in org.apache.axis2.transport">RequestResponseTransport.RequestResponseTransportStatus</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/transport/RequestResponseTransport.html#getStatus()">getStatus</a></strong>()</code> |
| <div class="block">This gives the current status of an RequestResponseTransport object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/transport/RequestResponseTransport.html#isResponseWritten()">isResponseWritten</a></strong>()</code> |
| <div class="block">This will indicate whether or not the response has already been written</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/transport/RequestResponseTransport.html#setResponseWritten(boolean)">setResponseWritten</a></strong>(boolean responseWritten)</code> |
| <div class="block">This is used to set the response written flag on the RequestResponseTransport |
| instance</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/transport/RequestResponseTransport.html#signalFaultReady(org.apache.axis2.AxisFault)">signalFaultReady</a></strong>(<a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a> fault)</code> |
| <div class="block">This will tell the transport to end a current wait by raising the given fault.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/transport/RequestResponseTransport.html#signalResponseReady()">signalResponseReady</a></strong>()</code> |
| <div class="block">Signal that a response has be created and is ready for transmission.</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="TRANSPORT_CONTROL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TRANSPORT_CONTROL</h4> |
| <pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TRANSPORT_CONTROL</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.axis2.transport.RequestResponseTransport.TRANSPORT_CONTROL">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="HOLD_RESPONSE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HOLD_RESPONSE</h4> |
| <pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> HOLD_RESPONSE</pre> |
| <div class="block">If this property is set to true in a message transport will call the awaitResponse method |
| of the RequestResponseTransport instead of returning. The value should be a Boolean object.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.axis2.transport.RequestResponseTransport.HOLD_RESPONSE">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="acknowledgeMessage(org.apache.axis2.context.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acknowledgeMessage</h4> |
| <pre>void acknowledgeMessage(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> msgContext) |
| throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Notify the transport that a message should be acknowledged at this time.</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="awaitResponse()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>awaitResponse</h4> |
| <pre>void awaitResponse() |
| throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>, |
| <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Pause execution and wait for a response message to be ready. This will |
| typically be called by the transport after a message has been paused and |
| will cause the transport to block until a response message is ready to be |
| returned. This is required to enable RM for in-out MEPs over a |
| request/response transport; without it the message would be paused and the |
| transport would simply ack the request.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="signalResponseReady()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>signalResponseReady</h4> |
| <pre>void signalResponseReady()</pre> |
| <div class="block">Signal that a response has be created and is ready for transmission. This |
| should release anyone who is blocked on a awaitResponse().</div> |
| </li> |
| </ul> |
| <a name="signalFaultReady(org.apache.axis2.AxisFault)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>signalFaultReady</h4> |
| <pre>void signalFaultReady(<a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a> fault)</pre> |
| <div class="block">This will tell the transport to end a current wait by raising the given fault.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fault</code> - The fault to be raised.</dd></dl> |
| </li> |
| </ul> |
| <a name="getStatus()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatus</h4> |
| <pre><a href="../../../../org/apache/axis2/transport/RequestResponseTransport.RequestResponseTransportStatus.html" title="class in org.apache.axis2.transport">RequestResponseTransport.RequestResponseTransportStatus</a> getStatus()</pre> |
| <div class="block">This gives the current status of an RequestResponseTransport object.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl> |
| </li> |
| </ul> |
| <a name="isResponseWritten()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isResponseWritten</h4> |
| <pre>boolean isResponseWritten()</pre> |
| <div class="block">This will indicate whether or not the response has already been written</div> |
| </li> |
| </ul> |
| <a name="setResponseWritten(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setResponseWritten</h4> |
| <pre>void setResponseWritten(boolean responseWritten)</pre> |
| <div class="block">This is used to set the response written flag on the RequestResponseTransport |
| instance</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/RequestResponseTransport.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/OutTransportInfo.html" title="interface in org.apache.axis2.transport"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/axis2/transport/RequestResponseTransport.RequestResponseTransportStatus.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/RequestResponseTransport.html" target="_top">Frames</a></li> |
| <li><a href="RequestResponseTransport.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </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> |
