diff options
Diffstat (limited to 'plugins/org.eclipse.emf.cdo.server/src/org')
30 files changed, 196 insertions, 9 deletions
diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedClientSession.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedClientSession.java index 5537c293ed..792f6d475f 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedClientSession.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedClientSession.java @@ -26,7 +26,9 @@ import org.eclipse.emf.internal.cdo.session.CDOSessionImpl; /** * @author Eike Stepper + * @deprecated Not yet supported. */ +@Deprecated public class EmbeddedClientSession extends CDOSessionImpl implements CDOSession { private InternalRepository repository; diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedClientSessionConfiguration.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedClientSessionConfiguration.java index aac05321a8..b4edcbbe65 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedClientSessionConfiguration.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedClientSessionConfiguration.java @@ -26,7 +26,9 @@ import java.util.Set; /** * @author Eike Stepper + * @deprecated Not yet supported. */ +@Deprecated public class EmbeddedClientSessionConfiguration extends CDOSessionConfigurationImpl implements CDOSessionConfiguration { private InternalRepository repository; diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedClientSessionProtocol.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedClientSessionProtocol.java index fb65778c7c..f5861e1c23 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedClientSessionProtocol.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedClientSessionProtocol.java @@ -74,7 +74,9 @@ import java.util.Set; /** * @author Eike Stepper + * @deprecated Not yet supported. */ +@Deprecated public class EmbeddedClientSessionProtocol extends Lifecycle implements CDOSessionProtocol { private EmbeddedClientSession session; diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedServerSessionProtocol.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedServerSessionProtocol.java index 3c90ed7974..f2b0a60c9a 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedServerSessionProtocol.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/internal/server/embedded/EmbeddedServerSessionProtocol.java @@ -25,7 +25,9 @@ import org.eclipse.net4j.util.lifecycle.Lifecycle; /** * @author Eike Stepper + * @deprecated Not yet supported. */ +@Deprecated public class EmbeddedServerSessionProtocol extends Lifecycle implements ISessionProtocol { // A separate session protocol instance is required because the getSession() methods are ambiguous! diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerBrowser.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerBrowser.java index f552d295e7..6ff827ee86 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerBrowser.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerBrowser.java @@ -15,6 +15,7 @@ import org.eclipse.emf.cdo.common.commit.CDOCommitInfo; import org.eclipse.emf.cdo.common.commit.CDOCommitInfoHandler; import org.eclipse.emf.cdo.common.id.CDOID; import org.eclipse.emf.cdo.common.lob.CDOLobHandler; +import org.eclipse.emf.cdo.common.lob.CDOLobInfo; import org.eclipse.emf.cdo.common.revision.CDOAllRevisionsProvider; import org.eclipse.emf.cdo.common.revision.CDOIDAndVersion; import org.eclipse.emf.cdo.common.revision.CDORevision; @@ -39,6 +40,7 @@ import org.eclipse.net4j.util.WrappedException; import org.eclipse.net4j.util.concurrent.Worker; import org.eclipse.net4j.util.container.ContainerEventAdapter; import org.eclipse.net4j.util.container.IContainer; +import org.eclipse.net4j.util.container.IManagedContainer; import org.eclipse.net4j.util.container.IPluginContainer; import org.eclipse.net4j.util.event.IListener; import org.eclipse.net4j.util.factory.ProductCreationException; @@ -70,6 +72,12 @@ import java.util.Map; import java.util.Set; /** + * A simple HTTP server that web browsers can connect to in order to render internal server data for debugging purposes. + * <p> + * Actual content is contributed through pluggable {@link CDOServerBrowser.Page pages}. + * <p> + * <b>Note:</b> Don't use this server in production, it's unsecure and does not perform or scale! + * * @author Eike Stepper * @since 4.0 */ @@ -375,6 +383,8 @@ public class CDOServerBrowser extends Worker } /** + * A {@link CDOServerBrowser server browser} for the repositories in a {@link IManagedContainer managed container}. + * * @author Eike Stepper */ public static class ContainerBased extends CDOServerBrowser @@ -450,6 +460,9 @@ public class CDOServerBrowser extends Worker } /** + * Creates {@link CDOServerBrowser server browsers} for the repositories in a {@link IManagedContainer managed + * container}. + * * @author Eike Stepper */ public static class Factory extends org.eclipse.net4j.util.factory.Factory @@ -493,6 +506,8 @@ public class CDOServerBrowser extends Worker } /** + * Represents pluggable content for a {@link CDOServerBrowser server browser}. + * * @author Eike Stepper */ public static interface Page @@ -509,6 +524,8 @@ public class CDOServerBrowser extends Worker } /** + * An abstract base implementation of a {@link Page server browser page}. + * * @author Eike Stepper */ public static abstract class AbstractPage implements Page @@ -535,6 +552,8 @@ public class CDOServerBrowser extends Worker } /** + * A {@link Page server browser page} that renders the package registry contents of a repository. + * * @author Eike Stepper */ public static class PackagesPage extends AbstractPage @@ -603,6 +622,8 @@ public class CDOServerBrowser extends Worker } /** + * A {@link Page server browser page} that renders {@link CDORevision revisions}. + * * @author Eike Stepper */ public static abstract class RevisionsPage extends AbstractPage @@ -892,6 +913,8 @@ public class CDOServerBrowser extends Worker } /** + * A {@link Page server browser page} that renders the {@link CDORevision revisions} in a revision cache. + * * @author Eike Stepper */ public static class FromCache extends RevisionsPage @@ -916,6 +939,8 @@ public class CDOServerBrowser extends Worker } /** + * A {@link Page server browser page} that renders the {@link CDORevision revisions} in a {@link IStore store}. + * * @author Eike Stepper */ public static class FromStore extends RevisionsPage @@ -941,6 +966,8 @@ public class CDOServerBrowser extends Worker } /** + * A {@link Page server browser page} that renders {@link CDOLobInfo large object infos}. + * * @author Eike Stepper */ public static class LobsPage extends AbstractPage @@ -1068,6 +1095,8 @@ public class CDOServerBrowser extends Worker } /** + * A {@link Page server browser page} that renders {@link CDOCommitInfo commit infos}. + * * @author Eike Stepper */ public static class HistoryPage extends AbstractPage diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerExporter.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerExporter.java index c06147b419..af0eb5222b 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerExporter.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerExporter.java @@ -53,6 +53,11 @@ import java.util.Date; import java.util.List; /** + * Exports the complete contents of a {@link IRepository repository} in a format suitable for {@link CDOServerImporter + * imports} into new repositories. + * <p> + * Subtypes specifiy the actual exchange format. + * * @author Eike Stepper * @since 4.0 */ @@ -253,6 +258,8 @@ public abstract class CDOServerExporter<OUT> protected abstract void exportCommit(OUT out, CDOCommitInfo commitInfo) throws Exception; /** + * XML constants being used by both {@link CDOServerExporter exporters} and {@link CDOServerImporter importers}. + * * @author Eike Stepper */ public static interface XMLConstants @@ -363,6 +370,9 @@ public abstract class CDOServerExporter<OUT> } /** + * An {@link CDOServerExporter exporter} that creates XML output suitable to be interpreted by an + * {@link CDOServerImporter.XML XML importer}. + * * @author Eike Stepper */ public static class XML extends CDOServerExporter<XMLOutput> implements XMLConstants diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerImporter.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerImporter.java index 2cb10798ce..f13b238a8a 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerImporter.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerImporter.java @@ -69,6 +69,11 @@ import java.util.List; import java.util.Map; /** + * Imports the complete contents of a {@link IRepository repository} from the output created by a + * {@link CDOServerExporter exporter} into a new repository. + * <p> + * Subtypes specifiy the actual exchange format. + * * @author Eike Stepper * @since 4.0 * @apiviz.has {@link CDOServerImporter.Handler} @@ -114,6 +119,9 @@ public abstract class CDOServerImporter protected abstract void importAll(InputStream in, Handler handler) throws Exception; /** + * Persists the data that has been read by a {@link CDOServerImporter importer} into a new {@link IRepository + * repository}. + * * @author Eike Stepper */ public static interface Handler extends CDORevisionHandler, CDOLobHandler @@ -131,7 +139,6 @@ public abstract class CDOServerImporter public void handleCommitInfo(long time, long previous, int branch, String user, String comment); public void flush(); - } /** @@ -298,6 +305,9 @@ public abstract class CDOServerImporter } /** + * An {@link CDOServerImporter importer} that reads and interprets XML output created by an + * {@link CDOServerExporter.XML XML exporter}. + * * @author Eike Stepper */ public static class XML extends CDOServerImporter implements CDOServerExporter.XMLConstants diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerUtil.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerUtil.java index 2184cde466..1682197edd 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerUtil.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/CDOServerUtil.java @@ -19,11 +19,9 @@ import org.eclipse.emf.cdo.internal.server.Repository; import org.eclipse.emf.cdo.internal.server.ServerCDOView; import org.eclipse.emf.cdo.internal.server.SessionManager; import org.eclipse.emf.cdo.internal.server.bundle.OM; -import org.eclipse.emf.cdo.internal.server.embedded.EmbeddedClientSessionConfiguration; import org.eclipse.emf.cdo.internal.server.syncing.FailoverParticipant; import org.eclipse.emf.cdo.internal.server.syncing.OfflineClone; import org.eclipse.emf.cdo.internal.server.syncing.RepositorySynchronizer; -import org.eclipse.emf.cdo.server.embedded.CDOSessionConfiguration; import org.eclipse.emf.cdo.session.CDOSessionConfigurationFactory; import org.eclipse.emf.cdo.spi.common.branch.CDOBranchUtil; import org.eclipse.emf.cdo.spi.common.revision.ManagedRevisionProvider; @@ -56,6 +54,8 @@ import java.util.List; import java.util.Map; /** + * Various static methods that may help with CDO {@link IRepository repositories} and server-side {@link CDOView views}. + * * @author Eike Stepper * @apiviz.exclude */ @@ -106,10 +106,12 @@ public final class CDOServerUtil /** * @since 3.0 + * @deprecated Not yet supported. */ - public static CDOSessionConfiguration createSessionConfiguration() + @Deprecated + public static org.eclipse.emf.cdo.server.embedded.CDOSessionConfiguration createSessionConfiguration() { - return new EmbeddedClientSessionConfiguration(); + return new org.eclipse.emf.cdo.internal.server.embedded.EmbeddedClientSessionConfiguration(); } /** @@ -234,6 +236,9 @@ public final class CDOServerUtil } /** + * An abstract {@link IRepository.ReadAccessHandler read-access handler} that grants or denies access to single + * {@link CDORevision revisions}. + * * @author Eike Stepper * @since 2.0 * @apiviz.exclude diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ContainmentCycleDetectedException.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ContainmentCycleDetectedException.java index b85407d0cf..b5dac6c541 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ContainmentCycleDetectedException.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ContainmentCycleDetectedException.java @@ -11,6 +11,9 @@ package org.eclipse.emf.cdo.server; /** + * An unchecked exception that is thrown from concurrent commit operations if cycles in the tree containmnent structure + * would result. + * * @author Eike Stepper * @since 4.0 */ diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IQueryContext.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IQueryContext.java index 7a6d4c76c3..0cf4b49482 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IQueryContext.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IQueryContext.java @@ -11,8 +11,12 @@ package org.eclipse.emf.cdo.server; import org.eclipse.emf.cdo.common.branch.CDOBranchPoint; +import org.eclipse.emf.cdo.view.CDOQuery; /** + * Represents the execution state of a {@link CDOQuery query} in the server towards a {@link IQueryHandler query + * handler}. + * * @author Eike Stepper * @since 2.0 * @noextend This interface is not intended to be extended by clients. diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IQueryHandler.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IQueryHandler.java index 0f7be1ca85..40f7a86f0d 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IQueryHandler.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IQueryHandler.java @@ -11,14 +11,21 @@ package org.eclipse.emf.cdo.server; import org.eclipse.emf.cdo.common.util.CDOQueryInfo; +import org.eclipse.emf.cdo.view.CDOQuery; /** + * A query language handler that is capable of executing a {@link CDOQuery query}. + * * @author Eike Stepper * @since 2.0 */ public interface IQueryHandler { /** + * Executes the {@link CDOQuery query} represented by the specified {@link CDOQueryInfo query info} by + * {@link IQueryContext#addResult(Object) passing} the query results to the query execution engine represented by the + * specified {@link IQueryContext execution context}. + * * @since 3.0 */ public void executeQuery(CDOQueryInfo info, IQueryContext context); diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IQueryHandlerProvider.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IQueryHandlerProvider.java index 4576062c59..7f6afc8dd3 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IQueryHandlerProvider.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IQueryHandlerProvider.java @@ -11,8 +11,12 @@ package org.eclipse.emf.cdo.server; import org.eclipse.emf.cdo.common.util.CDOQueryInfo; +import org.eclipse.emf.cdo.view.CDOQuery; /** + * Provides the consumer with {@link IQueryHandler query handlers} that are capable of executing {@link CDOQuery + * queries} represented by specific {@link CDOQueryInfo query infos}. + * * @author Eike Stepper * @since 2.0 * @apiviz.uses {@link IQueryHandler} - - provides diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepository.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepository.java index 972edc712d..8d7c1cf1c9 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepository.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepository.java @@ -28,6 +28,8 @@ import java.util.List; import java.util.Map; /** + * A CDO repository. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. @@ -182,6 +184,8 @@ public interface IRepository extends CDOCommonRepository, IQueryHandlerProvider, } /** + * Provides a way to handle commits that are received from a client. + * * @author Eike Stepper * @since 2.0 */ @@ -223,6 +227,8 @@ public interface IRepository extends CDOCommonRepository, IQueryHandlerProvider, } /** + * Contains symbolic constants that specifiy valid keys of {@link IRepository#getProperties() repository properties}. + * * @author Eike Stepper * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepositoryFactory.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepositoryFactory.java index 284fa47ca8..13c5f95496 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepositoryFactory.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepositoryFactory.java @@ -11,6 +11,8 @@ package org.eclipse.emf.cdo.server; /** + * Create CDO {@link IRepository repositories}. + * * @author Eike Stepper * @apiviz.uses {@link IRepository} - - creates */ diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepositoryProvider.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepositoryProvider.java index e743a89a0c..03f1e04e32 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepositoryProvider.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepositoryProvider.java @@ -11,6 +11,8 @@ package org.eclipse.emf.cdo.server; /** + * Provides the consumer with CDO {@link IRepository repositories} specified by their name. + * * @author Eike Stepper * @apiviz.uses {@link IRepository} - - provides */ diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepositorySynchronizer.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepositorySynchronizer.java index bf7e15430f..722cb74dd8 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepositorySynchronizer.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IRepositorySynchronizer.java @@ -16,6 +16,8 @@ import org.eclipse.emf.cdo.session.CDOSessionConfigurationFactory; import org.eclipse.net4j.util.event.INotifier; /** + * Synchronizes a {@link ISynchronizableRepository synchronizable repository} with a master repository. + * * @author Eike Stepper * @since 3.0 * @noextend This interface is not intended to be extended by clients. diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ISession.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ISession.java index a5913a7534..b673107c7f 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ISession.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ISession.java @@ -13,11 +13,14 @@ package org.eclipse.emf.cdo.server; import org.eclipse.emf.cdo.common.CDOCommonSession; import org.eclipse.emf.cdo.common.branch.CDOBranchPoint; +import org.eclipse.emf.cdo.session.CDOSession; import org.eclipse.emf.cdo.spi.server.ISessionProtocol; import org.eclipse.net4j.util.container.IContainer; /** + * The server-side representation of a client {@link CDOSession session}. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ISessionManager.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ISessionManager.java index abae355893..8d5e0fc707 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ISessionManager.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ISessionManager.java @@ -13,6 +13,8 @@ package org.eclipse.emf.cdo.server; import org.eclipse.net4j.util.container.IContainer; /** + * Manages the user {@link ISession sessions} of a {@link IRepository repository}. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStore.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStore.java index 885d660e1b..bb23f5b58f 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStore.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStore.java @@ -14,6 +14,8 @@ import org.eclipse.emf.cdo.common.CDOCommonRepository.IDGenerationLocation; import org.eclipse.emf.cdo.common.branch.CDOBranch; import org.eclipse.emf.cdo.common.id.CDOID; import org.eclipse.emf.cdo.common.id.CDOID.ObjectType; +import org.eclipse.emf.cdo.common.revision.CDORevision; +import org.eclipse.emf.cdo.common.revision.delta.CDORevisionDelta; import org.eclipse.net4j.util.om.monitor.ProgressDistributor; @@ -22,6 +24,9 @@ import java.util.Map; import java.util.Set; /** + * Represents the physical data storage back-end of a CDO {@link IRepository repository}, such as a database or a file + * system folder. + * * @author Eike Stepper * @apiviz.landmark * @apiviz.has {@link IStore.ChangeFormat} @@ -173,30 +178,60 @@ public interface IStore public ProgressDistributor getIndicatingCommitDistributor(); /** + * Enumerates the possible data formats a {@link IStore store} can accept for commit operations. + * * @author Eike Stepper * @since 2.0 */ public enum ChangeFormat { - REVISION, DELTA + /** + * An indication that the store accepts full {@link CDORevision revisions} for dirty objects. + */ + REVISION, + + /** + * An indication that the store accepts incremental {@link CDORevisionDelta revision deltas} for dirty objects. + */ + DELTA } /** + * Enumerates the possible history recording options a {@link IStore store} can accept. + * * @author Eike Stepper * @since 2.0 */ public enum RevisionTemporality { - NONE, AUDITING + /** + * An indication that the store can work <b>without</b> <i>auditing</i>. + */ + NONE, + + /** + * An indication that the store can work <b>with</b> <i>auditing</i>. + */ + AUDITING } /** + * Enumerates the possible branching options a {@link IStore store} can accept. + * * @author Eike Stepper * @since 2.0 */ public enum RevisionParallelism { - NONE, BRANCHING + /** + * An indication that the store can work <b>without</b> <i>branching</i>. + */ + NONE, + + /** + * An indication that the store can work <b>with</b> <i>branching</i>. + */ + BRANCHING } /** diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStoreAccessor.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStoreAccessor.java index d567749eea..376bd3a6d8 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStoreAccessor.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStoreAccessor.java @@ -62,6 +62,8 @@ import java.util.Map; import java.util.Set; /** + * Represents a <i>connection</i> to a physical data storage back-end. + * * @author Eike Stepper * @apiviz.uses {@link IStoreChunkReader} - - creates */ @@ -404,6 +406,9 @@ public interface IStoreAccessor extends IQueryHandlerProvider, BranchLoader, Com } /** + * Represents the query execution state of a {@link IStoreAccessor#queryResources(QueryResourcesContext) resources + * query}. + * * @author Eike Stepper * @since 2.0 * @noimplement This interface is not intended to be implemented by clients. @@ -432,6 +437,9 @@ public interface IStoreAccessor extends IQueryHandlerProvider, BranchLoader, Com public boolean addResource(CDOID resourceID); /** + * Represents the query execution state of a {@link IStoreAccessor#queryResources(QueryResourcesContext) resources + * query} that is supposed to deliver one exact resource, or <code>null</code>. + * * @author Eike Stepper * @since 2.0 * @apiviz.exclude @@ -443,6 +451,8 @@ public interface IStoreAccessor extends IQueryHandlerProvider, BranchLoader, Com } /** + * Represents the query execution state of a {@link IStoreAccessor#queryXRefs(QueryXRefsContext) XRefs query}. + * * @author Eike Stepper * @since 3.0 * @noimplement This interface is not intended to be implemented by clients. @@ -478,6 +488,9 @@ public interface IStoreAccessor extends IQueryHandlerProvider, BranchLoader, Com } /** + * An extension interface for {@link IStoreAccessor store accessors} that support <i>raw data access</i> as needed by + * {@link IRepositorySynchronizer repository synchronizers} or {@link CDOServerImporter server importers}. + * * @author Eike Stepper * @since 4.0 * @apiviz.exclude @@ -701,6 +714,9 @@ public interface IStoreAccessor extends IQueryHandlerProvider, BranchLoader, Com } /** + * An extension interface for {@link IStoreAccessor store accessors} that support <i>durable locking</i>. + * + * @see DurableLocking2 * @author Eike Stepper * @since 4.0 * @apiviz.exclude @@ -715,6 +731,8 @@ public interface IStoreAccessor extends IQueryHandlerProvider, BranchLoader, Com } /** + * An extension interface for {@link IStoreAccessor store accessors} that support <i>durable locking</i>. + * * @author Caspar De Groot * @since 4.1 * @apiviz.exclude diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStoreChunkReader.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStoreChunkReader.java index f5d9073b9e..37559a6eab 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStoreChunkReader.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStoreChunkReader.java @@ -12,12 +12,17 @@ package org.eclipse.emf.cdo.server; import org.eclipse.emf.cdo.common.revision.CDORevision; +import org.eclipse.emf.cdo.session.CDOCollectionLoadingPolicy; import org.eclipse.emf.ecore.EStructuralFeature; import java.util.List; /** + * Reads {@link Chunk chunks} of + * {@link org.eclipse.emf.cdo.session.CDOSession.Options#setCollectionLoadingPolicy(CDOCollectionLoadingPolicy) + * partially loaded} lists from a physical data storage backend. + * * @author Eike Stepper * @apiviz.uses {@link IStoreChunkReader.Chunk} - - reads */ @@ -48,6 +53,9 @@ public interface IStoreChunkReader public List<Chunk> executeRead(); /** + * Represents a {@link List#subList(int, int) sublist} of consecutive elements that are subject to <i>partial + * collection loading</i>. + * * @author Eike Stepper */ public static class Chunk diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStoreFactory.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStoreFactory.java index d1b915db6f..7b7aa387f7 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStoreFactory.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IStoreFactory.java @@ -15,6 +15,8 @@ import org.w3c.dom.Element; import java.util.Map; /** + * Creates {@link IStore stores}. + * * @author Eike Stepper * @apiviz.uses {@link IStore} - - creates */ diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ITransaction.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ITransaction.java index 2848d24c17..d2b4d670c8 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ITransaction.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/ITransaction.java @@ -12,8 +12,11 @@ package org.eclipse.emf.cdo.server; import org.eclipse.emf.cdo.common.CDOCommonTransaction; +import org.eclipse.emf.cdo.transaction.CDOTransaction; /** + * The server-side representation of a client {@link CDOTransaction transaction}. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IView.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IView.java index 5ff55de937..69e203a819 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IView.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/IView.java @@ -11,8 +11,11 @@ package org.eclipse.emf.cdo.server; import org.eclipse.emf.cdo.common.CDOCommonView; +import org.eclipse.emf.cdo.view.CDOView; /** + * The server-side representation of a client {@link CDOView view}. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/RepositoryNotFoundException.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/RepositoryNotFoundException.java index 270fade16b..dba47eaa60 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/RepositoryNotFoundException.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/RepositoryNotFoundException.java @@ -11,8 +11,12 @@ package org.eclipse.emf.cdo.server; import org.eclipse.emf.cdo.common.util.CDOException; +import org.eclipse.emf.cdo.session.CDOSession; /** + * An unchecked exception being thrown when opening a {@link CDOSession session} to a named {@link IRepository + * repository} that cannot be found. + * * @author Eike Stepper */ public class RepositoryNotFoundException extends CDOException diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/StoreThreadLocal.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/StoreThreadLocal.java index 5a1e8117dd..60ddd3c8cd 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/StoreThreadLocal.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/StoreThreadLocal.java @@ -10,11 +10,16 @@ */ package org.eclipse.emf.cdo.server; +import org.eclipse.emf.cdo.server.IStoreAccessor.CommitContext; import org.eclipse.emf.cdo.spi.server.InternalSession; import org.eclipse.net4j.util.lifecycle.LifecycleUtil; /** + * Provides server-side consumers with the {@link IStoreAccessor store accessor} that is valid in the context of a + * specific {@link ISession session} during read operations or a specific {@link CommitContext commit context} during + * write operations. + * * @author Eike Stepper * @since 2.0 * @apiviz.exclude diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/embedded/CDOSession.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/embedded/CDOSession.java index 862e78f78b..8c595e468c 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/embedded/CDOSession.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/embedded/CDOSession.java @@ -11,11 +11,15 @@ package org.eclipse.emf.cdo.server.embedded; /** + * Deprecated, not yet supported. + * * @author Eike Stepper * @since 3.0 * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. + * @deprecated Not yet supported. */ +@Deprecated public interface CDOSession extends org.eclipse.emf.cdo.session.CDOSession { } diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/embedded/CDOSessionConfiguration.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/embedded/CDOSessionConfiguration.java index e7521c9a95..25a734f6e8 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/embedded/CDOSessionConfiguration.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/embedded/CDOSessionConfiguration.java @@ -14,11 +14,15 @@ import org.eclipse.emf.cdo.common.revision.CDORevisionManager; import org.eclipse.emf.cdo.server.IRepository; /** + * Deprecated, not yet supported. + * * @author Eike Stepper * @since 3.0 * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. + * @deprecated Not yet supported. */ +@Deprecated public interface CDOSessionConfiguration extends org.eclipse.emf.cdo.session.CDOSessionConfiguration { public IRepository getRepository(); diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/mem/IMEMStore.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/mem/IMEMStore.java index 30dcb140ef..40d7bc1a69 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/mem/IMEMStore.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/mem/IMEMStore.java @@ -21,7 +21,7 @@ import org.eclipse.net4j.util.lifecycle.LifecycleUtil; import org.eclipse.emf.ecore.EClass; /** - * A simple in-memory store. + * A simple in-memory {@link IStore store}. * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. diff --git a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/mem/MEMStoreUtil.java b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/mem/MEMStoreUtil.java index de089d1c33..bdd996d16e 100644 --- a/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/mem/MEMStoreUtil.java +++ b/plugins/org.eclipse.emf.cdo.server/src/org/eclipse/emf/cdo/server/mem/MEMStoreUtil.java @@ -13,6 +13,8 @@ package org.eclipse.emf.cdo.server.mem; import org.eclipse.emf.cdo.internal.server.mem.MEMStore; /** + * Creates {@link IMEMStore} instances. + * * @author Eike Stepper * @since 2.0 */ @@ -23,6 +25,8 @@ public final class MEMStoreUtil } /** + * Creates a {@link IMEMStore} instance. + * * @since 4.0 */ public static IMEMStore createMEMStore() |