ColumnTypeModifier instances.IllegalStateException that can be thrown from StoreThreadLocal.getSession().IllegalStateException that can be thrown from StoreThreadLocal.getSession().
diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/spi/common/model/InternalCDOClassInfo.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/spi/common/model/InternalCDOClassInfo.html
index 3dd9e7c5d2..a48099f578 100644
--- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/spi/common/model/InternalCDOClassInfo.html
+++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/spi/common/model/InternalCDOClassInfo.html
@@ -109,6 +109,10 @@ Interface InternalCDOClassInfo
++If the meaning of this type isn't clear, there really should be more of a description here... +
+
+A concrete subclass of CDODataInputImpl.
+
+
CDODataInputImpl.Default
CDODataInputImpl.
CDODataInputImpl.
diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/spi/common/protocol/package-summary.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/spi/common/protocol/package-summary.html
index cb4361f9df..a3fff970af 100644
--- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/spi/common/protocol/package-summary.html
+++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/spi/common/protocol/package-summary.html
@@ -110,7 +110,7 @@ Common base implementations for dealing with I/O of CDO data structures.
CDODataInputImpl.
+A mixin interface for InternalCDOList that allows to optimize the speed of equality checks.
+
+
InternalCDOList.ConfigurableEquality
InternalCDOList that allows to optimize the speed of equality checks.
InternalCDOList that allows to optimize the speed of equality checks.
diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/spi/common/revision/package-summary.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/spi/common/revision/package-summary.html
index f6fc69ec3a..1f6de13a99 100644
--- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/spi/common/revision/package-summary.html
+++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/spi/common/revision/package-summary.html
@@ -178,7 +178,7 @@ Common service provider interfaces and useful base implementations for dealing w
InternalCDOList that allows to optimize the speed of equality checks.
+A utility class that, when associated with a transaction, automatically updates the
+ commit comment according to local model modifications.
+
+
transaction, automatically updates the
+ commit comment according to local model modifications.
+Provides the content of a CommitHistoryComposite, i.e., the elements of a CDOCommitHistory.
+
+
+Encapsulates the input of a CommitHistoryComposite.
+
+
+A TableLabelProvider for the content of a CommitHistoryComposite, i.e., the elements of a CDOCommitHistory.
+
+
+A UI component that renders a the elements of a CDOCommitHistory in form of a commit table with a branch tree.
+
+
CommitHistoryComposite.ContentProvider
CDOCommitHistory.
CommitHistoryComposite.Input
CommitHistoryComposite.
CommitHistoryComposite.LabelProvider
TableLabelProvider for the content of a CommitHistoryComposite, i.e., the elements of a CDOCommitHistory.
CDOCommitHistory in form of a commit table with a branch tree.CDOCommitHistory.CommitHistoryComposite.TableLabelProvider for the content of a CommitHistoryComposite, i.e., the elements of a CDOCommitHistory.CDOCommitHistory.
CommitHistoryComposite.
TableLabelProvider for the content of a CommitHistoryComposite, i.e., the elements of a CDOCommitHistory.
+Enumerates the possible sides of a merge, i.e., SOURCE and TARGET.
+
+
DefaultCDOMerger.PerFeature.ManyValued.Side
DefaultCDOMerger.PerFeature.ManyValued.Side.SOURCE and DefaultCDOMerger.PerFeature.ManyValued.Side.TARGET.DefaultCDOMerger.PerFeature.ManyValued.Side.SOURCE and DefaultCDOMerger.PerFeature.ManyValued.Side.TARGET.DefaultCDOMerger.PerFeature.ManyValued.Side.SOURCE and DefaultCDOMerger.PerFeature.ManyValued.Side.TARGET.
@@ -20,7 +24,7 @@ package org.eclipse.emf.cdo.doc; *
* CDO supports plentyfold deployments such as embedded repositories, offline clones or replicated clusters. The * following diagram illustrates the most common scenario: {@img cdo-overview.png} - * + * * @default * @author Eike Stepper */ @@ -86,6 +90,11 @@ public class Overview *
+ *
*
* {@link org.eclipse.emf.cdo.doc.programmers.client.Architecture !!inline!!} - * + * * @see org.eclipse.emf.cdo.doc.programmers.client.Architecture */ public class Client @@ -142,7 +151,7 @@ public class Overview * Repository Architecture *
* {@link org.eclipse.emf.cdo.doc.programmers.server.Architecture !!inline!!} - * + * * @see org.eclipse.emf.cdo.doc.programmers.server.Architecture */ public class Repository diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/client/Architecture.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/client/Architecture.java index 58118575c1..a0e91b669d 100644 --- a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/client/Architecture.java +++ b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/client/Architecture.java @@ -4,13 +4,44 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * Eike Stepper - initial API and implementation */ package org.eclipse.emf.cdo.doc.programmers.client; +import org.eclipse.emf.cdo.CDOObject; +import org.eclipse.emf.cdo.common.branch.CDOBranch; +import org.eclipse.emf.cdo.common.branch.CDOBranchManager; +import org.eclipse.emf.cdo.common.commit.CDOCommitInfo; +import org.eclipse.emf.cdo.common.commit.CDOCommitInfoManager; +import org.eclipse.emf.cdo.common.model.CDOPackageRegistry; +import org.eclipse.emf.cdo.common.revision.CDORevision; +import org.eclipse.emf.cdo.common.revision.CDORevisionCache; +import org.eclipse.emf.cdo.common.revision.CDORevisionManager; +import org.eclipse.emf.cdo.server.IRepository; +import org.eclipse.emf.cdo.session.CDOSession; +import org.eclipse.emf.cdo.transaction.CDOTransaction; +import org.eclipse.emf.cdo.view.CDOView; + +import org.eclipse.net4j.buffer.IBuffer; +import org.eclipse.net4j.connector.IConnector; +import org.eclipse.net4j.http.common.IHTTPConnector; +import org.eclipse.net4j.jvm.IJVMConnector; +import org.eclipse.net4j.signal.ISignalProtocol; +import org.eclipse.net4j.tcp.ITCPConnector; +import org.eclipse.net4j.tcp.ssl.SSLUtil; +import org.eclipse.net4j.util.container.IPluginContainer; +import org.eclipse.net4j.util.factory.IFactory; +import org.eclipse.net4j.util.om.OMPlatform; +import org.eclipse.net4j.util.om.log.OMLogger; +import org.eclipse.net4j.util.om.monitor.OMMonitor; +import org.eclipse.net4j.util.om.pref.OMPreference; +import org.eclipse.net4j.util.om.trace.OMTracer; + import org.eclipse.emf.ecore.EObject; +import org.eclipse.emf.ecore.EPackage; +import org.eclipse.emf.spi.cdo.CDOSessionProtocol; /** * Understanding the Architecture of a Client Application @@ -22,7 +53,7 @@ import org.eclipse.emf.ecore.EObject; * dependendcies on CDO to your application code. *
* The following diagram illustrates the major building blocks of a CDO application: {@img application-architecture.png} - * + * * @author Eike Stepper */ public class Architecture @@ -30,7 +61,16 @@ public class Architecture /** * OSGi *
- * The Open Services Gateway Initiative (OSGi)... + * All components of CDO are implemented as OSGi bundles. The core components of + * both clients and servers do not require OSGi to actually run to be functional, they can perfectly be operated + * stand-alone. If OSGi is running the setup and configuration of some CDO facilities is a little simpler than in + * stand-alone mode because the needed {@link IFactory factories} get automatically registered with the central + * {@link IPluginContainer wiring container}. + *
+ * CDO utilizes an {@link OMPlatform operations and maintenance} framework to abstract common platform services such + * as {@link OMLogger logging}, {@link OMTracer tracing}, {@link OMMonitor monitoring} and {@link OMPreference + * configuration}. Without the need to depend on additional external libraries these services integrate seamlessly + * with OSGi, if available at runtime, or emulate similar functionality if running stand-alone. */ public class OSGi { @@ -38,6 +78,11 @@ public class Architecture /** * EMF + *
+ * The Eclipse Modeling Framework is a modeling framework and code + * generation facility for building tools and other applications based on a structured data model. From a model + * specification described in XMI, EMF provides tools and runtime support to produce a set of Java classes for the model, + * along with a set of adapter classes that enable viewing and command-based editing of the model, and a basic editor. */ public class EMF { @@ -45,6 +90,27 @@ public class Architecture /** * CDO Client + *
+ * The CDO client enables an application to open one or more {@link CDOSession sessions}. Each session represents + * a connection to a {@link IRepository repository} and provides a broad API to interact with it. A session does not + * provide direct access to model instances; {@link CDOView views} or {@link CDOTransaction transactions} are needed + * to navigate or modify the model instance graph. + *
+ * A session consists of several generic (network and storage independent) components, such as: + *
+ *
+ * All communication aspects (the sending/receiving of signals to/from a network system) are fully abstracted + * through the service provider interface (SPI) {@link CDOSessionProtocol}. Concrete implementations are fully separated + * and can be plugged into the core as described in {@link Protocol}. + * + * @see EMF + * @see Models */ public class Client { @@ -52,6 +118,16 @@ public class Architecture /** * Net4j Core + *
+ * The Net4j Signalling Platform is an extensible client/server communications framework. Net4j eases the + * development of fast and maintainable application {@link ISignalProtocol protocols} that are independent of the + * physical {@link IConnector transport} medium. Transport protocols are pluggable and Net4j ships with support for + * {@link ITCPConnector TCP}, {@link SSLUtil SSL}, {@link IHTTPConnector HTTP} and {@link IJVMConnector JVM} + * (in-process) transport. The core of Net4j is a fast, asynchronous and non-blocking {@link IBuffer buffer} + * multiplexing kernel, based on {@link OSGi} but also executable stand-alone. + * + * @see Transport + * @see Protocol */ public class Net4j { @@ -59,6 +135,17 @@ public class Architecture /** * Models + *
+ * The models, usually in the form of interfaces that are generated by {@link EMF}, represent the business knowledge + * in an application. They define the structure (and, mostly irrelevant for CDO, the behaviour) of the business entities + * and they're used by the generic {@link Client CDO client} to manage, e.g., load, commit, query, the business data. + *
+ * CDO can transparently support scalable models such that arbitrary, single {@link CDOObject objects} are loaded + * on demand and automatically unloaded (garbage collected) when they're no longer needed. For these sophisticated + * features to work properly and efficiently the models have to be re-generated with slightly modified GenModel properties. + * The CDO SDK comes with a convenient migrator tool for existing GenModels and an importer tool for new GenModels. + * + * @see EMF */ public class Models { @@ -66,6 +153,10 @@ public class Architecture /** * Protocol + *
+ * A concrete communications adapter, a {@link CDOSessionProtocol} implementation that operates inside the + * {@link Client CDO client}. The only session protocol implementation that currently ships with CDO is based on + * {@link Net4j}. */ public class Protocol { @@ -73,6 +164,13 @@ public class Architecture /** * Transport + *
+ * A concrete transport adapter, an {@link IConnector} implementation that operates on top of the + * {@link Net4j Net4j core}. Net4j currently ships with {@link IJVMConnector}, {@link ITCPConnector} + * (optionally with SSL support) and {@link IHTTPConnector}. + *
+ * The {@link org.eclipse.emf.cdo.doc.programmers.server.Architecture server} must be deployed and configured with + * the matching {@link org.eclipse.emf.cdo.doc.programmers.server.Architecture.Transport transport}. */ public class Transport { diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/server/Architecture.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/server/Architecture.java index 0816f9e735..82f6dacd45 100644 --- a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/server/Architecture.java +++ b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/server/Architecture.java @@ -32,12 +32,17 @@ import org.eclipse.emf.cdo.server.IStore; import org.eclipse.emf.cdo.server.IStoreAccessor; import org.eclipse.emf.cdo.server.IStoreChunkReader; import org.eclipse.emf.cdo.session.CDOSession; +import org.eclipse.emf.cdo.spi.server.ISessionProtocol; +import org.eclipse.net4j.acceptor.IAcceptor; import org.eclipse.net4j.buffer.IBuffer; import org.eclipse.net4j.connector.IConnector; import org.eclipse.net4j.http.common.IHTTPConnector; +import org.eclipse.net4j.http.server.IHTTPAcceptor; +import org.eclipse.net4j.jvm.IJVMAcceptor; import org.eclipse.net4j.jvm.IJVMConnector; import org.eclipse.net4j.signal.ISignalProtocol; +import org.eclipse.net4j.tcp.ITCPAcceptor; import org.eclipse.net4j.tcp.ITCPConnector; import org.eclipse.net4j.tcp.ssl.SSLUtil; import org.eclipse.net4j.util.container.IPluginContainer; @@ -117,7 +122,7 @@ public class Architecture * Concrete implementations are fully separated and can be plugged into the core as described in {@link Store}. *
* All communication aspects (the sending/receiving of signals to/from a network system) are fully abstracted - * through the service provider interface (SPI) ISessionProtocol. Concrete implementations are fully separated + * through the service provider interface (SPI) {@link ISessionProtocol}. Concrete implementations are fully separated * and can be plugged into the core as described in {@link Protocol}. */ public class Core @@ -127,7 +132,7 @@ public class Architecture /** * CDO Store *
- * A concrete storage adapter, an {@link IStore} implementation, operates on top of the generic {@link Core server + * A concrete storage adapter, an {@link IStore} implementation that operates on top of the generic {@link Core server * core}. A number of such stores already ship with CDO, making it possible to connect a repository to all sorts of * JDBC databases, Hibernate, Objectivity/DB, MongoDB or DB4O. * @@ -140,7 +145,7 @@ public class Architecture /** * Protocol *
- * A concrete communications adapter, an ISessionProtocol implementation, operates on top of the generic + * A concrete communications adapter, an {@link ISessionProtocol} implementation that operates on top of the generic * {@link Core server core}. The only session protocol implementation that currently ships with CDO is based on * {@link Net4j}. */ @@ -150,6 +155,11 @@ public class Architecture /** * OCL + *
+ * An {@link IQueryHandler} implementation that provides support for OCL queries by executing them at the generic repository level, + * i.e., independent of the concrete {@link Store} being used. + *
+ * The OCL component is optional. */ public class OCL { @@ -174,6 +184,10 @@ public class Architecture /** * Transport + *
+ * A concrete transport adapter, an {@link IAcceptor} implementation that operates on top of the + * {@link Net4j Net4j core}. Net4j currently ships with {@link IJVMAcceptor}, {@link ITCPAcceptor} + * (optionally with SSL support) and {@link IHTTPAcceptor}. */ public class Transport { diff --git a/plugins/org.eclipse.emf.cdo.releng.doc/debug/org.eclipse.emf.cdo.doc.warnings b/plugins/org.eclipse.emf.cdo.releng.doc/debug/org.eclipse.emf.cdo.doc.warnings deleted file mode 100644 index 2a80bf68b1..0000000000 --- a/plugins/org.eclipse.emf.cdo.releng.doc/debug/org.eclipse.emf.cdo.doc.warnings +++ /dev/null @@ -1,12 +0,0 @@ -Class description missing: org.eclipse.emf.cdo.compare.CDOCompare$CDOMatchEngine$Factory.class(CDOCompare.java:213) -Class description missing: org.eclipse.emf.cdo.server.StoreThreadLocal$NoSessionRegisteredException.class(StoreThreadLocal.java:134) -Class description missing: org.eclipse.emf.cdo.server.db.mapping.ColumnTypeModifier$Factory.class(ColumnTypeModifier.java:50) -Class description missing: org.eclipse.emf.cdo.spi.common.model.InternalCDOClassInfo.class(InternalCDOClassInfo.java:27) -Class description missing: org.eclipse.emf.cdo.spi.common.protocol.CDODataInputImpl$Default.class(CDODataInputImpl.java:642) -Class description missing: org.eclipse.emf.cdo.spi.common.revision.InternalCDOList$ConfigurableEquality.class(InternalCDOList.java:56) -Class description missing: org.eclipse.emf.cdo.transaction.CDOTransactionCommentator.class(CDOTransactionCommentator.java:22) -Class description missing: org.eclipse.emf.cdo.ui.widgets.CommitHistoryComposite$ContentProvider.class(CommitHistoryComposite.java:475) -Class description missing: org.eclipse.emf.cdo.ui.widgets.CommitHistoryComposite$Input.class(CommitHistoryComposite.java:275) -Class description missing: org.eclipse.emf.cdo.ui.widgets.CommitHistoryComposite$LabelProvider.class(CommitHistoryComposite.java:498) -Class description missing: org.eclipse.emf.cdo.ui.widgets.CommitHistoryComposite.class(CommitHistoryComposite.java:65) -Class description missing: org.eclipse.emf.spi.cdo.DefaultCDOMerger$PerFeature$ManyValued$Side.class(DefaultCDOMerger.java:1112) diff --git a/plugins/org.eclipse.emf.cdo.releng.help/build.xml b/plugins/org.eclipse.emf.cdo.releng.help/build.xml index 1defafed24..731cd39912 100644 --- a/plugins/org.eclipse.emf.cdo.releng.help/build.xml +++ b/plugins/org.eclipse.emf.cdo.releng.help/build.xml @@ -1,6 +1,6 @@