blob: 7606603e0dd4c7d9174bc2098a5b317e40ef21bf [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>IHostContainerSelector (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: IHostContainerSelector">
<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};
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/IHostContainerSelector.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>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>
<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.osgi.services.remoteserviceadmin</a></div>
<h1 title="Interface IHostContainerSelector" class="title">Interface IHostContainerSelector</h1>
</div>
<div class="contentContainer">
<section class="description">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="HostContainerSelector.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin">HostContainerSelector</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">IHostContainerSelector</span></pre>
<div class="block">Host container selector service contract. When an ECF RemoteServiceAdmin
instance is asked to import a service (i.e. via
<a href="RemoteServiceAdmin.html#exportService(org.osgi.framework.ServiceReference,java.util.Map)"><code>RemoteServiceAdmin.exportService(ServiceReference, java.util.Map)</code></a> ),
the RSA first gets an instance of this service via the service registry, and
then uses it to select an array of ECF host container instances by calling
selectHostContainers.
<p>
The <a href="../../../remoteservice/IRemoteServiceContainer.html" title="interface in org.eclipse.ecf.remoteservice"><code>IRemoteServiceContainer</code></a> array returned is then used to actually
export the remote service (typically via
<a href="../../../remoteservice/IRemoteServiceContainerAdapter.html#registerRemoteService(java.lang.String%5B%5D,java.lang.Object,java.util.Dictionary)"><code>IRemoteServiceContainerAdapter.registerRemoteService(String[], Object, java.util.Dictionary)</code></a>
<p>
If no other instances of this service have been registered, a default
instance of <a href="HostContainerSelector.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin"><code>HostContainerSelector</code></a> will be used. Note that this
default instance is registered with the lowest possible priority, so that if
other <a href="IHostContainerSelector.html" title="interface in org.eclipse.ecf.osgi.services.remoteserviceadmin"><code>IHostContainerSelector</code></a> instances are registered, they will be
preferred/used over the default.</div>
</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="../../../remoteservice/IRemoteServiceContainer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainer</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectHostContainers(org.osgi.framework.ServiceReference,java.util.Map,java.lang.String%5B%5D,java.lang.String%5B%5D,java.lang.String%5B%5D)">selectHostContainers</a></span>&#8203;(<a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/ServiceReference.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">ServiceReference</a>&nbsp;serviceReference,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<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>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;overridingProperties,
<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>[]&nbsp;exportedInterfaces,
<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>[]&nbsp;exportedConfigs,
<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>[]&nbsp;serviceIntents)</code></th>
<td class="colLast">
<div class="block">Select host containers to use to export a remote service.</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="selectHostContainers(org.osgi.framework.ServiceReference,java.util.Map,java.lang.String[],java.lang.String[],java.lang.String[])">selectHostContainers</a></h3>
<div class="memberSignature"><span class="returnType"><a href="../../../remoteservice/IRemoteServiceContainer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainer</a>[]</span>&nbsp;<span class="memberName">selectHostContainers</span>&#8203;(<span class="arguments"><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/ServiceReference.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">ServiceReference</a>&nbsp;serviceReference,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<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>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;overridingProperties,
<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>[]&nbsp;exportedInterfaces,
<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>[]&nbsp;exportedConfigs,
<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>[]&nbsp;serviceIntents)</span>
throws <span class="exceptions"><a href="SelectContainerException.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin">SelectContainerException</a></span></div>
<div class="block">Select host containers to use to export a remote service.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serviceReference</code> - the service reference given by the
<a href="RemoteServiceAdmin.html#exportService(org.osgi.framework.ServiceReference,java.util.Map)"><code>RemoteServiceAdmin.exportService(ServiceReference, java.util.Map)</code></a></dd>
<dd><code>overridingProperties</code> - the map portion given by the
<a href="RemoteServiceAdmin.html#exportService(org.osgi.framework.ServiceReference,java.util.Map)"><code>RemoteServiceAdmin.exportService(ServiceReference, java.util.Map)</code></a></dd>
<dd><code>exportedInterfaces</code> - the exportedInterfaces (typically associated with
<a href="../../../../../osgi/service/remoteserviceadmin/RemoteConstants.html#SERVICE_EXPORTED_INTERFACES"><code>RemoteConstants.SERVICE_EXPORTED_INTERFACES</code></a>
). Will not be <code>null</code>.</dd>
<dd><code>exportedConfigs</code> - the exportedConfigs (typically associated with
<a href="../../../../../osgi/service/remoteserviceadmin/RemoteConstants.html#SERVICE_EXPORTED_CONFIGS"><code>RemoteConstants.SERVICE_EXPORTED_CONFIGS</code></a>
). May be <code>null</code>.</dd>
<dd><code>serviceIntents</code> - the service intents (typically associated with
<a href="../../../../../osgi/service/remoteserviceadmin/RemoteConstants.html#SERVICE_EXPORTED_INTENTS"><code>RemoteConstants.SERVICE_EXPORTED_INTENTS</code></a>
and
<a href="../../../../../osgi/service/remoteserviceadmin/RemoteConstants.html#SERVICE_EXPORTED_INTENTS_EXTRA"><code>RemoteConstants.SERVICE_EXPORTED_INTENTS_EXTRA</code></a>
). May be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IRemoteServiceContainer[] of remote service containers that
should be used to export the given remote service (typically via
<a href="../../../remoteservice/IRemoteServiceContainerAdapter.html#registerRemoteService(java.lang.String%5B%5D,java.lang.Object,java.util.Dictionary)"><code>IRemoteServiceContainerAdapter.registerRemoteService(String[], Object, java.util.Dictionary)</code></a>
). Will not be <code>null</code>, but may be empty array.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SelectContainerException.html" title="class in org.eclipse.ecf.osgi.services.remoteserviceadmin">SelectContainerException</a></code> - thrown if the host container selection or
creation/configuration fails.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.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/IHostContainerSelector.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>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>
</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>