blob: 975a98dbc20ff20280d9a9e02463db7f9e9b9f46 [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>org.eclipse.ecf.core.sharedobject (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">
<meta name="generator" content="javadoc/PackageWriterImpl">
<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="package-declaration">
<script type="text/javascript">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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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 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">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.eclipse.ecf.core.sharedobject</h1>
</div>
<div class="contentContainer">
<section class="summary">
<ul class="blockList">
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IReplicaSharedObjectDescriptionFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">IReplicaSharedObjectDescriptionFactory</a></th>
<td class="colLast">
<div class="block">Replica shared object factory</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObject</a></th>
<td class="colLast">
<div class="block">Core interface for implementing components that exist within
<a href="ISharedObjectContainer.html" title="interface in org.eclipse.ecf.core.sharedobject"><code>ISharedObjectContainer</code></a></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ISharedObjectConfig.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectConfig</a></th>
<td class="colLast">
<div class="block">Configuration information provided to ISharedObject via its enclosing
ISharedObjectContainer</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ISharedObjectConnector.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectConnector</a></th>
<td class="colLast">
<div class="block">Implementers which represent the one-way associations between SharedObject
instances within the scope of a given ISharedObjectContainer</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ISharedObjectContainer.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectContainer</a></th>
<td class="colLast">
<div class="block">Core interface that must be implemented by all ECF container instances.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ISharedObjectContainerClient.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectContainerClient</a></th>
<td class="colLast">
<div class="block">Interface for shared object containers that are clients rather than group
manager</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ISharedObjectContainerConfig.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectContainerConfig</a></th>
<td class="colLast">
<div class="block">Configuration information associated with ISharedObjectContainer.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ISharedObjectContainerFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectContainerFactory</a></th>
<td class="colLast">
<div class="block">Factory contract for <a href="SharedObjectContainerFactory.html" title="class in org.eclipse.ecf.core.sharedobject"><code>SharedObjectContainerFactory</code></a></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ISharedObjectContainerGroupManager.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectContainerGroupManager</a></th>
<td class="colLast">
<div class="block">Contract for shared object container group manager (e.g.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ISharedObjectContainerTransaction.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectContainerTransaction</a></th>
<td class="colLast">
<div class="block">Implementers represent a transaction associated with the creation of a
SharedObject within the scope of a given SharedObjectContainer</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ISharedObjectContext.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectContext</a></th>
<td class="colLast">
<div class="block">Context reference provided to all ISharedObjects upon initialization.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ISharedObjectFactory.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectFactory</a></th>
<td class="colLast">
<div class="block">Container factory contract <a href="SharedObjectFactory.html" title="class in org.eclipse.ecf.core.sharedobject"><code>SharedObjectFactory</code></a> for default
implementation.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ISharedObjectManager.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectManager</a></th>
<td class="colLast">
<div class="block">Manager for creating, disposing, and accessing ISharedObjects from an
ISharedObjectContainer.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ISharedObjectTransactionConfig.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectTransactionConfig</a></th>
<td class="colLast">
<div class="block">Transaction configuration information</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ISharedObjectTransactionParticipantsFilter.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectTransactionParticipantsFilter</a></th>
<td class="colLast">
<div class="block">Filter for determining transaction participants</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AbstractSharedObjectContainerAdapterFactory.html" title="class in org.eclipse.ecf.core.sharedobject">AbstractSharedObjectContainerAdapterFactory</a></th>
<td class="colLast">
<div class="block">Abstract container adapter factory.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">BaseSharedObject</a></th>
<td class="colLast">
<div class="block">Base class for shared object classes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="OptimisticSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">OptimisticSharedObject</a></th>
<td class="colLast">
<div class="block">Superclass for shared object classes that replicate themselves
optimistically.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ReplicaSharedObjectDescription.html" title="class in org.eclipse.ecf.core.sharedobject">ReplicaSharedObjectDescription</a></th>
<td class="colLast">
<div class="block">Description of a remote ISharedObject instance.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SharedObjectContainerFactory.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectContainerFactory</a></th>
<td class="colLast">
<div class="block">Factory for creating <a href="ISharedObjectContainer.html" title="interface in org.eclipse.ecf.core.sharedobject"><code>ISharedObjectContainer</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SharedObjectDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectDescription</a></th>
<td class="colLast">
<div class="block">Description of a local ISharedObject instance.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SharedObjectFactory.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectFactory</a></th>
<td class="colLast">
<div class="block">Factory for creating <a href="ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject"><code>ISharedObject</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SharedObjectMsg.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectMsg</a></th>
<td class="colLast">
<div class="block">Shared Object Message.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SharedObjectMsgEvent.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectMsgEvent</a></th>
<td class="colLast">
<div class="block">Event type to represent messages sent between shared objects</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SharedObjectMsgEventProcessor.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectMsgEventProcessor</a></th>
<td class="colLast">
<div class="block">Event processor to process SharedObjectMsgEvents</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SharedObjectTypeDescription.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectTypeDescription</a></th>
<td class="colLast">
<div class="block">Description of shared object type.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TransactionSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">TransactionSharedObject</a></th>
<td class="colLast">
<div class="block">Superclass for shared object classes that replicate themselves
transactionally.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TransactionSharedObjectConfiguration.html" title="class in org.eclipse.ecf.core.sharedobject">TransactionSharedObjectConfiguration</a></th>
<td class="colLast">
<div class="block">Configuration parameters for transaction shared object creation and
replication.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TwoPhaseCommitEventProcessor.html" title="class in org.eclipse.ecf.core.sharedobject">TwoPhaseCommitEventProcessor</a></th>
<td class="colLast">
<div class="block">Implementation of two-phase commit for transactional replication of shared
objects.</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SharedObjectAddAbortException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectAddAbortException</a></th>
<td class="colLast">
<div class="block">Exception thrown during transactional add of shared object</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SharedObjectAddException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectAddException</a></th>
<td class="colLast">
<div class="block">Exception thrown upon shared object add to container</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SharedObjectConnectException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectConnectException</a></th>
<td class="colLast">
<div class="block">Exception thrown when creating connector between shared object</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SharedObjectCreateException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectCreateException</a></th>
<td class="colLast">
<div class="block">Exception thrown upon shared object create by <a href="ISharedObjectManager.html" title="interface in org.eclipse.ecf.core.sharedobject"><code>ISharedObjectManager</code></a></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SharedObjectDisconnectException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectDisconnectException</a></th>
<td class="colLast">
<div class="block">Exception thrown upon
<a href="ISharedObjectManager.html#disconnectSharedObjects(org.eclipse.ecf.core.sharedobject.ISharedObjectConnector)"><code>ISharedObjectManager.disconnectSharedObjects(ISharedObjectConnector)</code></a></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SharedObjectInitException.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectInitException</a></th>
<td class="colLast">
<div class="block">Exception thrown during calls to
<a href="ISharedObject.html#init(org.eclipse.ecf.core.sharedobject.ISharedObjectConfig)"><code>ISharedObject.init(ISharedObjectConfig)</code></a></div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
</ul>
</section>
</div>
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>