| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 --> |
| <title>IDiscoveredEndpointDescriptionFactory (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.osgi.services.remoteserviceadmin, interface: IDiscoveredEndpointDescriptionFactory"> |
| <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}; |
| 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/IDiscoveredEndpointDescriptionFactory.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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.osgi.services.remoteserviceadmin</a></div> |
| <h1 title="Interface IDiscoveredEndpointDescriptionFactory" class="title">Interface IDiscoveredEndpointDescriptionFactory</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="DiscoveredEndpointDescriptionFactory.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin">DiscoveredEndpointDescriptionFactory</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IDiscoveredEndpointDescriptionFactory</span></pre> |
| <div class="block">Factory for creating <a href="DiscoveredEndpointDescription.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin"><code>DiscoveredEndpointDescription</code></a>s. A discovered |
| endpoint description factory is used by a <a href="EndpointDescriptionLocator.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin"><code>EndpointDescriptionLocator</code></a> |
| to convert a service info (discovered by the locator) into a discovered |
| endpoint description (instance of DiscoveredEndpointDescription). This |
| discovered endpoint description is then used by the |
| <a href="EndpointDescriptionLocator.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin"><code>EndpointDescriptionLocator</code></a> to notify endpoint description listeners |
| as per section 122.6 of the <a href="http://www.osgi.org/download/r4v42/r4.enterprise.pdf">OSGi Enterprise |
| Specification</a> OSGi enterprise specification. |
| |
| <p> |
| If no other instances of this service have been registered, a default |
| instance of <a href="DiscoveredEndpointDescriptionFactory.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin"><code>DiscoveredEndpointDescriptionFactory</code></a> will be used by the |
| <a href="EndpointDescriptionLocator.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin"><code>EndpointDescriptionLocator</code></a>. Note that this default instance is |
| registered with the lowest possible priority, so that if other |
| <a href="IDiscoveredEndpointDescriptionFactory.html" title="interface in org.eclipse.ecf.osgi.services.remoteserviceadmin"><code>IDiscoveredEndpointDescriptionFactory</code></a> instances are registered, they |
| will be preferred/used over the default. This means that those wishing to |
| customize/control this process of converting <a href="../../../discovery/IServiceInfo.html" title="interface in org.eclipse.ecf.discovery"><code>IServiceInfo</code></a>s to |
| <a href="DiscoveredEndpointDescription.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin"><code>DiscoveredEndpointDescription</code></a> must |
| create their own implementation of |
| <a href="IDiscoveredEndpointDescriptionFactory.html" title="interface in org.eclipse.ecf.osgi.services.remoteserviceadmin"><code>IDiscoveredEndpointDescriptionFactory</code></a> |
| and register it with the OSGi service registry with a priority |
| ({org.osgi.framework.Constants#SERVICE_RANKING}) higher than |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html?is-external=true#MIN_VALUE" title="class or interface in java.lang" class="externalLink"><code>Integer.MIN_VALUE</code></a> |
| <p> |
| Then at runtime, when needed by the <a href="EndpointDescriptionLocator.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin"><code>EndpointDescriptionLocator</code></a>, the |
| new discovered endpoint description factory will be used.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="IServiceInfoFactory.html" title="interface in org.eclipse.ecf.osgi.services.remoteserviceadmin"><code>IServiceInfoFactory</code></a></dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ========== 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><a href="DiscoveredEndpointDescription.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin">DiscoveredEndpointDescription</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createDiscoveredEndpointDescription(org.eclipse.ecf.discovery.IDiscoveryLocator,org.eclipse.ecf.discovery.IServiceInfo)">createDiscoveredEndpointDescription</a></span>​(<a href="../../../discovery/IDiscoveryLocator.html" title="interface in org.eclipse.ecf.discovery">IDiscoveryLocator</a> locator, |
| <a href="../../../discovery/IServiceInfo.html" title="interface in org.eclipse.ecf.discovery">IServiceInfo</a> discoveredServiceInfo)</code></th> |
| <td class="colLast"> |
| <div class="block">Create an EndpointDescription for a discovered remote service.</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="#removeAllDiscoveredEndpointDescriptions()">removeAllDiscoveredEndpointDescriptions</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Remove all DiscoveredEndpointDescription from this factory.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><a href="DiscoveredEndpointDescription.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin">DiscoveredEndpointDescription</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeDiscoveredEndpointDescription(org.eclipse.ecf.discovery.IDiscoveryLocator,org.eclipse.ecf.discovery.identity.IServiceID)">removeDiscoveredEndpointDescription</a></span>​(<a href="../../../discovery/IDiscoveryLocator.html" title="interface in org.eclipse.ecf.discovery">IDiscoveryLocator</a> locator, |
| <a href="../../../discovery/identity/IServiceID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceID</a> serviceID)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove an EndpointDescription for a previously discovered remote service.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeDiscoveredEndpointDescription(org.osgi.service.remoteserviceadmin.EndpointDescription)">removeDiscoveredEndpointDescription</a></span>​(<a href="../../../../../osgi/service/remoteserviceadmin/EndpointDescription.html" title="class in org.osgi.service.remoteserviceadmin">EndpointDescription</a> endpointDescription)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove the DiscoveredEndpointDescription associated with the given |
| endpointDescription.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ 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="createDiscoveredEndpointDescription(org.eclipse.ecf.discovery.IDiscoveryLocator,org.eclipse.ecf.discovery.IServiceInfo)">createDiscoveredEndpointDescription</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="DiscoveredEndpointDescription.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin">DiscoveredEndpointDescription</a></span> <span class="memberName">createDiscoveredEndpointDescription</span>​(<span class="arguments"><a href="../../../discovery/IDiscoveryLocator.html" title="interface in org.eclipse.ecf.discovery">IDiscoveryLocator</a> locator, |
| <a href="../../../discovery/IServiceInfo.html" title="interface in org.eclipse.ecf.discovery">IServiceInfo</a> discoveredServiceInfo)</span></div> |
| <div class="block">Create an EndpointDescription for a discovered remote service. |
| Implementers of this factory service may return the type of |
| EndpointDescription appropriate for the associated distribution system |
| (e.g. ECFEndpointDescription). Implementers should return |
| <code>null</code> if no notification should occur.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>locator</code> - the locator responsible for the discoveredServiceInfo. Must |
| not be <code>null</code>.</dd> |
| <dd><code>discoveredServiceInfo</code> - the discovered service info. Must not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>DiscoveredEndpointDescription that will be used to notify |
| EndpointListeners about a new EndpointDescription. If |
| <code>null</code> is returned, no notification should be |
| performed by the calling code.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="removeDiscoveredEndpointDescription(org.eclipse.ecf.discovery.IDiscoveryLocator,org.eclipse.ecf.discovery.identity.IServiceID)">removeDiscoveredEndpointDescription</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="DiscoveredEndpointDescription.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin">DiscoveredEndpointDescription</a></span> <span class="memberName">removeDiscoveredEndpointDescription</span>​(<span class="arguments"><a href="../../../discovery/IDiscoveryLocator.html" title="interface in org.eclipse.ecf.discovery">IDiscoveryLocator</a> locator, |
| <a href="../../../discovery/identity/IServiceID.html" title="interface in org.eclipse.ecf.discovery.identity">IServiceID</a> serviceID)</span></div> |
| <div class="block">Remove an EndpointDescription for a previously discovered remote service. |
| Implementers of this factory service may return the type of |
| EndpointDescription appropriate for the associated distribution system |
| (e.g. ECFEndpointDescription). Implementers should return |
| <code>null</code> if no notification should occur.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>locator</code> - the locator responsible for the discoveredServiceInfo. Must |
| not be <code>null</code>.</dd> |
| <dd><code>serviceID</code> - the discovered service ID. Must not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>EndpointDescription that will be used to notify EndpointListeners |
| about an undiscovered EndpointDescription. If <code>null</code> |
| is returned, no notification should be performed by the calling |
| code.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="removeDiscoveredEndpointDescription(org.osgi.service.remoteserviceadmin.EndpointDescription)">removeDiscoveredEndpointDescription</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">removeDiscoveredEndpointDescription</span>​(<span class="arguments"><a href="../../../../../osgi/service/remoteserviceadmin/EndpointDescription.html" title="class in org.osgi.service.remoteserviceadmin">EndpointDescription</a> endpointDescription)</span></div> |
| <div class="block">Remove the DiscoveredEndpointDescription associated with the given |
| endpointDescription.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endpointDescription</code> - that was previously associated with a |
| DiscoveredEndpointDescription (via |
| <a href="#createDiscoveredEndpointDescription(org.eclipse.ecf.discovery.IDiscoveryLocator,org.eclipse.ecf.discovery.IServiceInfo)"><code>createDiscoveredEndpointDescription(IDiscoveryLocator, IServiceInfo)</code></a> |
| to be removed. Must not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if actually removed, <code>false</code> if |
| nothing was removed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="removeAllDiscoveredEndpointDescriptions()">removeAllDiscoveredEndpointDescriptions</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">removeAllDiscoveredEndpointDescriptions</span>()</div> |
| <div class="block">Remove all DiscoveredEndpointDescription from this factory.</div> |
| </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/IDiscoveredEndpointDescriptionFactory.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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> |
