blob: 648e81a710243eb39395de3e11abc03b6dc1d418 [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>WSDiscoveryService (Apache CXF JavaDoc 3.1.0 API)</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="WSDiscoveryService (Apache CXF JavaDoc 3.1.0 API)";
}
//-->
</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/WSDiscoveryService.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 class="aboutLanguage"><em>Apache CXF API</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/cxf/ws/discovery/WSDiscoveryClient.html" title="class in org.apache.cxf.ws.discovery"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cxf/ws/discovery/WSDVersion.html" title="class in org.apache.cxf.ws.discovery"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cxf/ws/discovery/WSDiscoveryService.html" target="_top">Frames</a></li>
<li><a href="WSDiscoveryService.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.cxf.ws.discovery</div>
<h2 title="Interface WSDiscoveryService" class="title">Interface WSDiscoveryService</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/cxf/ws/discovery/internal/WSDiscoveryServiceImpl.html" title="class in org.apache.cxf.ws.discovery.internal">WSDiscoveryServiceImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">WSDiscoveryService</span></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="../../../../../org/apache/cxf/ws/discovery/WSDiscoveryClient.html" title="class in org.apache.cxf.ws.discovery">WSDiscoveryClient</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/ws/discovery/WSDiscoveryService.html#getClient()">getClient</a></strong>()</code>
<div class="block">The service requires a WSDiscoveryClient in order to interact with a DiscoveryProxy, send Hello/Bye/etc..</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cxf/ws/discovery/wsdl/HelloType.html" title="class in org.apache.cxf.ws.discovery.wsdl">HelloType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/ws/discovery/WSDiscoveryService.html#register(javax.xml.ws.EndpointReference)">register</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/ws/EndpointReference.html?is-external=true" title="class or interface in javax.xml.ws">EndpointReference</a>&nbsp;ref)</code>
<div class="block">Registers the given EndpointReference with the service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/ws/discovery/WSDiscoveryService.html#register(org.apache.cxf.ws.discovery.wsdl.HelloType)">register</a></strong>(<a href="../../../../../org/apache/cxf/ws/discovery/wsdl/HelloType.html" title="class in org.apache.cxf.ws.discovery.wsdl">HelloType</a>&nbsp;ht)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/ws/discovery/WSDiscoveryService.html#serverStarted(org.apache.cxf.endpoint.Server)">serverStarted</a></strong>(<a href="../../../../../org/apache/cxf/endpoint/Server.html" title="interface in org.apache.cxf.endpoint">Server</a>&nbsp;server)</code>
<div class="block">Utility methods to aid in calling the register/unregister for the appropriate CXF server</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/ws/discovery/WSDiscoveryService.html#serverStopped(org.apache.cxf.endpoint.Server)">serverStopped</a></strong>(<a href="../../../../../org/apache/cxf/endpoint/Server.html" title="interface in org.apache.cxf.endpoint">Server</a>&nbsp;server)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/ws/discovery/WSDiscoveryService.html#unregister(org.apache.cxf.ws.discovery.wsdl.HelloType)">unregister</a></strong>(<a href="../../../../../org/apache/cxf/ws/discovery/wsdl/HelloType.html" title="class in org.apache.cxf.ws.discovery.wsdl">HelloType</a>&nbsp;ht)</code>&nbsp;</td>
</tr>
</table>
</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="register(javax.xml.ws.EndpointReference)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre><a href="../../../../../org/apache/cxf/ws/discovery/wsdl/HelloType.html" title="class in org.apache.cxf.ws.discovery.wsdl">HelloType</a>&nbsp;register(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/ws/EndpointReference.html?is-external=true" title="class or interface in javax.xml.ws">EndpointReference</a>&nbsp;ref)</pre>
<div class="block">Registers the given EndpointReference with the service. Also sends the UDP "Hello"</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ref</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>the HelloType that was sent so it can be used to call unregister</dd></dl>
</li>
</ul>
<a name="register(org.apache.cxf.ws.discovery.wsdl.HelloType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre>void&nbsp;register(<a href="../../../../../org/apache/cxf/ws/discovery/wsdl/HelloType.html" title="class in org.apache.cxf.ws.discovery.wsdl">HelloType</a>&nbsp;ht)</pre>
</li>
</ul>
<a name="unregister(org.apache.cxf.ws.discovery.wsdl.HelloType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unregister</h4>
<pre>void&nbsp;unregister(<a href="../../../../../org/apache/cxf/ws/discovery/wsdl/HelloType.html" title="class in org.apache.cxf.ws.discovery.wsdl">HelloType</a>&nbsp;ht)</pre>
</li>
</ul>
<a name="serverStarted(org.apache.cxf.endpoint.Server)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serverStarted</h4>
<pre>void&nbsp;serverStarted(<a href="../../../../../org/apache/cxf/endpoint/Server.html" title="interface in org.apache.cxf.endpoint">Server</a>&nbsp;server)</pre>
<div class="block">Utility methods to aid in calling the register/unregister for the appropriate CXF server</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>server</code> - </dd></dl>
</li>
</ul>
<a name="serverStopped(org.apache.cxf.endpoint.Server)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serverStopped</h4>
<pre>void&nbsp;serverStopped(<a href="../../../../../org/apache/cxf/endpoint/Server.html" title="interface in org.apache.cxf.endpoint">Server</a>&nbsp;server)</pre>
</li>
</ul>
<a name="getClient()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getClient</h4>
<pre><a href="../../../../../org/apache/cxf/ws/discovery/WSDiscoveryClient.html" title="class in org.apache.cxf.ws.discovery">WSDiscoveryClient</a>&nbsp;getClient()</pre>
<div class="block">The service requires a WSDiscoveryClient in order to interact with a DiscoveryProxy, send Hello/Bye/etc..</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the client being used</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/WSDiscoveryService.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 class="aboutLanguage"><em>Apache CXF API</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/cxf/ws/discovery/WSDiscoveryClient.html" title="class in org.apache.cxf.ws.discovery"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cxf/ws/discovery/WSDVersion.html" title="class in org.apache.cxf.ws.discovery"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cxf/ws/discovery/WSDiscoveryService.html" target="_top">Frames</a></li>
<li><a href="WSDiscoveryService.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>Apache CXF</small></p>
</body>
</html>