| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 --> |
| <title>AbstractClientContainer (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.remoteservice.client, class: AbstractClientContainer"> |
| <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":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":6,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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/AbstractClientContainer.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </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.remoteservice.client</a></div> |
| <h1 title="Class AbstractClientContainer" class="title">Class AbstractClientContainer</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a> |
| <div class="inheritance"><a href="../../core/AbstractContainer.html" title="class in org.eclipse.ecf.core">org.eclipse.ecf.core.AbstractContainer</a> |
| <div class="inheritance">org.eclipse.ecf.remoteservice.client.AbstractClientContainer</div> |
| </div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>org.eclipse.core.runtime.IAdaptable</code>, <code><a href="../../core/IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></code>, <code><a href="../../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></code>, <code><a href="IRemoteServiceClientContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteServiceClientContainerAdapter</a></code>, <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code>, <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code>, <code><a href="../IRemoteServiceHost.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceHost</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../rest/client/AbstractRestClientContainer.html" title="class in org.eclipse.ecf.remoteservice.rest.client">AbstractRestClientContainer</a></code>, <code><a href="AbstractRSAClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractRSAClientContainer</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">AbstractClientContainer</span> |
| extends <a href="../../core/AbstractContainer.html" title="class in org.eclipse.ecf.core">AbstractContainer</a> |
| implements <a href="IRemoteServiceClientContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteServiceClientContainerAdapter</a></pre> |
| <div class="block">Remote service client abstract superclass.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.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>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alwaysSendDefaultParameters">alwaysSendDefaultParameters</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectContext">connectContext</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectedID">connectedID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectLock">connectLock</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containerID">containerID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="IRemoteCallParameterSerializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameterSerializer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parameterSerializer">parameterSerializer</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parameterSerializerLock">parameterSerializerLock</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="RemoteServiceClientRegistry.html" title="class in org.eclipse.ecf.remoteservice.client">RemoteServiceClientRegistry</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registry">registry</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="IRemoteResponseDeserializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteResponseDeserializer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteResponseDeserializer">remoteResponseDeserializer</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteResponseDeserializerLock">remoteResponseDeserializerLock</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="IRemoteServiceFactory.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteServiceFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteServiceFactory">remoteServiceFactory</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteServiceListeners">remoteServiceListeners</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="constructorSummary"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h2>Constructor Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.ecf.core.identity.ID)">AbstractClientContainer</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> containerID)</code></th> |
| <td class="colLast"> </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><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete 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="#addRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">addRemoteServiceListener</a></span>​(<a href="../IRemoteServiceListener.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Add listener for remote service registration/unregistration for this |
| container</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>org.eclipse.equinox.concurrent.future.IFuture</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>[] idFilter, |
| <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> clazz, |
| <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> filter)</code></th> |
| <td class="colLast"> |
| <div class="block">Asynchronously returns an array of <code>IRemoteServiceReference</code> objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>org.eclipse.equinox.concurrent.future.IFuture</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> target, |
| <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> clazz, |
| <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> filter)</code></th> |
| <td class="colLast"> |
| <div class="block">Asynchronously returns an array of <code>IRemoteServiceReference</code> objects.</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="#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> target, |
| <a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>[] idFilter, |
| <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> clazz, |
| <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> filter)</code></th> |
| <td class="colLast"> |
| <div class="block">Asynchronously returns an array of <code>IRemoteServiceReference</code> objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)">connect</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> targetID, |
| <a href="../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a> connectContext1)</code></th> |
| <td class="colLast"> |
| <div class="block">Connect to a target remote process or process group.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code><a href="../IRemoteFilter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteFilter</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRemoteFilter(java.lang.String)">createRemoteFilter</a></span>​(<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> filter)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a <code>IRemoteFilter</code> object.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>protected <a href="../IRemoteService.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteService</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRemoteService(org.eclipse.ecf.remoteservice.client.RemoteServiceClientRegistration)">createRemoteService</a></span>​(<a href="RemoteServiceClientRegistration.html" title="class in org.eclipse.ecf.remoteservice.client">RemoteServiceClientRegistration</a> registration)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a remote service for a given remote service registration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code>protected <a href="RemoteServiceClientRegistration.html" title="class in org.eclipse.ecf.remoteservice.client">RemoteServiceClientRegistration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRestServiceRegistration(java.lang.String%5B%5D,org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D%5B%5D,java.util.Dictionary)">createRestServiceRegistration</a></span>​(<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>[] clazzes, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a>[][] callables, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Dictionary.html?is-external=true" title="class or interface in java.util" class="externalLink">Dictionary</a> properties)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>protected <a href="RemoteServiceClientRegistration.html" title="class in org.eclipse.ecf.remoteservice.client">RemoteServiceClientRegistration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRestServiceRegistration(org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D,java.util.Dictionary)">createRestServiceRegistration</a></span>​(<a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a>[] callables, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Dictionary.html?is-external=true" title="class or interface in java.util" class="externalLink">Dictionary</a> properties)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code><a href="AbstractClientService.UriRequest.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientService.UriRequest</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createUriRequest(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">createUriRequest</a></span>​(<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> endpoint, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disconnect()">disconnect</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Disconnect.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dispose()">dispose</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Dispose this IContainer instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code><a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllRemoteServiceReferences(java.lang.String,java.lang.String)">getAllRemoteServiceReferences</a></span>​(<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> clazz, |
| <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> filter)</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Returns an array of <code>IRemoteServiceReference</code> objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code><a href="../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnectContextForAuthentication()">getConnectContextForAuthentication</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnectedID()">getConnectedID</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the target ID that this container instance has connected to.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getID()">getID</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the ID for this 'identifiable' object.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i16"> |
| <td class="colFirst"><code>protected <a href="IRemoteCallParameterSerializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameterSerializer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameterSerializer()">getParameterSerializer</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <td class="colFirst"><code>protected <a href="IRemoteCallParameterSerializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameterSerializer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameterSerializer(org.eclipse.ecf.remoteservice.client.IRemoteCallParameter,java.lang.Object)">getParameterSerializer</a></span>​(<a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a> parameter, |
| <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> value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i18"> |
| <td class="colFirst"><code>protected <a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteCallTargetID()">getRemoteCallTargetID</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <td class="colFirst"><code><a href="../IRemoteService.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteService</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)">getRemoteService</a></span>​(<a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a> reference)</code></th> |
| <td class="colLast"> |
| <div class="block">Get remote service for given IRemoteServiceReference.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i20"> |
| <td class="colFirst"><code><a href="../IRemoteServiceID.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceID</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteServiceID(org.eclipse.ecf.core.identity.ID,long)">getRemoteServiceID</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> containerID1, |
| long containerRelativeID)</code></th> |
| <td class="colLast"> |
| <div class="block">Get a remote service ID from a containerID and a containerRelative long value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i21"> |
| <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="#getRemoteServiceNamespace()">getRemoteServiceNamespace</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get namespace to use for this remote service provider.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i22"> |
| <td class="colFirst"><code><a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteServiceReference(org.eclipse.ecf.remoteservice.IRemoteServiceID)">getRemoteServiceReference</a></span>​(<a href="../IRemoteServiceID.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceID</a> serviceID)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the remote service reference known to this container for the given IRemoteServiceID.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i23"> |
| <td class="colFirst"><code><a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">getRemoteServiceReferences</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>[] idFilter, |
| <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> clazz, |
| <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> filter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an array of <code>IRemoteServiceReference</code> objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i24"> |
| <td class="colFirst"><code><a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)">getRemoteServiceReferences</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> target, |
| <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> clazz, |
| <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> filter)</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Returns an array of <code>IRemoteServiceReference</code> objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i25"> |
| <td class="colFirst"><code><a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">getRemoteServiceReferences</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> target, |
| <a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>[] idFilter, |
| <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> clazz, |
| <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> filter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an array of <code>IRemoteServiceReference</code> objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i26"> |
| <td class="colFirst"><code><a href="IRemoteResponseDeserializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteResponseDeserializer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResponseDeserializer()">getResponseDeserializer</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i27"> |
| <td class="colFirst"><code>protected <a href="IRemoteResponseDeserializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteResponseDeserializer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResponseDeserializer(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable,java.util.Map)">getResponseDeserializer</a></span>​(<a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable, |
| <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> responseHeaders)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i28"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#logException(java.lang.String,java.lang.Throwable)">logException</a></span>​(<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> string, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> e)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i29"> |
| <td class="colFirst"><code>protected <a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepareCallParameters(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareCallParameters</a></span>​(<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> uri, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i30"> |
| <td class="colFirst"><code>protected abstract <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="#prepareEndpointAddress(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareEndpointAddress</a></span>​(<a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</code></th> |
| <td class="colLast"> |
| <div class="block">Prepare an endpoint address for the given call and callable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i31"> |
| <td class="colFirst"><code>protected <a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepareExtraParameters(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareExtraParameters</a></span>​(<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> uri, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i32"> |
| <td class="colFirst"><code>protected <a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepareParameters(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareParameters</a></span>​(<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> uri, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i33"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#processResponse(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable,java.util.Map,byte%5B%5D)">processResponse</a></span>​(<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> uri, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable, |
| <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> responseHeaders, |
| byte[] responseBody)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i34"> |
| <td class="colFirst"><code><a href="../IRemoteServiceRegistration.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceRegistration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerCallables(java.lang.Class,org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D,java.util.Dictionary)">registerCallables</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> serviceType, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a>[] callables, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Dictionary.html?is-external=true" title="class or interface in java.util" class="externalLink">Dictionary</a> properties)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i35"> |
| <td class="colFirst"><code><a href="../IRemoteServiceRegistration.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceRegistration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerCallables(java.lang.String%5B%5D,org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D%5B%5D,java.util.Dictionary)">registerCallables</a></span>​(<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>[] clazzes, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a>[][] callables, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Dictionary.html?is-external=true" title="class or interface in java.util" class="externalLink">Dictionary</a> properties)</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Register remoteCallables for given serviceInterfaceNames.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i36"> |
| <td class="colFirst"><code><a href="../IRemoteServiceRegistration.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceRegistration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerCallables(org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D,java.util.Dictionary)">registerCallables</a></span>​(<a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a>[] callables, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Dictionary.html?is-external=true" title="class or interface in java.util" class="externalLink">Dictionary</a> properties)</code></th> |
| <td class="colLast"> |
| <div class="block">Register remoteCallables for remote service client.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i37"> |
| <td class="colFirst"><code><a href="../IRemoteServiceRegistration.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceRegistration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerRemoteService(java.lang.String%5B%5D,java.lang.Object,java.util.Dictionary)">registerRemoteService</a></span>​(<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>[] clazzes, |
| <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> service, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Dictionary.html?is-external=true" title="class or interface in java.util" class="externalLink">Dictionary</a> properties)</code></th> |
| <td class="colLast"> |
| <div class="block">Register a new remote service.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i38"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">removeRemoteServiceListener</a></span>​(<a href="../IRemoteServiceListener.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove remote service registration/unregistration listener for this |
| container.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i39"> |
| <td class="colFirst"><code>protected <a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#serializeParameter(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable,java.util.List,java.lang.Object%5B%5D)">serializeParameter</a></span>​(<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> uri, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a> currentParameters, |
| <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>[] parameterValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Serialize the parameter using the container's parameterSerializer.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i40"> |
| <td class="colFirst"><code>protected <a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#serializeParameter(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable,org.eclipse.ecf.remoteservice.client.IRemoteCallParameter,java.lang.Object)">serializeParameter</a></span>​(<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> uri, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable, |
| <a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a> defaultParameter, |
| <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> parameterValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Serialize the parameter using the container's parameterSerializer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i41"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAlwaysSendDefaultParameters(boolean)">setAlwaysSendDefaultParameters</a></span>​(boolean alwaysSendDefaultParameters)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the flag to <code>true</code> to include default parameters (which are specified when the callables are created) with |
| every request to the remote service.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i42"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConnectContextForAuthentication(org.eclipse.ecf.core.security.IConnectContext)">setConnectContextForAuthentication</a></span>​(<a href="../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a> connectContext)</code></th> |
| <td class="colLast"> |
| <div class="block">Set connect context for authentication upon subsequent calls to |
| <a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)"><code>IRemoteServiceContainerAdapter.getRemoteServiceReferences(ID[], String, String)</code></a> or <a href="../IRemoteServiceContainerAdapter.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)"><code>IRemoteServiceContainerAdapter.asyncGetRemoteServiceReferences(ID[], String, String)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i43"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setParameterSerializer(org.eclipse.ecf.remoteservice.client.IRemoteCallParameterSerializer)">setParameterSerializer</a></span>​(<a href="IRemoteCallParameterSerializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameterSerializer</a> serializer)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the remote call parameter serializer.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i44"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRemoteServiceFactory(org.eclipse.ecf.remoteservice.client.IRemoteServiceFactory)">setRemoteServiceFactory</a></span>​(<a href="IRemoteServiceFactory.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteServiceFactory</a> factory)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i45"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setResponseDeserializer(org.eclipse.ecf.remoteservice.client.IRemoteResponseDeserializer)">setResponseDeserializer</a></span>​(<a href="IRemoteResponseDeserializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteResponseDeserializer</a> resource)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i46"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ungetRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)">ungetRemoteService</a></span>​(<a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a> reference)</code></th> |
| <td class="colLast"> |
| <div class="block">Unget IRemoteServiceReference.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class org.eclipse.ecf.core.<a href="../../core/AbstractContainer.html" title="class in org.eclipse.ecf.core">AbstractContainer</a></h3> |
| <a id="methods.inherited.from.class.org.eclipse.ecf.core.AbstractContainer"> |
| <!-- --> |
| </a><code><a href="../../core/AbstractContainer.html#addListener(org.eclipse.ecf.core.IContainerListener)">addListener</a>, <a href="../../core/AbstractContainer.html#fireContainerEvent(org.eclipse.ecf.core.events.IContainerEvent)">fireContainerEvent</a>, <a href="../../core/AbstractContainer.html#getAdapter(java.lang.Class)">getAdapter</a>, <a href="../../core/AbstractContainer.html#getPasswordFromConnectContext(org.eclipse.ecf.core.security.IConnectContext)">getPasswordFromConnectContext</a>, <a href="../../core/AbstractContainer.html#removeListener(org.eclipse.ecf.core.IContainerListener)">removeListener</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.eclipse.ecf.core.<a href="../../core/IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></h3> |
| <a id="methods.inherited.from.class.org.eclipse.ecf.core.IContainer"> |
| <!-- --> |
| </a><code><a href="../../core/IContainer.html#getConnectNamespace()">getConnectNamespace</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.eclipse.ecf.remoteservice.<a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></h3> |
| <a id="methods.inherited.from.class.org.eclipse.ecf.remoteservice.IRemoteServiceContainerAdapter"> |
| <!-- --> |
| </a><code><a href="../IRemoteServiceContainerAdapter.html#setRemoteServiceCallPolicy(org.eclipse.ecf.remoteservice.IRemoteServiceCallPolicy)">setRemoteServiceCallPolicy</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="containerID">containerID</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span> <span class="memberName">containerID</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="connectedID">connectedID</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span> <span class="memberName">connectedID</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="connectLock">connectLock</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><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></span> <span class="memberName">connectLock</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="connectContext">connectContext</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a></span> <span class="memberName">connectContext</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="remoteResponseDeserializerLock">remoteResponseDeserializerLock</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><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></span> <span class="memberName">remoteResponseDeserializerLock</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="remoteResponseDeserializer">remoteResponseDeserializer</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="IRemoteResponseDeserializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteResponseDeserializer</a></span> <span class="memberName">remoteResponseDeserializer</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="parameterSerializerLock">parameterSerializerLock</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><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></span> <span class="memberName">parameterSerializerLock</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="parameterSerializer">parameterSerializer</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="IRemoteCallParameterSerializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameterSerializer</a></span> <span class="memberName">parameterSerializer</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="registry">registry</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="RemoteServiceClientRegistry.html" title="class in org.eclipse.ecf.remoteservice.client">RemoteServiceClientRegistry</a></span> <span class="memberName">registry</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="remoteServiceListeners">remoteServiceListeners</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a></span> <span class="memberName">remoteServiceListeners</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="remoteServiceFactory">remoteServiceFactory</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="IRemoteServiceFactory.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteServiceFactory</a></span> <span class="memberName">remoteServiceFactory</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.12</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="alwaysSendDefaultParameters">alwaysSendDefaultParameters</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">alwaysSendDefaultParameters</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.1</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li class="blockList"> |
| <section class="constructorDetails"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h2>Constructor Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.eclipse.ecf.core.identity.ID)">AbstractClientContainer</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">AbstractClientContainer</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> containerID)</span></div> |
| </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="setRemoteServiceFactory(org.eclipse.ecf.remoteservice.client.IRemoteServiceFactory)">setRemoteServiceFactory</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setRemoteServiceFactory</span>​(<span class="arguments"><a href="IRemoteServiceFactory.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteServiceFactory</a> factory)</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.12</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setConnectContextForAuthentication(org.eclipse.ecf.core.security.IConnectContext)">setConnectContextForAuthentication</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setConnectContextForAuthentication</span>​(<span class="arguments"><a href="../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a> connectContext)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#setConnectContextForAuthentication(org.eclipse.ecf.core.security.IConnectContext)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Set connect context for authentication upon subsequent calls to |
| <a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)"><code>IRemoteServiceContainerAdapter.getRemoteServiceReferences(ID[], String, String)</code></a> or <a href="../IRemoteServiceContainerAdapter.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)"><code>IRemoteServiceContainerAdapter.asyncGetRemoteServiceReferences(ID[], String, String)</code></a>. This |
| method should be called with a non-null connectContext in order to allow |
| authentication to occur during.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#setConnectContextForAuthentication(org.eclipse.ecf.core.security.IConnectContext)">setConnectContextForAuthentication</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#setConnectContextForAuthentication(org.eclipse.ecf.core.security.IConnectContext)">setConnectContextForAuthentication</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connectContext</code> - the connect context to use for authenticating. |
| If <code>null</code>, then no authentication will be |
| attempted.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getConnectContextForAuthentication()">getConnectContextForAuthentication</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a></span> <span class="memberName">getConnectContextForAuthentication</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setResponseDeserializer(org.eclipse.ecf.remoteservice.client.IRemoteResponseDeserializer)">setResponseDeserializer</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setResponseDeserializer</span>​(<span class="arguments"><a href="IRemoteResponseDeserializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteResponseDeserializer</a> resource)</span></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="IRemoteServiceClientContainerAdapter.html#setResponseDeserializer(org.eclipse.ecf.remoteservice.client.IRemoteResponseDeserializer)">setResponseDeserializer</a></code> in interface <code><a href="IRemoteServiceClientContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteServiceClientContainerAdapter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getResponseDeserializer()">getResponseDeserializer</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="IRemoteResponseDeserializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteResponseDeserializer</a></span> <span class="memberName">getResponseDeserializer</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setParameterSerializer(org.eclipse.ecf.remoteservice.client.IRemoteCallParameterSerializer)">setParameterSerializer</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setParameterSerializer</span>​(<span class="arguments"><a href="IRemoteCallParameterSerializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameterSerializer</a> serializer)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="IRemoteServiceClientContainerAdapter.html#setParameterSerializer(org.eclipse.ecf.remoteservice.client.IRemoteCallParameterSerializer)">IRemoteServiceClientContainerAdapter</a></code></span></div> |
| <div class="block">Set the remote call parameter serializer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="IRemoteServiceClientContainerAdapter.html#setParameterSerializer(org.eclipse.ecf.remoteservice.client.IRemoteCallParameterSerializer)">setParameterSerializer</a></code> in interface <code><a href="IRemoteServiceClientContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteServiceClientContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serializer</code> - the remote call parameter serializer to set for this container. May be <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getParameterSerializer()">getParameterSerializer</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="IRemoteCallParameterSerializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameterSerializer</a></span> <span class="memberName">getParameterSerializer</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getResponseDeserializer(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable,java.util.Map)">getResponseDeserializer</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="IRemoteResponseDeserializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteResponseDeserializer</a></span> <span class="memberName">getResponseDeserializer</span>​(<span class="arguments"><a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable, |
| <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> responseHeaders)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getParameterSerializer(org.eclipse.ecf.remoteservice.client.IRemoteCallParameter,java.lang.Object)">getParameterSerializer</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="IRemoteCallParameterSerializer.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameterSerializer</a></span> <span class="memberName">getParameterSerializer</span>​(<span class="arguments"><a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a> parameter, |
| <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> value)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setAlwaysSendDefaultParameters(boolean)">setAlwaysSendDefaultParameters</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setAlwaysSendDefaultParameters</span>​(<span class="arguments">boolean alwaysSendDefaultParameters)</span></div> |
| <div class="block">Set the flag to <code>true</code> to include default parameters (which are specified when the callables are created) with |
| every request to the remote service. |
| <p> |
| Setting to <code>false</code> will only send those parameter specified when the call is invoked. |
| <p> |
| Parameters which are specifed with the call override the defaults. Default parameters with a value of <code>null</code> |
| are not included.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>alwaysSendDefaultParameters</code> - whether to send default parameters with every remote call</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">addRemoteServiceListener</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">addRemoteServiceListener</span>​(<span class="arguments"><a href="../IRemoteServiceListener.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceListener</a> listener)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#addRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Add listener for remote service registration/unregistration for this |
| container</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#addRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">addRemoteServiceListener</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#addRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">addRemoteServiceListener</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceHost.html#addRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">addRemoteServiceListener</a></code> in interface <code><a href="../IRemoteServiceHost.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceHost</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - notified of service registration/unregistration events. Must |
| not be <code>null</code> .</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID[],java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">org.eclipse.equinox.concurrent.future.IFuture</span> <span class="memberName">asyncGetRemoteServiceReferences</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>[] idFilter, |
| <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> clazz, |
| <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> filter)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Asynchronously returns an array of <code>IRemoteServiceReference</code> objects. The |
| returned array of <code>IRemoteServiceReference</code> objects contains |
| services that were registered under the specified class and match the |
| specified idFilter, and filter criteria. |
| <p> |
| Note this method assumes that the enclosing container has previously |
| been connected, and uses the idFilter to filter among targets within the |
| previously connected set of container IDs. To request connection as |
| part of reference lookup, see <a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)"><code>IRemoteServiceContainerAdapter.getRemoteServiceReferences(ID, String, String)</code></a>. |
| </p> |
| <p> |
| The IFuture is returned immediately, and subsequent calls to <code>IFuture.get()</code> |
| or <code>IFuture.get(long)</code> will return the actual results received. The type of |
| the Object returned from <code>IFuture.get()</code> will be IRemoteServiceReference []. |
| |
| <p> |
| The list is valid at the time of the call to this method, however since |
| the Framework is a very dynamic environment, services can be modified or |
| unregistered at anytime. |
| |
| <p> |
| <code>idFilter</code> is used to select a registered services that were |
| registered by a given set of containers with id in idFilter. Only |
| services exposed by a container with id in idFilter will be returned. |
| |
| <p> |
| If <code>idFilter</code> is <code>null</code>, all containers are |
| considered to match the filter. |
| |
| <p> |
| <code>filter</code> is used to select the registered service whose |
| properties objects contain keys and values which satisfy the filter. See |
| <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Filter.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>Filter</code></a> for a description of the filter string syntax.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>idFilter</code> - an array of ID instances that will restrict the search for |
| matching container ids If null, all remote containers will be |
| considered in search for matching IRemoteServiceReference |
| instances. May be <code>null</code>.</dd> |
| <dd><code>clazz</code> - the fully qualified name of the interface class that describes |
| the desired service. Must not be <code>null</code>.</dd> |
| <dd><code>filter</code> - The filter criteria. May be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IFuture that through subsequent calls to IFuture#get() will return |
| IRemoteServiceReference [] with IRemoteServiceReferences matching given search criteria. |
| Will not return <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">org.eclipse.equinox.concurrent.future.IFuture</span> <span class="memberName">asyncGetRemoteServiceReferences</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> target, |
| <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> clazz, |
| <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> filter)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Asynchronously returns an array of <code>IRemoteServiceReference</code> objects. The |
| returned array of <code>IRemoteServiceReference</code> objects contains |
| services that were registered under the specified class and match the |
| specified idFilter, and filter criteria. |
| <p> |
| The IFuture is returned immediately, and subsequent calls to <code>IFuture.get()</code> |
| or <code>IFuture.get(long)</code> will return the actual results received. The type of |
| the Object returned from <code>IFuture.get()</code> will be IRemoteServiceReference []. |
| |
| <p> |
| The list is valid at the time of the call to this method, however since |
| the Framework is a very dynamic environment, services can be modified or |
| unregistered at anytime. |
| |
| <p> |
| <code>idFilter</code> is used to select a registered services that were |
| registered by a given set of containers with id in idFilter. Only |
| services exposed by a container with id in idFilter will be returned. |
| |
| <p>target is a remote container to connect to.</p> |
| |
| <p> |
| <code>filter</code> is used to select the registered service whose |
| properties objects contain keys and values which satisfy the filter. See |
| <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Filter.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>Filter</code></a> for a description of the filter string syntax.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - an target to connect to if enclosing container is not already |
| connected. May be <code>null</code>.</dd> |
| <dd><code>clazz</code> - the fully qualified name of the interface class that describes |
| the desired service. Must not be <code>null</code>.</dd> |
| <dd><code>filter</code> - The filter criteria. May be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IFuture that through subsequent calls to IFuture#get() will return |
| IRemoteServiceReference [] with IRemoteServiceReferences matching given search criteria. |
| Will not return <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.identity.ID[],java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">org.eclipse.equinox.concurrent.future.IFuture</span> <span class="memberName">asyncGetRemoteServiceReferences</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> target, |
| <a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>[] idFilter, |
| <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> clazz, |
| <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> filter)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Asynchronously returns an array of <code>IRemoteServiceReference</code> objects. The |
| returned array of <code>IRemoteServiceReference</code> objects contains |
| services that were registered under the specified class and match the |
| specified idFilter, and filter criteria. |
| <p> |
| The IFuture is returned immediately, and subsequent calls to <code>IFuture.get()</code> |
| or <code>IFuture.get(long)</code> will return the actual results received. The type of |
| the Object returned from <code>IFuture.get()</code> will be IRemoteServiceReference []. |
| |
| <p> |
| The list is valid at the time of the call to this method, however since |
| the Framework is a very dynamic environment, services can be modified or |
| unregistered at anytime. |
| |
| <p><code>target</code> is a remote container to connect to. If <code>null</code>, no connection attempt is made.</p> |
| <p> |
| <code>idFilter</code> is used to select a registered services that were |
| registered by a given set of containers with id in idFilter. Only |
| services exposed by a container with id in idFilter will be returned. If <code>idFilter</code> is <code>null</code>, all containers are |
| considered to match the filter. |
| |
| <p> |
| <code>filter</code> is used to select the registered service whose |
| properties objects contain keys and values which satisfy the filter. See |
| <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Filter.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>Filter</code></a> for a description of the filter string syntax. |
| If <code>filter</code> is <code>null</code>, all registered services |
| are considered to match the filter. If <code>filter</code> cannot be |
| parsed, an <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>InvalidSyntaxException</code></a> will be thrown with a human |
| readable message where the filter became unparsable.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - an target to connect to if enclosing container is not already |
| connected. May be <code>null</code>.</dd> |
| <dd><code>idFilter</code> - an array of ID instances that will restrict the search for |
| matching container ids If null, all remote containers will be |
| considered in search for matching IRemoteServiceReference |
| instances. May be <code>null</code>.</dd> |
| <dd><code>clazz</code> - the fully qualified name of the interface class that describes |
| the desired service. Must not be <code>null</code>.</dd> |
| <dd><code>filter</code> - The filter criteria. May be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IFuture that through subsequent calls to IFuture#get() will return |
| IRemoteServiceReference [] with IRemoteServiceReferences matching given search criteria. |
| Will not return <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createRemoteFilter(java.lang.String)">createRemoteFilter</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../IRemoteFilter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteFilter</a></span> <span class="memberName">createRemoteFilter</span>​(<span class="arguments"><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> filter)</span> |
| throws <span class="exceptions"><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">InvalidSyntaxException</a></span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#createRemoteFilter(java.lang.String)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Creates a <code>IRemoteFilter</code> object. This <code>IRemoteFilter</code> object may |
| be used to match a <code>IRemoteServiceReference</code> object or a |
| <code>Dictionary</code> object. |
| |
| <p> |
| If the filter cannot be parsed, an <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>InvalidSyntaxException</code></a> will be |
| thrown with a human readable message where the filter became unparsable.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#createRemoteFilter(java.lang.String)">createRemoteFilter</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#createRemoteFilter(java.lang.String)">createRemoteFilter</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - The filter string.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>IRemoteFilter</code> object encapsulating the filter string.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">InvalidSyntaxException</a></code> - If <code>filter</code> contains an invalid |
| filter string that cannot be parsed.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd>"Framework specification for a description of the filter string syntax.", |
| <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/FrameworkUtil.html?is-external=true#createFilter(java.lang.String)" title="class or interface in org.osgi.framework" class="externalLink"><code>FrameworkUtil.createFilter(String)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getAllRemoteServiceReferences(java.lang.String,java.lang.String)">getAllRemoteServiceReferences</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a>[]</span> <span class="memberName">getAllRemoteServiceReferences</span>​(<span class="arguments"><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> clazz, |
| <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> filter)</span> |
| throws <span class="exceptions"><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">InvalidSyntaxException</a></span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#getAllRemoteServiceReferences(java.lang.String,java.lang.String)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block"><p> |
| Returns an array of <code>IRemoteServiceReference</code> objects. The |
| returned array of <code>IRemoteServiceReference</code> objects contains |
| services that were registered under the specified class, or if the clazz |
| parameter is <code>null</code> all services registered. |
| </p> |
| <p> |
| The list is valid at the time of the call to this method, however since |
| the remote service container is a very dynamic environment, services can be modified or |
| unregistered at anytime. |
| </p> |
| <p> |
| <code>filter</code> is used to select the registered service whose |
| properties objects contain keys and values which satisfy the filter. See |
| <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Filter.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>Filter</code></a> for a description of the filter string syntax. |
| </p> |
| <p> |
| If <code>filter</code> is <code>null</code>, all registered services |
| are considered to match the filter. If <code>filter</code> cannot be |
| parsed, an <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>InvalidSyntaxException</code></a> will be thrown with a human |
| readable message where the filter became unparsable. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#getAllRemoteServiceReferences(java.lang.String,java.lang.String)">getAllRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#getAllRemoteServiceReferences(java.lang.String,java.lang.String)">getAllRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazz</code> - the fully qualified name of the interface class that describes |
| the desired service. May be <code>null</code>.</dd> |
| <dd><code>filter</code> - The filter criteria. May be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array of IRemoteServiceReferences matching given search criteria or |
| <code>null</code> if no services are found that match the search.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">InvalidSyntaxException</a></code> - If filter contains an invalid filter string that cannot be parsed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)">getRemoteService</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../IRemoteService.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteService</a></span> <span class="memberName">getRemoteService</span>​(<span class="arguments"><a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a> reference)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#getRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Get remote service for given IRemoteServiceReference. Note that clients |
| that call this method successfully should later call |
| <a href="../IRemoteServiceContainerAdapter.html#ungetRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)"><code>IRemoteServiceContainerAdapter.ungetRemoteService(IRemoteServiceReference)</code></a> |
| when the IRemoteService will no longer be used.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#getRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)">getRemoteService</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#getRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)">getRemoteService</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reference</code> - the IRemoteServiceReference for the desired service. Must not |
| be <code>null</code> .</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IRemoteService representing the remote service. If remote service |
| no longer exists for reference, then <code>null</code> is |
| returned.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../IRemoteServiceContainerAdapter.html#ungetRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)"><code>IRemoteServiceContainerAdapter.ungetRemoteService(IRemoteServiceReference)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRemoteServiceID(org.eclipse.ecf.core.identity.ID,long)">getRemoteServiceID</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../IRemoteServiceID.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceID</a></span> <span class="memberName">getRemoteServiceID</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> containerID1, |
| long containerRelativeID)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceID(org.eclipse.ecf.core.identity.ID,long)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Get a remote service ID from a containerID and a containerRelative long value. Will return a non-null value |
| if the IRemoteServiceRegistration/Reference is currently 'known' to this container adapter. <code>null</code> |
| if not.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#getRemoteServiceID(org.eclipse.ecf.core.identity.ID,long)">getRemoteServiceID</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceID(org.eclipse.ecf.core.identity.ID,long)">getRemoteServiceID</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceHost.html#getRemoteServiceID(org.eclipse.ecf.core.identity.ID,long)">getRemoteServiceID</a></code> in interface <code><a href="../IRemoteServiceHost.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceHost</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>containerID1</code> - the containerID that is the server/host for the remote service. Must not be <code>null</code>. This |
| must be the containerID for the <b>server</b>/host of the remote service.</dd> |
| <dd><code>containerRelativeID</code> - the long value identifying the remote service relative to the container ID.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IRemoteServiceID instance if the associated IRemoteServiceRegistration/Reference is known to this container |
| adapter, <code>null</code> if it is not.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRemoteServiceNamespace()">getRemoteServiceNamespace</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../../core/identity/Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></span> <span class="memberName">getRemoteServiceNamespace</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceNamespace()">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Get namespace to use for this remote service provider.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#getRemoteServiceNamespace()">getRemoteServiceNamespace</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceNamespace()">getRemoteServiceNamespace</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceHost.html#getRemoteServiceNamespace()">getRemoteServiceNamespace</a></code> in interface <code><a href="../IRemoteServiceHost.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceHost</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Namespace to use for creating IRemoteServiceID for this remote service provider. Will |
| not return <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRemoteServiceReference(org.eclipse.ecf.remoteservice.IRemoteServiceID)">getRemoteServiceReference</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a></span> <span class="memberName">getRemoteServiceReference</span>​(<span class="arguments"><a href="../IRemoteServiceID.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceID</a> serviceID)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReference(org.eclipse.ecf.remoteservice.IRemoteServiceID)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Get the remote service reference known to this container for the given IRemoteServiceID. Note that |
| this method must be guaranteed not to block by the provider implementation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#getRemoteServiceReference(org.eclipse.ecf.remoteservice.IRemoteServiceID)">getRemoteServiceReference</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReference(org.eclipse.ecf.remoteservice.IRemoteServiceID)">getRemoteServiceReference</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serviceID</code> - the serviceID to retrieve the IRemoteServiceReference for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IRemoteServiceReference the remote service reference associated with the given serviceID. |
| Will return <code>null</code> if no IRemoteServiceReference found for the given serviceID.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID[],java.lang.String,java.lang.String)">getRemoteServiceReferences</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a>[]</span> <span class="memberName">getRemoteServiceReferences</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>[] idFilter, |
| <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> clazz, |
| <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> filter)</span> |
| throws <span class="exceptions"><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">InvalidSyntaxException</a></span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Returns an array of <code>IRemoteServiceReference</code> objects. The |
| returned array of <code>IRemoteServiceReference</code> objects contains |
| services that were registered under the specified class and match the |
| specified idFilter, and filter criteria. |
| <p> |
| Note this method assumes that the enclosing container has previously |
| been connected, and uses the idFilter to filter among targets within the |
| previously connected set of container IDs. To request connection as |
| part of reference lookup, see <a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)"><code>IRemoteServiceContainerAdapter.getRemoteServiceReferences(ID, String, String)</code></a>. |
| </p> |
| |
| <p> |
| The list is valid at the time of the call to this method, however since |
| the Framework is a very dynamic environment, services can be modified or |
| unregistered at anytime. |
| |
| <p> |
| <code>idFilter</code> is used to select a registered services that were |
| registered by a given set of containers with id in idFilter. Only |
| services exposed by a container with id in idFilter will be returned. |
| |
| <p> |
| If <code>idFilter</code> is <code>null</code>, all containers are |
| considered to match the filter. |
| |
| <p> |
| <code>filter</code> is used to select the registered service whose |
| properties objects contain keys and values which satisfy the filter. See |
| <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Filter.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>Filter</code></a> for a description of the filter string syntax. |
| |
| <p> |
| If <code>filter</code> is <code>null</code>, all registered services |
| are considered to match the filter. If <code>filter</code> cannot be |
| parsed, an <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>InvalidSyntaxException</code></a> will be thrown with a human |
| readable message where the filter became unparsable.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">getRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">getRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>idFilter</code> - an array of ID instances that will restrict the search for |
| matching container ids If null, all remote containers will be |
| considered in search for matching IRemoteServiceReference |
| instances. May be <code>null</code>.</dd> |
| <dd><code>clazz</code> - the fully qualified name of the interface class that describes |
| the desired service. Must not be <code>null</code>.</dd> |
| <dd><code>filter</code> - The filter criteria. May be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array of IRemoteServiceReferences matching given search criteria or |
| <code>null</code> if no services are found that match the search.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">InvalidSyntaxException</a></code> - If filter contains an invalid filter string that cannot be parsed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)">getRemoteServiceReferences</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a>[]</span> <span class="memberName">getRemoteServiceReferences</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> target, |
| <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> clazz, |
| <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> filter)</span> |
| throws <span class="exceptions"><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">InvalidSyntaxException</a>, |
| <a href="../../core/ContainerConnectException.html" title="class in org.eclipse.ecf.core">ContainerConnectException</a></span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block"><p> |
| Returns an array of <code>IRemoteServiceReference</code> objects. The |
| returned array of <code>IRemoteServiceReference</code> objects contains |
| services that were registered under the specified class and match the |
| specified idFilter, and filter criteria. |
| </p> |
| <p> |
| The list is valid at the time of the call to this method, however since |
| the Framework is a very dynamic environment, services can be modified or |
| unregistered at anytime. |
| </p> |
| <p>target is a remote container to connect to.</p> |
| <p> |
| <code>filter</code> is used to select the registered service whose |
| properties objects contain keys and values which satisfy the filter. See |
| <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Filter.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>Filter</code></a> for a description of the filter string syntax. |
| |
| <p> |
| If <code>filter</code> is <code>null</code>, all registered services |
| are considered to match the filter. If <code>filter</code> cannot be |
| parsed, an <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>InvalidSyntaxException</code></a> will be thrown with a human |
| readable message where the filter became unparsable.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)">getRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)">getRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - an target to connect to if enclosing container is not already |
| connected. May be <code>null</code>.</dd> |
| <dd><code>clazz</code> - the fully qualified name of the interface class that describes |
| the desired service. Must not be <code>null</code>.</dd> |
| <dd><code>filter</code> - The filter criteria. May be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array of IRemoteServiceReferences matching given search criteria or |
| <code>null</code> if no services are found that match the search.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">InvalidSyntaxException</a></code> - If filter contains an invalid filter string that cannot be parsed.</dd> |
| <dd><code><a href="../../core/ContainerConnectException.html" title="class in org.eclipse.ecf.core">ContainerConnectException</a></code> - if container cannot connect</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.identity.ID[],java.lang.String,java.lang.String)">getRemoteServiceReferences</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a>[]</span> <span class="memberName">getRemoteServiceReferences</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> target, |
| <a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a>[] idFilter, |
| <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> clazz, |
| <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> filter)</span> |
| throws <span class="exceptions"><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">InvalidSyntaxException</a>, |
| <a href="../../core/ContainerConnectException.html" title="class in org.eclipse.ecf.core">ContainerConnectException</a></span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Returns an array of <code>IRemoteServiceReference</code> objects. The |
| returned array of <code>IRemoteServiceReference</code> objects contains |
| services that were registered under the specified class and match the |
| specified idFilter, and filter criteria. |
| <p> |
| Note this method assumes that the enclosing container has previously |
| been connected, and uses the idFilter to filter among targets within the |
| previously connected set of container IDs. To request connection as |
| part of reference lookup, see <a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)"><code>IRemoteServiceContainerAdapter.getRemoteServiceReferences(ID, String, String)</code></a>. |
| </p> |
| |
| <p> |
| The list is valid at the time of the call to this method, however since |
| the Framework is a very dynamic environment, services can be modified or |
| unregistered at anytime. |
| |
| <p><code>target</code> is a remote container to connect to. If <code>null</code>, no connection attempt is made.</p> |
| <p> |
| <code>idFilter</code> is used to select a registered services that were |
| registered by a given set of containers with id in idFilter. Only |
| services exposed by a container with id in idFilter will be returned. If <code>idFilter</code> is <code>null</code>, all containers are |
| considered to match the filter. |
| |
| <p> |
| <code>filter</code> is used to select the registered service whose |
| properties objects contain keys and values which satisfy the filter. See |
| <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Filter.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>Filter</code></a> for a description of the filter string syntax. |
| If <code>filter</code> is <code>null</code>, all registered services |
| are considered to match the filter. If <code>filter</code> cannot be |
| parsed, an <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>InvalidSyntaxException</code></a> will be thrown with a human |
| readable message where the filter became unparsable.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">getRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">getRemoteServiceReferences</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - a target container to connect to if enclosing container is not already |
| connected. May be <code>null</code>.</dd> |
| <dd><code>idFilter</code> - an array of ID instances that will restrict the search for |
| matching container ids If null, all remote containers will be |
| considered in search for matching IRemoteServiceReference |
| instances. May be <code>null</code>.</dd> |
| <dd><code>clazz</code> - the fully qualified name of the interface class that describes |
| the desired service. Must not be <code>null</code>.</dd> |
| <dd><code>filter</code> - The filter criteria. May be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array of IRemoteServiceReferences matching given search criteria or |
| <code>null</code> if no services are found that match the search.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/InvalidSyntaxException.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">InvalidSyntaxException</a></code> - If filter contains an invalid filter string that cannot be parsed.</dd> |
| <dd><code><a href="../../core/ContainerConnectException.html" title="class in org.eclipse.ecf.core">ContainerConnectException</a></code> - if container cannot connect</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="registerRemoteService(java.lang.String[],java.lang.Object,java.util.Dictionary)">registerRemoteService</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../IRemoteServiceRegistration.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceRegistration</a></span> <span class="memberName">registerRemoteService</span>​(<span class="arguments"><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>[] clazzes, |
| <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> service, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Dictionary.html?is-external=true" title="class or interface in java.util" class="externalLink">Dictionary</a> properties)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#registerRemoteService(java.lang.String%5B%5D,java.lang.Object,java.util.Dictionary)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Register a new remote service. This method is to be called by the service |
| server...i.e. the client that wishes to make available a service to other |
| client within this container.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#registerRemoteService(java.lang.String%5B%5D,java.lang.Object,java.util.Dictionary)">registerRemoteService</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceHost.html#registerRemoteService(java.lang.String%5B%5D,java.lang.Object,java.util.Dictionary)">registerRemoteService</a></code> in interface <code><a href="../IRemoteServiceHost.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceHost</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazzes</code> - the interface classes that the service exposes to remote |
| clients. Must not be <code>null</code> and must not be an |
| empty array.</dd> |
| <dd><code>service</code> - the service object. Under normal conditions this object must |
| <ul><li>not be <code>null</code></li> |
| <li>implement all of the classes specified by the first parameter</li> |
| </ul> |
| The only situation when the service object may be <code>null</code> is if |
| the service property <a href="../Constants.html#SERVICE_REGISTER_PROXY"><code>Constants.SERVICE_REGISTER_PROXY</code></a> is set |
| in the properties. If <a href="../Constants.html#SERVICE_REGISTER_PROXY"><code>Constants.SERVICE_REGISTER_PROXY</code></a> is set |
| in the properties parameter (to an arbitrary value), then the service |
| object may then be <code>null</code>.</dd> |
| <dd><code>properties</code> - to be associated with service</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IRemoteServiceRegistration the service registration. Will not |
| return <code>null</code> .</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="removeRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">removeRemoteServiceListener</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">removeRemoteServiceListener</span>​(<span class="arguments"><a href="../IRemoteServiceListener.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceListener</a> listener)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#removeRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Remove remote service registration/unregistration listener for this |
| container.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#removeRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">removeRemoteServiceListener</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#removeRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">removeRemoteServiceListener</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceHost.html#removeRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">removeRemoteServiceListener</a></code> in interface <code><a href="../IRemoteServiceHost.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceHost</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - to remove. Must not be <code>null</code> .</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="ungetRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)">ungetRemoteService</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">ungetRemoteService</span>​(<span class="arguments"><a href="../IRemoteServiceReference.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceReference</a> reference)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../IRemoteServiceContainerAdapter.html#ungetRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Unget IRemoteServiceReference. Release all resources associated with the |
| given IRemoteServiceReference. This method should be called by users of |
| the IRemoteServiceReference that have previously called |
| <a href="../IRemoteServiceContainerAdapter.html#getRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)"><code>IRemoteServiceContainerAdapter.getRemoteService(IRemoteServiceReference)</code></a>. |
| If this method returns true, then the previously used IRemoteService will |
| no longer be usable.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceConsumer.html#ungetRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)">ungetRemoteService</a></code> in interface <code><a href="../IRemoteServiceConsumer.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceConsumer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../IRemoteServiceContainerAdapter.html#ungetRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)">ungetRemoteService</a></code> in interface <code><a href="../IRemoteServiceContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reference</code> - the IRemoteServiceReference to unget</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if unget successful, false if not. If this method returns |
| true, then the IRemoteService instance previously retrieved via |
| the given IRemoteServiceReference instance provided will no |
| longer be usable.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../IRemoteServiceContainerAdapter.html#getRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)"><code>IRemoteServiceContainerAdapter.getRemoteService(IRemoteServiceReference)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="registerCallables(org.eclipse.ecf.remoteservice.client.IRemoteCallable[],java.util.Dictionary)">registerCallables</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../IRemoteServiceRegistration.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceRegistration</a></span> <span class="memberName">registerCallables</span>​(<span class="arguments"><a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a>[] callables, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Dictionary.html?is-external=true" title="class or interface in java.util" class="externalLink">Dictionary</a> properties)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="IRemoteServiceClientContainerAdapter.html#registerCallables(org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D,java.util.Dictionary)">IRemoteServiceClientContainerAdapter</a></code></span></div> |
| <div class="block">Register remoteCallables for remote service client. This method allows providers to register <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client"><code>IRemoteCallable</code></a> |
| instances, so that subsequent lookup operations result in appropriate remote service registrations.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="IRemoteServiceClientContainerAdapter.html#registerCallables(org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D,java.util.Dictionary)">registerCallables</a></code> in interface <code><a href="IRemoteServiceClientContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteServiceClientContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callables</code> - the IRemoteCallables to register. Each IRemoteCallable represents a specific method to resourcePath mapping. |
| Must not be <code>null</code>.</dd> |
| <dd><code>properties</code> - any service properties to associate with the given registration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IRemoteServiceRegistration to use to unregister the remote service. Will not be <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="registerCallables(java.lang.Class,org.eclipse.ecf.remoteservice.client.IRemoteCallable[],java.util.Dictionary)">registerCallables</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../IRemoteServiceRegistration.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceRegistration</a></span> <span class="memberName">registerCallables</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> serviceType, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a>[] callables, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Dictionary.html?is-external=true" title="class or interface in java.util" class="externalLink">Dictionary</a> properties)</span></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serviceType</code> - serviceType</dd> |
| <dd><code>callables</code> - callables</dd> |
| <dd><code>properties</code> - properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IRemoteServiceRegistration registration created for registration</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.5</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="registerCallables(java.lang.String[],org.eclipse.ecf.remoteservice.client.IRemoteCallable[][],java.util.Dictionary)">registerCallables</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../IRemoteServiceRegistration.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceRegistration</a></span> <span class="memberName">registerCallables</span>​(<span class="arguments"><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>[] clazzes, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a>[][] callables, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Dictionary.html?is-external=true" title="class or interface in java.util" class="externalLink">Dictionary</a> properties)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="IRemoteServiceClientContainerAdapter.html#registerCallables(java.lang.String%5B%5D,org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D%5B%5D,java.util.Dictionary)">IRemoteServiceClientContainerAdapter</a></code></span></div> |
| <div class="block"><p> |
| Register remoteCallables for given serviceInterfaceNames. This method allows providers to register <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client"><code>IRemoteCallable</code></a> |
| instances and associate an array of IRemoteCallables with each given serviceInterfaceName, so that subsequent lookup operations result in |
| appropriate remote service registrations. The IRemoteCallable instances should correspond to <b>methods</b> within the |
| particular service interface class.</p> |
| <p> |
| Note that the number of serviceInterfaceNames (i.e. the length of the given String[]) <b>must</b> be equal to |
| the number of rows of the remoteCallable two-dimensional array. </p> |
| <p>For example, suppose we have a service interface "org.eclipse.ecf.IFoo": |
| <pre> |
| public interface IFoo { |
| public String getFoo(); |
| } |
| </pre> |
| We can define for this service inteface the following two dimensional array of callables: |
| <pre> |
| IRemoteCallable[][] callables = new IRemoteCallable[] { new RemoteCallable("foo","foo/bar/resourcePath",null,requestType) }}; |
| </pre> |
| and then register with this method: |
| <pre> |
| IRemoteServiceRegistration reg = this.registerRemoteCallable(new String[] { "org.eclipse.ecf.IFoo" }, callables, null); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="IRemoteServiceClientContainerAdapter.html#registerCallables(java.lang.String%5B%5D,org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D%5B%5D,java.util.Dictionary)">registerCallables</a></code> in interface <code><a href="IRemoteServiceClientContainerAdapter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteServiceClientContainerAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazzes</code> - service interface names</dd> |
| <dd><code>callables</code> - the IRemoteCallables to register. Each IRemoteCallable represents a specific method to resourcePath mapping. |
| Must not be <code>null</code>.</dd> |
| <dd><code>properties</code> - any service properties to associate with the given registration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IRemoteServiceRegistration to use to unregister the remote service. Will not be <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)">connect</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">connect</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> targetID, |
| <a href="../../core/security/IConnectContext.html" title="interface in org.eclipse.ecf.core.security">IConnectContext</a> connectContext1)</span> |
| throws <span class="exceptions"><a href="../../core/ContainerConnectException.html" title="class in org.eclipse.ecf.core">ContainerConnectException</a></span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../core/IContainer.html#connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)">IContainer</a></code></span></div> |
| <div class="block">Connect to a target remote process or process group. The target |
| identified by the first parameter (targetID) is connected the |
| implementation class. If authentication information is required, the |
| required information is given via via the second parameter |
| (connectContext). |
| |
| Callers note that depending upon the provider implementation this method |
| may block. It is suggested that callers use a separate thread to call |
| this method. |
| |
| This method provides an implementation independent way for container |
| implementations to connect, authenticate, and communicate with a remote |
| service or group of services. Providers are responsible for implementing |
| this operation in a way appropriate to the given remote service (or |
| group) via expected protocol.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../core/IContainer.html#connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)">connect</a></code> in interface <code><a href="../../core/IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>targetID</code> - the ID of the remote server or group to connect to. See |
| <a href="../../core/IContainer.html#getConnectNamespace()"><code>IContainer.getConnectNamespace()</code></a> for a explanation of the |
| constraints upon this parameter.</dd> |
| <dd><code>connectContext1</code> - any required context to allow this container to authenticate. |
| May be <code>null</code> if underlying provider does not |
| have any authentication requirements for connection.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../core/ContainerConnectException.html" title="class in org.eclipse.ecf.core">ContainerConnectException</a></code> - thrown if communication cannot be established with remote |
| service. Causes can include network connection failure, |
| authentication failure, server error, or if container is |
| already connected.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="disconnect()">disconnect</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">disconnect</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../core/IContainer.html#disconnect()">IContainer</a></code></span></div> |
| <div class="block">Disconnect. This operation will disconnect the local container instance |
| from any previously joined target or group. Subsequent calls to |
| getConnectedID() will return <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../core/IContainer.html#disconnect()">disconnect</a></code> in interface <code><a href="../../core/IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getConnectedID()">getConnectedID</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span> <span class="memberName">getConnectedID</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../core/IContainer.html#getConnectedID()">IContainer</a></code></span></div> |
| <div class="block">Get the target ID that this container instance has connected to. Returns |
| null if not connected.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../core/IContainer.html#getConnectedID()">getConnectedID</a></code> in interface <code><a href="../../core/IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ID of the target we are connected to. Returns <code>null</code> |
| if container not connected.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getID()">getID</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span> <span class="memberName">getID</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../core/identity/IIdentifiable.html#getID()">IIdentifiable</a></code></span></div> |
| <div class="block">Return the ID for this 'identifiable' object. The returned ID should be |
| unique within its namespace. May return <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../core/identity/IIdentifiable.html#getID()">getID</a></code> in interface <code><a href="../../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ID for this identifiable object. May return <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="dispose()">dispose</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">dispose</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../core/IContainer.html#dispose()">IContainer</a></code></span></div> |
| <div class="block">Dispose this IContainer instance. The container instance will be made |
| inactive after the completion of this method and will be unavailable for |
| subsequent usage.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../core/IContainer.html#dispose()">dispose</a></code> in interface <code><a href="../../core/IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../core/AbstractContainer.html#dispose()">dispose</a></code> in class <code><a href="../../core/AbstractContainer.html" title="class in org.eclipse.ecf.core">AbstractContainer</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createRestServiceRegistration(java.lang.String[],org.eclipse.ecf.remoteservice.client.IRemoteCallable[][],java.util.Dictionary)">createRestServiceRegistration</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="RemoteServiceClientRegistration.html" title="class in org.eclipse.ecf.remoteservice.client">RemoteServiceClientRegistration</a></span> <span class="memberName">createRestServiceRegistration</span>​(<span class="arguments"><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>[] clazzes, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a>[][] callables, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Dictionary.html?is-external=true" title="class or interface in java.util" class="externalLink">Dictionary</a> properties)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createRestServiceRegistration(org.eclipse.ecf.remoteservice.client.IRemoteCallable[],java.util.Dictionary)">createRestServiceRegistration</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="RemoteServiceClientRegistration.html" title="class in org.eclipse.ecf.remoteservice.client">RemoteServiceClientRegistration</a></span> <span class="memberName">createRestServiceRegistration</span>​(<span class="arguments"><a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a>[] callables, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Dictionary.html?is-external=true" title="class or interface in java.util" class="externalLink">Dictionary</a> properties)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="logException(java.lang.String,java.lang.Throwable)">logException</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">logException</span>​(<span class="arguments"><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> string, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> e)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRemoteCallTargetID()">getRemoteCallTargetID</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span> <span class="memberName">getRemoteCallTargetID</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="prepareCallParameters(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareCallParameters</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a>[]</span> <span class="memberName">prepareCallParameters</span>​(<span class="arguments"><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> uri, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></span></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - uri</dd> |
| <dd><code>call</code> - remote call</dd> |
| <dd><code>callable</code> - callable</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IRemoteCallParameter[] remote call parameters prepared</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></code> - if cannot be serialized</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.5</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="prepareExtraParameters(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareExtraParameters</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a>[]</span> <span class="memberName">prepareExtraParameters</span>​(<span class="arguments"><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> uri, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></span></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - uri</dd> |
| <dd><code>call</code> - call</dd> |
| <dd><code>callable</code> - callable</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IRemoteCallParameter[] extra parameters</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></code> - if not serializable</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.5</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="prepareParameters(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareParameters</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a>[]</span> <span class="memberName">prepareParameters</span>​(<span class="arguments"><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> uri, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></span></div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="serializeParameter(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable,org.eclipse.ecf.remoteservice.client.IRemoteCallParameter,java.lang.Object)">serializeParameter</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a></span> <span class="memberName">serializeParameter</span>​(<span class="arguments"><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> uri, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable, |
| <a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a> defaultParameter, |
| <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> parameterValue)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></span></div> |
| <div class="block">Serialize the parameter using the container's parameterSerializer. If there is no serializer for this container, return null.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - uri</dd> |
| <dd><code>call</code> - call</dd> |
| <dd><code>callable</code> - callable</dd> |
| <dd><code>defaultParameter</code> - default parameter</dd> |
| <dd><code>parameterValue</code> - parameter value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IRemoteCallParameter the serialized parameter or null if there is no parameterSerializer for this container</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></code> - thrown if parameters cannot be serialized</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="IRemoteCallParameterSerializer.html#serializeParameter(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable,org.eclipse.ecf.remoteservice.client.IRemoteCallParameter,java.lang.Object)"><code>IRemoteCallParameterSerializer.serializeParameter(String, IRemoteCall, IRemoteCallable, IRemoteCallParameter, Object)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="serializeParameter(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable,java.util.List,java.lang.Object[])">serializeParameter</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="IRemoteCallParameter.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallParameter</a>[]</span> <span class="memberName">serializeParameter</span>​(<span class="arguments"><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> uri, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a> currentParameters, |
| <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>[] parameterValue)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></span></div> |
| <div class="block">Serialize the parameter using the container's parameterSerializer. If there is no serializer for this container, return null.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - uri</dd> |
| <dd><code>call</code> - call</dd> |
| <dd><code>callable</code> - callable</dd> |
| <dd><code>currentParameters</code> - current parameters</dd> |
| <dd><code>parameterValue</code> - parameter value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IRemoteCallParameter[] parameters for given</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></code> - thrown if parameters cannot be serialized</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="processResponse(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable,java.util.Map,byte[])">processResponse</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><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></span> <span class="memberName">processResponse</span>​(<span class="arguments"><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> uri, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable, |
| <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> responseHeaders, |
| byte[] responseBody)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></span></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - uri</dd> |
| <dd><code>call</code> - call</dd> |
| <dd><code>callable</code> - callable</dd> |
| <dd><code>responseHeaders</code> - http response headers</dd> |
| <dd><code>responseBody</code> - response body as byte[]</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Object response deserialized via response deserializer</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></code> - if response cannot be deserialized for processing</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createRemoteService(org.eclipse.ecf.remoteservice.client.RemoteServiceClientRegistration)">createRemoteService</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../IRemoteService.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteService</a></span> <span class="memberName">createRemoteService</span>​(<span class="arguments"><a href="RemoteServiceClientRegistration.html" title="class in org.eclipse.ecf.remoteservice.client">RemoteServiceClientRegistration</a> registration)</span></div> |
| <div class="block">Create a remote service for a given remote service registration. This method will be |
| called as part of the RemoteServiceAdmin.importService.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>registration</code> - the remote service client registration associated with the service |
| being imported. Will not be <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="prepareEndpointAddress(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareEndpointAddress</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected abstract</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">prepareEndpointAddress</span>​(<span class="arguments"><a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</span></div> |
| <div class="block">Prepare an endpoint address for the given call and callable.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>call</code> - to create an endpoint for. Will not be <code>null</code>.</dd> |
| <dd><code>callable</code> - to create an endpoing for. Will not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String that represents the endpoing for the given call and callable. May only return <code>null</code> if the |
| given call should not be completed (i.e. there is no endpoint associated with the given call).</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createUriRequest(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">createUriRequest</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="AbstractClientService.UriRequest.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientService.UriRequest</a></span> <span class="memberName">createUriRequest</span>​(<span class="arguments"><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> endpoint, |
| <a href="../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</span></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endpoint</code> - endpoint</dd> |
| <dd><code>call</code> - call</dd> |
| <dd><code>callable</code> - callable</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>UriRequest to use for request. May be <code>null</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.5</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/AbstractClientContainer.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </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> |
