blob: 2b2aa59618f905a614d30d63bfff30acbb5038c7 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 -->
<title>IDiscoveryService (Eclipse Communication Framework (ECF) 3.14.22 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta name="dc.created" content="2021-06-15">
<meta name="description" content="declaration: package: org.eclipse.ecf.discovery.service, interface: IDiscoveryService">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= 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/IDiscoveryService.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
</nav>
</header>
<div class="flexContent">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.ecf.discovery.service</a></div>
<h1 title="Interface IDiscoveryService" class="title">Interface IDiscoveryService</h1>
</div>
<div class="contentContainer">
<section class="description">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code>org.eclipse.core.runtime.IAdaptable</code>, <code><a href="../IDiscoveryAdvertiser.html" title="interface in org.eclipse.ecf.discovery">IDiscoveryAdvertiser</a></code>, <code><a href="../IDiscoveryContainerAdapter.html" title="interface in org.eclipse.ecf.discovery">IDiscoveryContainerAdapter</a></code>, <code><a href="../IDiscoveryLocator.html" title="interface in org.eclipse.ecf.discovery">IDiscoveryLocator</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../provider/jslp/container/JSLPDiscoveryContainer.html" title="class in org.eclipse.ecf.provider.jslp.container">JSLPDiscoveryContainer</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">IDiscoveryService</span>
extends <a href="../IDiscoveryContainerAdapter.html" title="interface in org.eclipse.ecf.discovery">IDiscoveryContainerAdapter</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use IDiscoveryLocator and IDiscoveryContainer instead</div>
</div>
<div class="block">OSGI discovery service interface. This interface should be registered
by providers when they wish to expose discovery services to OSGI
service clients.</div>
</section>
<section class="summary">
<ul class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<li class="blockList">
<section class="fieldSummary"><a id="field.summary">
<!-- -->
</a>
<h2>Field Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<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>
</thead>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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="#CONTAINER_ID">CONTAINER_ID</a></span></code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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="#CONTAINER_NAME">CONTAINER_NAME</a></span></code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">The name of the discovery container under which it is registered with the OSGi runtime as a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Properties</code></a></div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;org.eclipse.core.runtime.IAdaptable</h3>
<a id="methods.inherited.from.class.org.eclipse.core.runtime.IAdaptable">
<!-- -->
</a><code>getAdapter</code></div>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;org.eclipse.ecf.discovery.<a href="../IDiscoveryAdvertiser.html" title="interface in org.eclipse.ecf.discovery">IDiscoveryAdvertiser</a></h3>
<a id="methods.inherited.from.class.org.eclipse.ecf.discovery.IDiscoveryAdvertiser">
<!-- -->
</a><code><a href="../IDiscoveryAdvertiser.html#getServicesNamespace()">getServicesNamespace</a>, <a href="../IDiscoveryAdvertiser.html#registerService(org.eclipse.ecf.discovery.IServiceInfo)">registerService</a>, <a href="../IDiscoveryAdvertiser.html#unregisterAllServices()">unregisterAllServices</a>, <a href="../IDiscoveryAdvertiser.html#unregisterService(org.eclipse.ecf.discovery.IServiceInfo)">unregisterService</a></code></div>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;org.eclipse.ecf.discovery.<a href="../IDiscoveryLocator.html" title="interface in org.eclipse.ecf.discovery">IDiscoveryLocator</a></h3>
<a id="methods.inherited.from.class.org.eclipse.ecf.discovery.IDiscoveryLocator">
<!-- -->
</a><code><a href="../IDiscoveryLocator.html#addServiceListener(org.eclipse.ecf.discovery.identity.IServiceTypeID,org.eclipse.ecf.discovery.IServiceListener)">addServiceListener</a>, <a href="../IDiscoveryLocator.html#addServiceListener(org.eclipse.ecf.discovery.IServiceListener)">addServiceListener</a>, <a href="../IDiscoveryLocator.html#addServiceTypeListener(org.eclipse.ecf.discovery.IServiceTypeListener)">addServiceTypeListener</a>, <a href="../IDiscoveryLocator.html#getAsyncServiceInfo(org.eclipse.ecf.discovery.identity.IServiceID)">getAsyncServiceInfo</a>, <a href="../IDiscoveryLocator.html#getAsyncServices()">getAsyncServices</a>, <a href="../IDiscoveryLocator.html#getAsyncServices(org.eclipse.ecf.discovery.identity.IServiceTypeID)">getAsyncServices</a>, <a href="../IDiscoveryLocator.html#getAsyncServiceTypes()">getAsyncServiceTypes</a>, <a href="../IDiscoveryLocator.html#getServiceInfo(org.eclipse.ecf.discovery.identity.IServiceID)">getServiceInfo</a>, <a href="../IDiscoveryLocator.html#getServices()">getServices</a>, <a href="../IDiscoveryLocator.html#getServices(org.eclipse.ecf.discovery.identity.IServiceTypeID)">getServices</a>, <a href="../IDiscoveryLocator.html#getServicesNamespace()">getServicesNamespace</a>, <a href="../IDiscoveryLocator.html#getServiceTypes()">getServiceTypes</a>, <a href="../IDiscoveryLocator.html#purgeCache()">purgeCache</a>, <a href="../IDiscoveryLocator.html#removeServiceListener(org.eclipse.ecf.discovery.identity.IServiceTypeID,org.eclipse.ecf.discovery.IServiceListener)">removeServiceListener</a>, <a href="../IDiscoveryLocator.html#removeServiceListener(org.eclipse.ecf.discovery.IServiceListener)">removeServiceListener</a>, <a href="../IDiscoveryLocator.html#removeServiceTypeListener(org.eclipse.ecf.discovery.IServiceTypeListener)">removeServiceTypeListener</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<li class="blockList">
<section class="fieldDetails"><a id="field.detail">
<!-- -->
</a>
<h2>Field Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="CONTAINER_ID">CONTAINER_ID</a></h3>
<div class="memberSignature"><span class="modifiers">static final</span>&nbsp;<span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span>&nbsp;<span class="memberName">CONTAINER_ID</span></div>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.ecf.discovery.service.IDiscoveryService.CONTAINER_ID">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="CONTAINER_NAME">CONTAINER_NAME</a></h3>
<div class="memberSignature"><span class="modifiers">static final</span>&nbsp;<span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span>&nbsp;<span class="memberName">CONTAINER_NAME</span></div>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">The name of the discovery container under which it is registered with the OSGi runtime as a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Properties</code></a></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.ecf.discovery.service.IDiscoveryService.CONTAINER_NAME">Constant Field Values</a></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<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/IDiscoveryService.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>