| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 --> |
| <title>AbstractRestClientContainer (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.rest.client, class: AbstractRestClientContainer"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":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/AbstractRestClientContainer.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><a href="#nested.class.summary">Nested</a> | </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.rest.client</a></div> |
| <h1 title="Class AbstractRestClientContainer" class="title">Class AbstractRestClientContainer</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"><a href="../../client/AbstractClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">org.eclipse.ecf.remoteservice.client.AbstractClientContainer</a> |
| <div class="inheritance">org.eclipse.ecf.remoteservice.rest.client.AbstractRestClientContainer</div> |
| </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="../../client/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="RestClientContainer.html" title="class in org.eclipse.ecf.remoteservice.rest.client">RestClientContainer</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">AbstractRestClientContainer</span> |
| extends <a href="../../client/AbstractClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientContainer</a></pre> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="nestedClassSummary"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h2>Nested Class Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractRestClientContainer.RestRemoteServiceClientRegistration.html" title="class in org.eclipse.ecf.remoteservice.rest.client">AbstractRestClientContainer.RestRemoteServiceClientRegistration</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SLASH">SLASH</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="inheritedList"> |
| <h3>Fields inherited from class org.eclipse.ecf.remoteservice.client.<a href="../../client/AbstractClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientContainer</a></h3> |
| <a id="fields.inherited.from.class.org.eclipse.ecf.remoteservice.client.AbstractClientContainer"> |
| <!-- --> |
| </a><code><a href="../../client/AbstractClientContainer.html#alwaysSendDefaultParameters">alwaysSendDefaultParameters</a>, <a href="../../client/AbstractClientContainer.html#connectContext">connectContext</a>, <a href="../../client/AbstractClientContainer.html#connectedID">connectedID</a>, <a href="../../client/AbstractClientContainer.html#connectLock">connectLock</a>, <a href="../../client/AbstractClientContainer.html#containerID">containerID</a>, <a href="../../client/AbstractClientContainer.html#parameterSerializer">parameterSerializer</a>, <a href="../../client/AbstractClientContainer.html#parameterSerializerLock">parameterSerializerLock</a>, <a href="../../client/AbstractClientContainer.html#registry">registry</a>, <a href="../../client/AbstractClientContainer.html#remoteResponseDeserializer">remoteResponseDeserializer</a>, <a href="../../client/AbstractClientContainer.html#remoteResponseDeserializerLock">remoteResponseDeserializerLock</a>, <a href="../../client/AbstractClientContainer.html#remoteServiceFactory">remoteServiceFactory</a>, <a href="../../client/AbstractClientContainer.html#remoteServiceListeners">remoteServiceListeners</a></code></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.remoteservice.rest.identity.RestID)">AbstractRestClientContainer</a></span>​(<a href="../identity/RestID.html" title="class in org.eclipse.ecf.remoteservice.rest.identity">RestID</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>protected abstract <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="../../client/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="i1"> |
| <td class="colFirst"><code>protected <a href="../../client/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="../../client/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="i2"> |
| <td class="colFirst"><code>protected <a href="../../client/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="../../client/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="i3"> |
| <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="#getConnectNamespace()">getConnectNamespace</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the Namespace for creating a targetID suitable for use as the first |
| parameter in subsequent calls to <a href="../../../core/IContainer.html#connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)"><code>IContainer.connect(ID, IConnectContext)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <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="i5"> |
| <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="i6"> |
| <td class="colFirst"><code>protected <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="#prepareBaseUri(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareBaseUri</a></span>​(<a href="../../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="../../client/IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code><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="../../client/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="altColor" id="i8"> |
| <td class="colFirst"><code>protected <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="#prepareResourcePath(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareResourcePath</a></span>​(<a href="../../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="../../client/IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRemoteServiceCallPolicy(org.eclipse.ecf.remoteservice.IRemoteServiceCallPolicy)">setRemoteServiceCallPolicy</a></span>​(<a href="../../IRemoteServiceCallPolicy.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceCallPolicy</a> policy)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the remote service call policy to enable authorization on remote service method calls</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code>protected <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="#substituteParameters(java.lang.String,java.lang.Object%5B%5D)">substituteParameters</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> path, |
| <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>[] parameters)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <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="#transformTarget(org.eclipse.ecf.core.identity.ID,java.lang.String)">transformTarget</a></span>​(<a href="../../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> originalTarget, |
| <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"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class org.eclipse.ecf.remoteservice.client.<a href="../../client/AbstractClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientContainer</a></h3> |
| <a id="methods.inherited.from.class.org.eclipse.ecf.remoteservice.client.AbstractClientContainer"> |
| <!-- --> |
| </a><code><a href="../../client/AbstractClientContainer.html#addRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">addRemoteServiceListener</a>, <a href="../../client/AbstractClientContainer.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a>, <a href="../../client/AbstractClientContainer.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a>, <a href="../../client/AbstractClientContainer.html#asyncGetRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">asyncGetRemoteServiceReferences</a>, <a href="../../client/AbstractClientContainer.html#connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)">connect</a>, <a href="../../client/AbstractClientContainer.html#createRemoteFilter(java.lang.String)">createRemoteFilter</a>, <a href="../../client/AbstractClientContainer.html#createUriRequest(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">createUriRequest</a>, <a href="../../client/AbstractClientContainer.html#disconnect()">disconnect</a>, <a href="../../client/AbstractClientContainer.html#dispose()">dispose</a>, <a href="../../client/AbstractClientContainer.html#getAllRemoteServiceReferences(java.lang.String,java.lang.String)">getAllRemoteServiceReferences</a>, <a href="../../client/AbstractClientContainer.html#getConnectContextForAuthentication()">getConnectContextForAuthentication</a>, <a href="../../client/AbstractClientContainer.html#getConnectedID()">getConnectedID</a>, <a href="../../client/AbstractClientContainer.html#getID()">getID</a>, <a href="../../client/AbstractClientContainer.html#getParameterSerializer()">getParameterSerializer</a>, <a href="../../client/AbstractClientContainer.html#getParameterSerializer(org.eclipse.ecf.remoteservice.client.IRemoteCallParameter,java.lang.Object)">getParameterSerializer</a>, <a href="../../client/AbstractClientContainer.html#getRemoteCallTargetID()">getRemoteCallTargetID</a>, <a href="../../client/AbstractClientContainer.html#getRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)">getRemoteService</a>, <a href="../../client/AbstractClientContainer.html#getRemoteServiceID(org.eclipse.ecf.core.identity.ID,long)">getRemoteServiceID</a>, <a href="../../client/AbstractClientContainer.html#getRemoteServiceNamespace()">getRemoteServiceNamespace</a>, <a href="../../client/AbstractClientContainer.html#getRemoteServiceReference(org.eclipse.ecf.remoteservice.IRemoteServiceID)">getRemoteServiceReference</a>, <a href="../../client/AbstractClientContainer.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID%5B%5D,java.lang.String,java.lang.String)">getRemoteServiceReferences</a>, <a href="../../client/AbstractClientContainer.html#getResponseDeserializer()">getResponseDeserializer</a>, <a href="../../client/AbstractClientContainer.html#getResponseDeserializer(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable,java.util.Map)">getResponseDeserializer</a>, <a href="../../client/AbstractClientContainer.html#logException(java.lang.String,java.lang.Throwable)">logException</a>, <a href="../../client/AbstractClientContainer.html#prepareCallParameters(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareCallParameters</a>, <a href="../../client/AbstractClientContainer.html#prepareExtraParameters(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareExtraParameters</a>, <a href="../../client/AbstractClientContainer.html#prepareParameters(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareParameters</a>, <a href="../../client/AbstractClientContainer.html#processResponse(java.lang.String,org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable,java.util.Map,byte%5B%5D)">processResponse</a>, <a href="../../client/AbstractClientContainer.html#registerCallables(java.lang.Class,org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D,java.util.Dictionary)">registerCallables</a>, <a href="../../client/AbstractClientContainer.html#registerCallables(java.lang.String%5B%5D,org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D%5B%5D,java.util.Dictionary)">registerCallables</a>, <a href="../../client/AbstractClientContainer.html#registerCallables(org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D,java.util.Dictionary)">registerCallables</a>, <a href="../../client/AbstractClientContainer.html#registerRemoteService(java.lang.String%5B%5D,java.lang.Object,java.util.Dictionary)">registerRemoteService</a>, <a href="../../client/AbstractClientContainer.html#removeRemoteServiceListener(org.eclipse.ecf.remoteservice.IRemoteServiceListener)">removeRemoteServiceListener</a>, <a href="../../client/AbstractClientContainer.html#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>, <a href="../../client/AbstractClientContainer.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)">serializeParameter</a>, <a href="../../client/AbstractClientContainer.html#setAlwaysSendDefaultParameters(boolean)">setAlwaysSendDefaultParameters</a>, <a href="../../client/AbstractClientContainer.html#setConnectContextForAuthentication(org.eclipse.ecf.core.security.IConnectContext)">setConnectContextForAuthentication</a>, <a href="../../client/AbstractClientContainer.html#setParameterSerializer(org.eclipse.ecf.remoteservice.client.IRemoteCallParameterSerializer)">setParameterSerializer</a>, <a href="../../client/AbstractClientContainer.html#setRemoteServiceFactory(org.eclipse.ecf.remoteservice.client.IRemoteServiceFactory)">setRemoteServiceFactory</a>, <a href="../../client/AbstractClientContainer.html#setResponseDeserializer(org.eclipse.ecf.remoteservice.client.IRemoteResponseDeserializer)">setResponseDeserializer</a>, <a href="../../client/AbstractClientContainer.html#ungetRemoteService(org.eclipse.ecf.remoteservice.IRemoteServiceReference)">ungetRemoteService</a></code></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> |
| </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="SLASH">SLASH</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">SLASH</span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.eclipse.ecf.remoteservice.rest.client.AbstractRestClientContainer.SLASH">Constant Field Values</a></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.remoteservice.rest.identity.RestID)">AbstractRestClientContainer</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">AbstractRestClientContainer</span>​(<span class="arguments"><a href="../identity/RestID.html" title="class in org.eclipse.ecf.remoteservice.rest.identity">RestID</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="setRemoteServiceCallPolicy(org.eclipse.ecf.remoteservice.IRemoteServiceCallPolicy)">setRemoteServiceCallPolicy</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">setRemoteServiceCallPolicy</span>​(<span class="arguments"><a href="../../IRemoteServiceCallPolicy.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteServiceCallPolicy</a> policy)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../IRemoteServiceContainerAdapter.html#setRemoteServiceCallPolicy(org.eclipse.ecf.remoteservice.IRemoteServiceCallPolicy)">IRemoteServiceContainerAdapter</a></code></span></div> |
| <div class="block">Set the remote service call policy to enable authorization on remote service method calls</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>policy</code> - Implementation of <code>IRemoteServiceCallPolicy</code> containing authorization specific code</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the underlying provider supports using the policy, <code>false</code> if |
| it does not support using the policy.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getConnectNamespace()">getConnectNamespace</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">getConnectNamespace</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../core/IContainer.html#getConnectNamespace()">IContainer</a></code></span></div> |
| <div class="block">Get the Namespace for creating a targetID suitable for use as the first |
| parameter in subsequent calls to <a href="../../../core/IContainer.html#connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)"><code>IContainer.connect(ID, IConnectContext)</code></a>. |
| If this method returns <code>null</code>, then it means that |
| <code>null</code> is expected as a valid parameter in subsequent calls |
| to <a href="../../../core/IContainer.html#connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)"><code>IContainer.connect(ID, IConnectContext)</code></a>. If this method returns a non-<code>null</code> |
| Namespace, then the <code>targetID</code> parameter in |
| <a href="../../../core/IContainer.html#connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)"><code>IContainer.connect(ID, IConnectContext)</code></a> must be non-<code>null</code> |
| instance created of the returned Namespace.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Namespace the namespace associated with subsequent calls to |
| <a href="../../../core/IContainer.html#connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)"><code>IContainer.connect(ID, IConnectContext)</code></a>. If <code>null</code>, |
| then the <code>targetID</code> instances passed to |
| <a href="../../../core/IContainer.html#connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)"><code>IContainer.connect(ID, IConnectContext)</code></a> may be <code>null</code>. |
| If not <code>null</code>, then <code>targetID</code> |
| instances passed to <a href="../../../core/IContainer.html#connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)"><code>IContainer.connect(ID, IConnectContext)</code></a> must be |
| instances of the returned Namespace.</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 abstract</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="../../client/RemoteServiceClientRegistration.html" title="class in org.eclipse.ecf.remoteservice.client">RemoteServiceClientRegistration</a> registration)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../client/AbstractClientContainer.html#createRemoteService(org.eclipse.ecf.remoteservice.client.RemoteServiceClientRegistration)">AbstractClientContainer</a></code></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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../client/AbstractClientContainer.html#createRemoteService(org.eclipse.ecf.remoteservice.client.RemoteServiceClientRegistration)">createRemoteService</a></code> in class <code><a href="../../client/AbstractClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientContainer</a></code></dd> |
| <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="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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../client/AbstractClientContainer.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 class <code><a href="../../client/AbstractClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientContainer</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> |
| </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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../client/AbstractClientContainer.html#getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID,java.lang.String,java.lang.String)">getRemoteServiceReferences</a></code> in class <code><a href="../../client/AbstractClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientContainer</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="transformTarget(org.eclipse.ecf.core.identity.ID,java.lang.String)">transformTarget</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">transformTarget</span>​(<span class="arguments"><a href="../../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> originalTarget, |
| <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> |
| <dl> |
| <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></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="prepareBaseUri(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareBaseUri</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/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">prepareBaseUri</span>​(<span class="arguments"><a href="../../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="../../client/IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="prepareResourcePath(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareResourcePath</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/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">prepareResourcePath</span>​(<span class="arguments"><a href="../../IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="../../client/IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="substituteParameters(java.lang.String,java.lang.Object[])">substituteParameters</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/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">substituteParameters</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> path, |
| <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>[] parameters)</span></div> |
| </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">public</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="../../client/IRemoteCallable.html" title="interface in org.eclipse.ecf.remoteservice.client">IRemoteCallable</a> callable)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../client/AbstractClientContainer.html#prepareEndpointAddress(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">AbstractClientContainer</a></code></span></div> |
| <div class="block">Prepare an endpoint address for the given call and callable.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../client/AbstractClientContainer.html#prepareEndpointAddress(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.client.IRemoteCallable)">prepareEndpointAddress</a></code> in class <code><a href="../../client/AbstractClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientContainer</a></code></dd> |
| <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="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="../../client/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="../../client/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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../client/AbstractClientContainer.html#createRestServiceRegistration(java.lang.String%5B%5D,org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D%5B%5D,java.util.Dictionary)">createRestServiceRegistration</a></code> in class <code><a href="../../client/AbstractClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientContainer</a></code></dd> |
| </dl> |
| </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="../../client/RemoteServiceClientRegistration.html" title="class in org.eclipse.ecf.remoteservice.client">RemoteServiceClientRegistration</a></span> <span class="memberName">createRestServiceRegistration</span>​(<span class="arguments"><a href="../../client/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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../client/AbstractClientContainer.html#createRestServiceRegistration(org.eclipse.ecf.remoteservice.client.IRemoteCallable%5B%5D,java.util.Dictionary)">createRestServiceRegistration</a></code> in class <code><a href="../../client/AbstractClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientContainer</a></code></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/AbstractRestClientContainer.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><a href="#nested.class.summary">Nested</a> | </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> |
