| <!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>TCPEndpoint (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="TCPEndpoint (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/TCPEndpoint.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/tcp/TCPConstants.html" title="class in org.apache.axis2.transport.tcp"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/axis2/transport/tcp/TCPOutTransportInfo.html" title="class in org.apache.axis2.transport.tcp"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/axis2/transport/tcp/TCPEndpoint.html" target="_top">Frames</a></li> |
| <li><a href="TCPEndpoint.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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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.tcp</div> |
| <h2 title="Class TCPEndpoint" class="title">Class TCPEndpoint</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html" title="class in org.apache.axis2.transport.base">org.apache.axis2.transport.base.ProtocolEndpoint</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.axis2.transport.tcp.TCPEndpoint</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">TCPEndpoint</span> |
| extends <a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html" title="class in org.apache.axis2.transport.base">ProtocolEndpoint</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/axis2/transport/tcp/TCPEndpoint.html#TCPEndpoint()">TCPEndpoint</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/axis2/transport/tcp/TCPEndpoint.html#TCPEndpoint(java.lang.String, int, int)">TCPEndpoint</a></strong>(<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> host, |
| int port, |
| int backlog)</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>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/tcp/TCPEndpoint.html#getBacklog()">getBacklog</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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/tcp/TCPEndpoint.html#getContentType()">getContentType</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/axis2/addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/tcp/TCPEndpoint.html#getEndpointReferences(org.apache.axis2.description.AxisService, java.lang.String)">getEndpointReferences</a></strong>(<a href="../../../../../org/apache/axis2/description/AxisService.html" title="class in org.apache.axis2.description">AxisService</a> service, |
| <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> ip)</code> |
| <div class="block">Get the endpoint references for this protocol endpoint.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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/tcp/TCPEndpoint.html#getHost()">getHost</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/tcp/TCPEndpoint.html#getPort()">getPort</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/tcp/TCPEndpoint.html#loadConfiguration(org.apache.axis2.description.ParameterInclude)">loadConfiguration</a></strong>(<a href="../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a> params)</code> |
| <div class="block">Configure the endpoint based on the provided parameters.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.axis2.transport.base.ProtocolEndpoint"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.axis2.transport.base.<a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html" title="class in org.apache.axis2.transport.base">ProtocolEndpoint</a></h3> |
| <code><a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html#createMessageContext()">createMessageContext</a>, <a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html#getConfigurationContext()">getConfigurationContext</a>, <a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html#getDescription()">getDescription</a>, <a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html#getListener()">getListener</a>, <a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html#getService()">getService</a>, <a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html#getServiceName()">getServiceName</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TCPEndpoint()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TCPEndpoint</h4> |
| <pre>public TCPEndpoint()</pre> |
| </li> |
| </ul> |
| <a name="TCPEndpoint(java.lang.String, int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TCPEndpoint</h4> |
| <pre>public TCPEndpoint(<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> host, |
| int port, |
| int backlog)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getPort()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPort</h4> |
| <pre>public int getPort()</pre> |
| </li> |
| </ul> |
| <a name="getHost()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHost</h4> |
| <pre>public <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> getHost()</pre> |
| </li> |
| </ul> |
| <a name="getBacklog()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBacklog</h4> |
| <pre>public int getBacklog()</pre> |
| </li> |
| </ul> |
| <a name="getContentType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentType</h4> |
| <pre>public <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> getContentType()</pre> |
| </li> |
| </ul> |
| <a name="loadConfiguration(org.apache.axis2.description.ParameterInclude)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadConfiguration</h4> |
| <pre>public boolean loadConfiguration(<a href="../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a> params) |
| throws <a href="../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html#loadConfiguration(org.apache.axis2.description.ParameterInclude)">ProtocolEndpoint</a></code></strong></div> |
| <div class="block">Configure the endpoint based on the provided parameters. |
| If no relevant parameters are found, the implementation should |
| return <code>false</code>. An exception should only be thrown if there is an |
| error or inconsistency in the parameters.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html#loadConfiguration(org.apache.axis2.description.ParameterInclude)">loadConfiguration</a></code> in class <code><a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html" title="class in org.apache.axis2.transport.base">ProtocolEndpoint</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>params</code> - The source of the parameters to configure the |
| endpoint. If the parameters are defined on |
| a service, this will be an <a href="../../../../../org/apache/axis2/description/AxisService.html" title="class in org.apache.axis2.description"><code>AxisService</code></a> |
| instance.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the parameters contained the required configuration |
| information and the endpoint has been configured, <code>false</code> if |
| the no configuration for the endpoint is present in the parameters</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> - if configuration information is present, but there is an |
| error or inconsistency in the parameters</dd></dl> |
| </li> |
| </ul> |
| <a name="getEndpointReferences(org.apache.axis2.description.AxisService, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getEndpointReferences</h4> |
| <pre>public <a href="../../../../../org/apache/axis2/addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a>[] getEndpointReferences(<a href="../../../../../org/apache/axis2/description/AxisService.html" title="class in org.apache.axis2.description">AxisService</a> service, |
| <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> ip) |
| throws <a href="../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html#getEndpointReferences(org.apache.axis2.description.AxisService, java.lang.String)">ProtocolEndpoint</a></code></strong></div> |
| <div class="block">Get the endpoint references for this protocol endpoint.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html#getEndpointReferences(org.apache.axis2.description.AxisService, java.lang.String)">getEndpointReferences</a></code> in class <code><a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html" title="class in org.apache.axis2.transport.base">ProtocolEndpoint</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>service</code> - The service to build the EPR for. If <a href="../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html#getService()"><code>ProtocolEndpoint.getService()</code></a> returns |
| a non null value, then it has the same value as this parameter, which |
| is never null.</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="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/InetAddress.html?is-external=true#getLocalHost()" title="class or interface in java.net"><code>InetAddress.getLocalHost()</code></a>. |
| The value of this parameter may be <code>null</code>, in which case the |
| implementation should use <a href="../../../../../org/apache/axis2/util/Utils.html#getIpAddress(org.apache.axis2.engine.AxisConfiguration)"><code>Utils.getIpAddress( |
| org.apache.axis2.engine.AxisConfiguration)</code></a>.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an array of endpoint references</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/axis2/transport/TransportListener.html#getEPRsForService(java.lang.String, java.lang.String)"><code>TransportListener.getEPRsForService(String, String)</code></a></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/TCPEndpoint.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/tcp/TCPConstants.html" title="class in org.apache.axis2.transport.tcp"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/axis2/transport/tcp/TCPOutTransportInfo.html" title="class in org.apache.axis2.transport.tcp"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/axis2/transport/tcp/TCPEndpoint.html" target="_top">Frames</a></li> |
| <li><a href="TCPEndpoint.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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |