| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 --> |
| <title>IDiscoveryLocator (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, interface: IDiscoveryLocator"> |
| <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 data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":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 = "../../../../"; |
| 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/IDiscoveryLocator.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: </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> |
| <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> <a href="package-summary.html">org.eclipse.ecf.discovery</a></div> |
| <h1 title="Interface IDiscoveryLocator" class="title">Interface IDiscoveryLocator</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code>org.eclipse.core.runtime.IAdaptable</code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="IDiscoveryContainerAdapter.html" title="interface in org.eclipse.ecf.discovery">IDiscoveryContainerAdapter</a></code>, <code><a href="service/IDiscoveryService.html" title="interface in org.eclipse.ecf.discovery.service">IDiscoveryService</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractDiscoveryContainerAdapter.html" title="class in org.eclipse.ecf.discovery">AbstractDiscoveryContainerAdapter</a></code>, <code><a href="../provider/dnssd/DnsSdDiscoveryAdvertiser.html" title="class in org.eclipse.ecf.provider.dnssd">DnsSdDiscoveryAdvertiser</a></code>, <code><a href="../provider/dnssd/DnsSdDiscoveryContainerAdapter.html" title="class in org.eclipse.ecf.provider.dnssd">DnsSdDiscoveryContainerAdapter</a></code>, <code><a href="../provider/dnssd/DnsSdDiscoveryLocator.html" title="class in org.eclipse.ecf.provider.dnssd">DnsSdDiscoveryLocator</a></code>, <code><a href="../provider/jslp/container/JSLPDiscoveryContainer.html" title="class in org.eclipse.ecf.provider.jslp.container">JSLPDiscoveryContainer</a></code>, <code><a href="../provider/zookeeper/core/ZooDiscoveryContainer.html" title="class in org.eclipse.ecf.provider.zookeeper.core">ZooDiscoveryContainer</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IDiscoveryLocator</span> |
| extends org.eclipse.core.runtime.IAdaptable</pre> |
| <div class="block">Entry point discovery locator. This interface exposes the ability to |
| add/remove listeners for newly discovered services and service types, and get |
| (synch) and request (asynchronous) service info from a remote service |
| provider. |
| <p> |
| This interface can be used by container provider implementations as an |
| adapter so that calls to IContainer.getAdapter(IDiscoveryLocator.class) will |
| return a non-null instance of a class that implements this interface. Clients |
| can then proceed to use this interface to interact with the given discovery |
| implementation.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </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"> </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_NAME">CONTAINER_NAME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The name of the discovery container under which it is registered with the |
| OSGi runtime as a service property</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="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <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> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addServiceListener(org.eclipse.ecf.discovery.identity.IServiceTypeID,org.eclipse.ecf.discovery.IServiceListener)">addServiceListener</a></span>​(<a href="identity/IServiceTypeID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceTypeID</a> type, |
| <a href="IServiceListener.html" title="interface in org.eclipse.ecf.discovery">IServiceListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Add a service listener.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addServiceListener(org.eclipse.ecf.discovery.IServiceListener)">addServiceListener</a></span>​(<a href="IServiceListener.html" title="interface in org.eclipse.ecf.discovery">IServiceListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Add a service listener.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addServiceTypeListener(org.eclipse.ecf.discovery.IServiceTypeListener)">addServiceTypeListener</a></span>​(<a href="IServiceTypeListener.html" title="interface in org.eclipse.ecf.discovery">IServiceTypeListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Add a service type listener.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>org.eclipse.equinox.concurrent.future.IFuture</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAsyncServiceInfo(org.eclipse.ecf.discovery.identity.IServiceID)">getAsyncServiceInfo</a></span>​(<a href="identity/IServiceID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceID</a> aServiceID)</code></th> |
| <td class="colLast"> |
| <div class="block">Asynchronously retrieve info about the service</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>org.eclipse.equinox.concurrent.future.IFuture</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAsyncServices()">getAsyncServices</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Asynchronously get service info about all known services</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>org.eclipse.equinox.concurrent.future.IFuture</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAsyncServices(org.eclipse.ecf.discovery.identity.IServiceTypeID)">getAsyncServices</a></span>​(<a href="identity/IServiceTypeID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceTypeID</a> aServiceTypeID)</code></th> |
| <td class="colLast"> |
| <div class="block">Asynchronously get service info about all known services of given service |
| type</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>org.eclipse.equinox.concurrent.future.IFuture</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAsyncServiceTypes()">getAsyncServiceTypes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Asynchronously get service info about all known services of given service |
| type</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code><a href="IServiceInfo.html" title="interface in org.eclipse.ecf.discovery">IServiceInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServiceInfo(org.eclipse.ecf.discovery.identity.IServiceID)">getServiceInfo</a></span>​(<a href="identity/IServiceID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceID</a> aServiceID)</code></th> |
| <td class="colLast"> |
| <div class="block">Synchronously retrieve info about the service</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code><a href="IServiceInfo.html" title="interface in org.eclipse.ecf.discovery">IServiceInfo</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServices()">getServices</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Synchronously get service info about all known services</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code><a href="IServiceInfo.html" title="interface in org.eclipse.ecf.discovery">IServiceInfo</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServices(org.eclipse.ecf.discovery.identity.IServiceTypeID)">getServices</a></span>​(<a href="identity/IServiceTypeID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceTypeID</a> aServiceTypeID)</code></th> |
| <td class="colLast"> |
| <div class="block">Synchronously get service info about all known services of given service |
| type</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code><a href="../core/identity/Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServicesNamespace()">getServicesNamespace</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get a Namespace for services associated with this discovery container |
| adapter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code><a href="identity/IServiceTypeID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceTypeID</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServiceTypes()">getServiceTypes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Synchronously get service info about all known services of given service |
| type</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code><a href="IServiceInfo.html" title="interface in org.eclipse.ecf.discovery">IServiceInfo</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#purgeCache()">purgeCache</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Purges the underlying IServiceInfo cache if available in the current |
| provider</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeServiceListener(org.eclipse.ecf.discovery.identity.IServiceTypeID,org.eclipse.ecf.discovery.IServiceListener)">removeServiceListener</a></span>​(<a href="identity/IServiceTypeID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceTypeID</a> type, |
| <a href="IServiceListener.html" title="interface in org.eclipse.ecf.discovery">IServiceListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove a service listener.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeServiceListener(org.eclipse.ecf.discovery.IServiceListener)">removeServiceListener</a></span>​(<a href="IServiceListener.html" title="interface in org.eclipse.ecf.discovery">IServiceListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove a service listener.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeServiceTypeListener(org.eclipse.ecf.discovery.IServiceTypeListener)">removeServiceTypeListener</a></span>​(<a href="IServiceTypeListener.html" title="interface in org.eclipse.ecf.discovery">IServiceTypeListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove a service type listener.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.eclipse.core.runtime.IAdaptable</h3> |
| <a id="methods.inherited.from.class.org.eclipse.core.runtime.IAdaptable"> |
| <!-- --> |
| </a><code>getAdapter</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_NAME">CONTAINER_NAME</a></h3> |
| <div class="memberSignature"><span class="modifiers">static final</span> <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> <span class="memberName">CONTAINER_NAME</span></div> |
| <div class="block">The name of the discovery container under which it is registered with the |
| OSGi runtime as a service property</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.ecf.discovery.IDiscoveryLocator.CONTAINER_NAME">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getServiceInfo(org.eclipse.ecf.discovery.identity.IServiceID)">getServiceInfo</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="IServiceInfo.html" title="interface in org.eclipse.ecf.discovery">IServiceInfo</a></span> <span class="memberName">getServiceInfo</span>​(<span class="arguments"><a href="identity/IServiceID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceID</a> aServiceID)</span></div> |
| <div class="block">Synchronously retrieve info about the service</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>aServiceID</code> - IServiceID of the service to get info about. Must not be |
| <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IServiceInfo the service info retrieved. <code>null</code> if no |
| information retrievable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getServices()">getServices</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="IServiceInfo.html" title="interface in org.eclipse.ecf.discovery">IServiceInfo</a>[]</span> <span class="memberName">getServices</span>()</div> |
| <div class="block">Synchronously get service info about all known services</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IServiceInfo[] the resulting array of service info instances. |
| Will not be <code>null</code>. May be of length 0.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getServices(org.eclipse.ecf.discovery.identity.IServiceTypeID)">getServices</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="IServiceInfo.html" title="interface in org.eclipse.ecf.discovery">IServiceInfo</a>[]</span> <span class="memberName">getServices</span>​(<span class="arguments"><a href="identity/IServiceTypeID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceTypeID</a> aServiceTypeID)</span></div> |
| <div class="block">Synchronously get service info about all known services of given service |
| type</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>aServiceTypeID</code> - IServiceTypeID defining the type of service we are interested |
| in getting service info about. Must not be <code>null</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IServiceInfo[] the resulting array of service info instances. |
| Will not be <code>null</code>. May be of length 0.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getServiceTypes()">getServiceTypes</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="identity/IServiceTypeID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceTypeID</a>[]</span> <span class="memberName">getServiceTypes</span>()</div> |
| <div class="block">Synchronously get service info about all known services of given service |
| type</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IServiceTypeID[] the resulting array of service type IDs. Will |
| not be <code>null</code>. May be of length 0.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getServicesNamespace()">getServicesNamespace</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../core/identity/Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></span> <span class="memberName">getServicesNamespace</span>()</div> |
| <div class="block">Get a Namespace for services associated with this discovery container |
| adapter. The given Namespace may be used via IServiceIDFactory to create |
| IServiceIDs rather than simple IDs. For example: |
| |
| <pre> |
| IServiceID serviceID = ServiceIDFactory.getDefault().createServiceID(container.getServicesNamespace(), |
| serviceType, serviceName); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Namespace for creating service IDs. Will not be <code>null</code> |
| .</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="purgeCache()">purgeCache</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="IServiceInfo.html" title="interface in org.eclipse.ecf.discovery">IServiceInfo</a>[]</span> <span class="memberName">purgeCache</span>()</div> |
| <div class="block">Purges the underlying IServiceInfo cache if available in the current |
| provider</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The previous cache content</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addServiceListener(org.eclipse.ecf.discovery.IServiceListener)">addServiceListener</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">addServiceListener</span>​(<span class="arguments"><a href="IServiceListener.html" title="interface in org.eclipse.ecf.discovery">IServiceListener</a> listener)</span></div> |
| <div class="block">Add a service listener. The given listener will have its method called |
| when a service is discovered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - IServiceListener to be notified. Must not be <code>null</code> |
| .</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addServiceListener(org.eclipse.ecf.discovery.identity.IServiceTypeID,org.eclipse.ecf.discovery.IServiceListener)">addServiceListener</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">addServiceListener</span>​(<span class="arguments"><a href="identity/IServiceTypeID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceTypeID</a> type, |
| <a href="IServiceListener.html" title="interface in org.eclipse.ecf.discovery">IServiceListener</a> listener)</span></div> |
| <div class="block">Add a service listener. The given listener will have its method called |
| when a service with a type matching that specified by the first parameter |
| is discovered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - String type to listen for. Must not be <code>null</code>. Must |
| be formatted according to this specific IDiscoveryContainer</dd> |
| <dd><code>listener</code> - IServiceListener to be notified. Must not be <code>null</code> |
| .</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addServiceTypeListener(org.eclipse.ecf.discovery.IServiceTypeListener)">addServiceTypeListener</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">addServiceTypeListener</span>​(<span class="arguments"><a href="IServiceTypeListener.html" title="interface in org.eclipse.ecf.discovery">IServiceTypeListener</a> listener)</span></div> |
| <div class="block">Add a service type listener. The given listener will have its method |
| called when a service type is discovered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the listener to be notified. Must not be <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="removeServiceListener(org.eclipse.ecf.discovery.IServiceListener)">removeServiceListener</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">removeServiceListener</span>​(<span class="arguments"><a href="IServiceListener.html" title="interface in org.eclipse.ecf.discovery">IServiceListener</a> listener)</span></div> |
| <div class="block">Remove a service listener. Remove the listener from this container</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - IServiceListener listener to be removed. Must not be |
| <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="removeServiceListener(org.eclipse.ecf.discovery.identity.IServiceTypeID,org.eclipse.ecf.discovery.IServiceListener)">removeServiceListener</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">removeServiceListener</span>​(<span class="arguments"><a href="identity/IServiceTypeID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceTypeID</a> type, |
| <a href="IServiceListener.html" title="interface in org.eclipse.ecf.discovery">IServiceListener</a> listener)</span></div> |
| <div class="block">Remove a service listener. Remove the listener associated with the type |
| specified by the first parameter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - String of the desired type to remove the listener. Must not be |
| <code>null</code>. Must be formatted according to this |
| specific IDiscoveryContainer</dd> |
| <dd><code>listener</code> - IServiceListener listener to be removed. Must not be |
| <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="removeServiceTypeListener(org.eclipse.ecf.discovery.IServiceTypeListener)">removeServiceTypeListener</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">removeServiceTypeListener</span>​(<span class="arguments"><a href="IServiceTypeListener.html" title="interface in org.eclipse.ecf.discovery">IServiceTypeListener</a> listener)</span></div> |
| <div class="block">Remove a service type listener. Remove the type listener.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - IServiceTypeListener to be removed. Must not be |
| <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getAsyncServiceInfo(org.eclipse.ecf.discovery.identity.IServiceID)">getAsyncServiceInfo</a></h3> |
| <div class="memberSignature"><span class="returnType">org.eclipse.equinox.concurrent.future.IFuture</span> <span class="memberName">getAsyncServiceInfo</span>​(<span class="arguments"><a href="identity/IServiceID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceID</a> aServiceID)</span></div> |
| <div class="block">Asynchronously retrieve info about the service</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>aServiceID</code> - IServiceID of the service to get info about. Must not be |
| <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IFuture a future status wrapping an IServiceInfo or |
| <code>null</code> if no information retrievable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getAsyncServices()">getAsyncServices</a></h3> |
| <div class="memberSignature"><span class="returnType">org.eclipse.equinox.concurrent.future.IFuture</span> <span class="memberName">getAsyncServices</span>()</div> |
| <div class="block">Asynchronously get service info about all known services</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IFuture wrapping an IServiceTypeID[]. The resulting array of |
| service type IDs will not be <code>null</code>. May be of length |
| 0.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getAsyncServices(org.eclipse.ecf.discovery.identity.IServiceTypeID)">getAsyncServices</a></h3> |
| <div class="memberSignature"><span class="returnType">org.eclipse.equinox.concurrent.future.IFuture</span> <span class="memberName">getAsyncServices</span>​(<span class="arguments"><a href="identity/IServiceTypeID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceTypeID</a> aServiceTypeID)</span></div> |
| <div class="block">Asynchronously get service info about all known services of given service |
| type</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>aServiceTypeID</code> - IServiceTypeID defining the type of service we are interested |
| in getting service info about. Must not be <code>null</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IFuture wrapping an IServiceTypeID[]. The resulting array of |
| service type IDs will not be <code>null</code>. May be of length |
| 0.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getAsyncServiceTypes()">getAsyncServiceTypes</a></h3> |
| <div class="memberSignature"><span class="returnType">org.eclipse.equinox.concurrent.future.IFuture</span> <span class="memberName">getAsyncServiceTypes</span>()</div> |
| <div class="block">Asynchronously get service info about all known services of given service |
| type</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IFuture wrapping an IServiceTypeID[]. The resulting array of |
| service type IDs will not be <code>null</code>. May be of length |
| 0.</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/IDiscoveryLocator.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: </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> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
