blob: 73f01425516cb24d1275a1d9de28c0901c8e0ebf [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 -->
<title>ISharedObjectContainer (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.core.sharedobject, interface: ISharedObjectContainer">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var data = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ISharedObjectContainer.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
</nav>
</header>
<div class="flexContent">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.ecf.core.sharedobject</a></div>
<h1 title="Interface ISharedObjectContainer" class="title">Interface ISharedObjectContainer</h1>
</div>
<div class="contentContainer">
<section class="description">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code>org.eclipse.core.runtime.IAdaptable</code>, <code><a href="../IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></code>, <code><a href="../identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></code>, <code><a href="../IReliableContainer.html" title="interface in org.eclipse.ecf.core">IReliableContainer</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../provider/generic/ClientSOContainer.html" title="class in org.eclipse.ecf.provider.generic">ClientSOContainer</a></code>, <code><a href="../../provider/remoteservice/generic/RemoteServiceContainer.html" title="class in org.eclipse.ecf.provider.remoteservice.generic">RemoteServiceContainer</a></code>, <code><a href="../../provider/generic/ServerSOContainer.html" title="class in org.eclipse.ecf.provider.generic">ServerSOContainer</a></code>, <code><a href="../../remoteservice/servlet/ServletServerContainer.html" title="class in org.eclipse.ecf.remoteservice.servlet">ServletServerContainer</a></code>, <code><a href="../../provider/generic/SOContainer.html" title="class in org.eclipse.ecf.provider.generic">SOContainer</a></code>, <code><a href="../../provider/generic/SSLClientSOContainer.html" title="class in org.eclipse.ecf.provider.generic">SSLClientSOContainer</a></code>, <code><a href="../../provider/generic/SSLServerSOContainer.html" title="class in org.eclipse.ecf.provider.generic">SSLServerSOContainer</a></code>, <code><a href="../../provider/generic/TCPClientSOContainer.html" title="class in org.eclipse.ecf.provider.generic">TCPClientSOContainer</a></code>, <code><a href="../../provider/generic/TCPServerSOContainer.html" title="class in org.eclipse.ecf.provider.generic">TCPServerSOContainer</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">ISharedObjectContainer</span>
extends <a href="../IReliableContainer.html" title="interface in org.eclipse.ecf.core">IReliableContainer</a></pre>
<div class="block">Core interface that must be implemented by all ECF container instances.
Instances are typically created via <a href="SharedObjectContainerFactory.html" title="class in org.eclipse.ecf.core.sharedobject"><code>SharedObjectContainerFactory</code></a></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject"><code>ISharedObject</code></a>,
<a href="ISharedObjectManager.html" title="interface in org.eclipse.ecf.core.sharedobject"><code>ISharedObjectManager</code></a></dd>
</dl>
</section>
<section class="summary">
<ul class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code><a href="ISharedObjectManager.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSharedObjectManager()">getSharedObjectManager</a></span>()</code></th>
<td class="colLast">
<div class="block">Get SharedObjectManager for this container</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSharedObjectMessageSerializer(org.eclipse.ecf.core.sharedobject.util.ISharedObjectMessageSerializer)">setSharedObjectMessageSerializer</a></span>&#8203;(<a href="util/ISharedObjectMessageSerializer.html" title="interface in org.eclipse.ecf.core.sharedobject.util">ISharedObjectMessageSerializer</a>&nbsp;serializer)</code></th>
<td class="colLast">
<div class="block">
Set the shared object message serializer.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;org.eclipse.ecf.core.<a href="../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="../IContainer.html#addListener(org.eclipse.ecf.core.IContainerListener)">addListener</a>, <a href="../IContainer.html#connect(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.security.IConnectContext)">connect</a>, <a href="../IContainer.html#disconnect()">disconnect</a>, <a href="../IContainer.html#dispose()">dispose</a>, <a href="../IContainer.html#getAdapter(java.lang.Class)">getAdapter</a>, <a href="../IContainer.html#getConnectedID()">getConnectedID</a>, <a href="../IContainer.html#getConnectNamespace()">getConnectNamespace</a>, <a href="../IContainer.html#removeListener(org.eclipse.ecf.core.IContainerListener)">removeListener</a></code></div>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;org.eclipse.ecf.core.identity.<a href="../identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></h3>
<a id="methods.inherited.from.class.org.eclipse.ecf.core.identity.IIdentifiable">
<!-- -->
</a><code><a href="../identity/IIdentifiable.html#getID()">getID</a></code></div>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;org.eclipse.ecf.core.<a href="../IReliableContainer.html" title="interface in org.eclipse.ecf.core">IReliableContainer</a></h3>
<a id="methods.inherited.from.class.org.eclipse.ecf.core.IReliableContainer">
<!-- -->
</a><code><a href="../IReliableContainer.html#getGroupMemberIDs()">getGroupMemberIDs</a>, <a href="../IReliableContainer.html#isGroupManager()">isGroupManager</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<li class="blockList">
<section class="methodDetails"><a id="method.detail">
<!-- -->
</a>
<h2>Method Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="getSharedObjectManager()">getSharedObjectManager</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ISharedObjectManager.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectManager</a></span>&nbsp;<span class="memberName">getSharedObjectManager</span>()</div>
<div class="block">Get SharedObjectManager for this container</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ISharedObjectManager for this container instance</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="setSharedObjectMessageSerializer(org.eclipse.ecf.core.sharedobject.util.ISharedObjectMessageSerializer)">setSharedObjectMessageSerializer</a></h3>
<div class="memberSignature"><span class="returnType">void</span>&nbsp;<span class="memberName">setSharedObjectMessageSerializer</span>&#8203;(<span class="arguments"><a href="util/ISharedObjectMessageSerializer.html" title="interface in org.eclipse.ecf.core.sharedobject.util">ISharedObjectMessageSerializer</a>&nbsp;serializer)</span></div>
<div class="block"><p>
Set the shared object message serializer. The serializer should not be <code>null</code>.
</p>
<p>
Note that users of this method should guarantee that their are not pending messages
to be sent/received...typically by <b>only</b> calling this method prior to connecting/being
connected to from remote containers.
</p>
<p>
Note also that the serializer must perform well when it's methods are called, to prevent
negatively impacting overall container messaging performance.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ISharedObjectContainer.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>