Google Git
Sign in
apache / axis-site / 8c17319ae4c4129c6d30d33e4b59d5b23345ea24 / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / transport / base / datagram / DatagramEndpoint.html
blob: 7e5d3dcf7aea1879ec104f8b7c140cfda6d3b899 [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>DatagramEndpoint (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="DatagramEndpoint (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/DatagramEndpoint.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/base/datagram/DatagramDispatcherCallback.html" title="interface in org.apache.axis2.transport.base.datagram"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/axis2/transport/base/datagram/DatagramOutTransportInfo.html" title="class in org.apache.axis2.transport.base.datagram"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/axis2/transport/base/datagram/DatagramEndpoint.html" target="_top">Frames</a></li>
<li><a href="DatagramEndpoint.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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.base.datagram</div>
<h2 title="Class DatagramEndpoint" class="title">Class DatagramEndpoint</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.base.datagram.DatagramEndpoint</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../org/apache/axis2/transport/udp/Endpoint.html" title="class in org.apache.axis2.transport.udp">Endpoint</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">DatagramEndpoint</span>
extends <a href="../../../../../../org/apache/axis2/transport/base/ProtocolEndpoint.html" title="class in org.apache.axis2.transport.base">ProtocolEndpoint</a></pre>
<div class="block">Endpoint description.
This class is used by the transport to store information
about an endpoint, e.g. the Axis service it is bound to.
Transports extend this abstract class to store additional
transport specific information, such as the port number
the transport listens on.</div>
</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">&nbsp;</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/base/datagram/DatagramEndpoint.html#DatagramEndpoint()">DatagramEndpoint</a></strong>()</code>&nbsp;</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="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/base/datagram/DatagramEndpoint.html#getContentType()">getContentType</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/axis2/transport/base/MetricsCollector.html" title="class in org.apache.axis2.transport.base">MetricsCollector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/transport/base/datagram/DatagramEndpoint.html#getMetrics()">getMetrics</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/transport/base/datagram/DatagramEndpoint.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>&nbsp;params)</code>
<div class="block">Configure the endpoint based on the provided parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/transport/base/datagram/DatagramEndpoint.html#setMetrics(org.apache.axis2.transport.base.MetricsCollector)">setMetrics</a></strong>(<a href="../../../../../../org/apache/axis2/transport/base/MetricsCollector.html" title="class in org.apache.axis2.transport.base">MetricsCollector</a>&nbsp;metrics)</code>&nbsp;</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&nbsp;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#getEndpointReferences(org.apache.axis2.description.AxisService, java.lang.String)">getEndpointReferences</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&nbsp;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="DatagramEndpoint()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DatagramEndpoint</h4>
<pre>public&nbsp;DatagramEndpoint()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getContentType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentType</h4>
<pre>public&nbsp;<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>&nbsp;getContentType()</pre>
</li>
</ul>
<a name="getMetrics()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetrics</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/axis2/transport/base/MetricsCollector.html" title="class in org.apache.axis2.transport.base">MetricsCollector</a>&nbsp;getMetrics()</pre>
</li>
</ul>
<a name="setMetrics(org.apache.axis2.transport.base.MetricsCollector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMetrics</h4>
<pre>public&nbsp;void&nbsp;setMetrics(<a href="../../../../../../org/apache/axis2/transport/base/MetricsCollector.html" title="class in org.apache.axis2.transport.base">MetricsCollector</a>&nbsp;metrics)</pre>
</li>
</ul>
<a name="loadConfiguration(org.apache.axis2.description.ParameterInclude)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>loadConfiguration</h4>
<pre>public&nbsp;boolean&nbsp;loadConfiguration(<a href="../../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a>&nbsp;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:&nbsp;<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>&nbsp;in class&nbsp;<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>
</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/DatagramEndpoint.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/base/datagram/DatagramDispatcherCallback.html" title="interface in org.apache.axis2.transport.base.datagram"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/axis2/transport/base/datagram/DatagramOutTransportInfo.html" title="class in org.apache.axis2.transport.base.datagram"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/axis2/transport/base/datagram/DatagramEndpoint.html" target="_top">Frames</a></li>
<li><a href="DatagramEndpoint.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>