1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
/*
* Copyright (c) 2011-2013 Eike Stepper (Berlin, Germany) and others.
* All rights reserved. This program and the accompanying materials
* 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
* <p>
* The architecture of a CDO application is characterized by its mandatory dependency on EMF, the Eclipse Modeling
* Framework. Most of the time an application interacts with the object graph of the model through standard EMF APIs
* because CDO model graph objects are {@link EObject EObjects}. While CDO's basic functionality integrates nicely and
* transparently with EMF's extension mechanisms some of the more advanced functions may require to add direct
* dependencies on CDO to your application code.
* <p>
* The following diagram illustrates the major building blocks of a CDO application: {@img application-architecture.png}
*
* @author Eike Stepper
*/
public class Doc01_Architecture
{
/**
* OSGi
* <p>
* All components of CDO are implemented as <a href="http://www.osgi.org">OSGi</a> 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}.
* <p>
* 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
{
}
/**
* EMF
* <p>
* The <a href="http://www.eclipse.org/modeling/emf">Eclipse Modeling Framework</a> 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
{
}
/**
* CDO Client
* <p>
* 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 <b>not</b>
* provide direct access to model <i>instances</i>; {@link CDOView views} or {@link CDOTransaction transactions} are needed
* to navigate or modify the model instance graph.
* <p>
* A session consists of several generic (network and storage independent) <b>components</b>, such as:
* <p>
* <ul>
* <li>a {@link CDORevision revision} {@link CDORevisionManager manager} and {@link CDORevisionCache cache},
* <li>a {@link CDOBranch branch} {@link CDOBranchManager manager},
* <li>a {@link EPackage package} {@link CDOPackageRegistry registry},
* <li>a {@link CDOCommitInfo commit info} {@link CDOCommitInfoManager manager},
* </ul>
* <p>
* All <b>communication aspects</b> (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
{
}
/**
* Net4j Core
* <p>
* The <i>Net4j Signalling Platform</i> 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
{
}
/**
* Models
* <p>
* 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 behavior) 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.
* <p>
* CDO can transparently support <i>scalable</i> 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
{
}
/**
* Protocol
* <p>
* 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
{
}
/**
* Transport
* <p>
* 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}.
* <p>
* 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
{
}
}
|
