| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>TransportListener (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="TransportListener (Apache Axis2)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/TransportListener.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 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: </li> |
| <li>Nested | </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </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> <a href="package-summary.html">org.apache.axis2.kernel</a></div> |
| <h2 title="Interface TransportListener" class="title">Interface TransportListener</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../transport/base/datagram/AbstractDatagramTransportListener.html" title="class in org.apache.axis2.transport.base.datagram">AbstractDatagramTransportListener</a></code>, <code><a href="../transport/base/AbstractPollingTransportListener.html" title="class in org.apache.axis2.transport.base">AbstractPollingTransportListener</a></code>, <code><a href="../transport/base/AbstractTransportListener.html" title="class in org.apache.axis2.transport.base">AbstractTransportListener</a></code>, <code><a href="../transport/base/AbstractTransportListenerEx.html" title="class in org.apache.axis2.transport.base">AbstractTransportListenerEx</a></code>, <code><a href="../transport/http/AxisServletListener.html" title="class in org.apache.axis2.transport.http">AxisServletListener</a></code>, <code><a href="../transport/jms/JMSListener.html" title="class in org.apache.axis2.transport.jms">JMSListener</a></code>, <code><a href="../transport/testkit/util/LifecycleFixTransportListenerProxy.html" title="class in org.apache.axis2.transport.testkit.util">LifecycleFixTransportListenerProxy</a></code>, <code><a href="../transport/mail/MailTransportListener.html" title="class in org.apache.axis2.transport.mail">MailTransportListener</a></code>, <code><a href="../transport/http/SimpleHTTPServer.html" title="class in org.apache.axis2.transport.http">SimpleHTTPServer</a></code>, <code><a href="../transport/tcp/TCPTransportListener.html" title="class in org.apache.axis2.transport.tcp">TCPTransportListener</a></code>, <code><a href="../transport/udp/UDPListener.html" title="class in org.apache.axis2.transport.udp">UDPListener</a></code>, <code><a href="../transport/xmpp/XMPPListener.html" title="class in org.apache.axis2.transport.xmpp">XMPPListener</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">TransportListener</span></pre> |
| <div class="block">Class TransportListener</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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="#HOST_ADDRESS">HOST_ADDRESS</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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="#PARAM_PORT">PARAM_PORT</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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="#destroy()">destroy</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEPRsForService(java.lang.String,java.lang.String)">getEPRsForService</a></span>​(<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> serviceName, |
| <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> ip)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the endpoint references for a given service.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../context/SessionContext.html" title="class in org.apache.axis2.context">SessionContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionContext(org.apache.axis2.context.MessageContext)">getSessionContext</a></span>​(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> messageContext)</code></th> |
| <td class="colLast"> |
| <div class="block">To get the sessionContext transport dependent manner.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init(org.apache.axis2.context.ConfigurationContext,org.apache.axis2.description.TransportInDescription)">init</a></span>​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> axisConf, |
| <a href="../description/TransportInDescription.html" title="class in org.apache.axis2.description">TransportInDescription</a> transprtIn)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start()">start</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stop()">stop</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="PARAM_PORT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PARAM_PORT</h4> |
| <pre>static final <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> PARAM_PORT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.axis2.kernel.TransportListener.PARAM_PORT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="HOST_ADDRESS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HOST_ADDRESS</h4> |
| <pre>static final <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> HOST_ADDRESS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.axis2.kernel.TransportListener.HOST_ADDRESS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="init(org.apache.axis2.context.ConfigurationContext,org.apache.axis2.description.TransportInDescription)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre class="methodSignature">void init​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> axisConf, |
| <a href="../description/TransportInDescription.html" title="class in org.apache.axis2.description">TransportInDescription</a> transprtIn) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="start()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre class="methodSignature">void start() |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="stop()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre class="methodSignature">void stop() |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getEPRsForService(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEPRsForService</h4> |
| <pre class="methodSignature"><a href="../addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a>[] getEPRsForService​(<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> serviceName, |
| <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> ip) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Get the endpoint references for a given service. These are the addresses that a client |
| can use to send requests to the given service through this transport.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serviceName</code> - TODO: this is actually not simply the service name!</dd> |
| <dd><code>ip</code> - The host name or IP address of the local host. The implementation should use |
| this information instead of <a href="https://docs.oracle.com/javase/7/docs/api/java/net/InetAddress.html?is-external=true#getLocalHost()" title="class or interface in java.net" class="externalLink"><code>InetAddress.getLocalHost()</code></a>. |
| The value of this parameter may be <code>null</code>, in which case the |
| implementation should use <a href="../util/Utils.html#getIpAddress(org.apache.axis2.engine.AxisConfiguration)"><code>Utils.getIpAddress( |
| org.apache.axis2.engine.AxisConfiguration)</code></a>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array of endpoint references for the given service</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionContext(org.apache.axis2.context.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionContext</h4> |
| <pre class="methodSignature"><a href="../context/SessionContext.html" title="class in org.apache.axis2.context">SessionContext</a> getSessionContext​(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> messageContext)</pre> |
| <div class="block">To get the sessionContext transport dependent manner. So that transport listener |
| can return its own implementation of session managment</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>messageContext</code> - : MessageContext which has all the relavent data</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SessionContext</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="destroy()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre class="methodSignature">void destroy()</pre> |
| </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/TransportListener.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 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: </li> |
| <li>Nested | </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
