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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
|
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" href="../../../../..//apistyles.css" type="text/css">
<title>modulecore api overview</title>
</head>
<body>
<p>
The ComponentCore API allows clients to work with the Structural
Metamodels that define abstract modules within Eclipse projects.
These metamodels are exposed through the Virtual Path API layer
(see <a href="ComponentCore.html">ComponentCore</a>). Clients
should also review the <b>org.eclipse.wst.common.componentcore.resources</b>
package.
</p>
<a name="top"></a>
<table width="500">
<tr>
<td>
<p>
The following document includes information on these topics:
<ul>
<li>
<a href="#structural-metamodel">ComponentCore Metamodel (CCM)</a>
used to understand which files should or should not be
included within a module.</li>
<li>
<a href="#constraints">Constraints</a> enforced by the
design</li>
<li>
<a href="#module-core-examples">The API entry-point</a>
</li>
</ul>
</p>
</td>
</tr>
</table>
<a name="structural-metamodel"></a>
<table width="100%" cellspacing="5" cellpadding="2" border="0">
<tbody>
<tr>
<td valign="top" bgcolor="#0080c0" align="left" colspan="2"><b><font face="Arial,Helvetica" color="#ffffff">ComponentCore Metamodel (CCM)</font></b></td>
</tr>
</tbody>
</table>
<BR>
<table width="500">
<tr>
<td>
<p>
The ComponentCore Metamodel (CCM) is an EMF model that allows
the tooling to understand most project structures. Each project
has a single CCM which is stored under the project root named
<I>.wtpmodules</I>
. The XML format is defined by the
<a href="../../../../../overview/componentCore.xsd">ComponentCore schema</a>.
The following diagram is a UML representation of the
ComponentCore Metamodel. This information is published for
potential contributors of editors, but the EMF model is
not exposed directly as API, and could change in view of
changes for WTP 1.1.
</p>
</td>
</tr>
</table>
<table cellpadding="10" cellspacing="10">
<tr>
<td>
<p>
<img src="../../../../../overview/componentcore_model.jpg"></p>
</td>
</tr>
<tr>
<td>
<p>
<i>Figure 1: The Component Core Metamodel</i>
</p>
</td>
</tr>
</table>
<table width="500">
<tr>
<td>
<p>
Each logical component contained in the project is represented by a
<b>WorkbenchComponent</b> element. The <b>WorkbenchComponent</b> defines
information about the type of component, the resources consumed by the
module from the project, and the referenced components. The
<b>WorkbenchComponent</b> is very generic, and as modeled, does
not necessarily correspond to only J2EE artifacts.
</p>
</td>
</tr>
</table>
<table width="500">
<tr>
<td>
<p>
The <b>WorkbenchComponent</b> has a
<i>name</i>
, which is the name that will be used when the runtime form of the
component is constructed. For a web application, the
<i>name</i>
might be "MyWebApplication".
</p>
</td>
</tr>
</table>
<table width="500">
<tr>
<td>
<p>
The <b>WorkbenchComponent</b> may be uniquely referenced by a URI. The
fully qualified URI to any component must begin with the component
protocol ("component:"), specify a subprotocol ("resource|classpath") and
then a path to the referenced component. A <b>WorkbenchComponent</b> with the
name "MyWebApplication" defined in a project named
"MyWebModulesProject" would be referenced by the following URI:
"component:/resource/MyWebModulesProject/MyWebApplication". As a future
extension, a component referenced on the classpath of a project (perhaps
a Utility Jar or an EJB Client Jar), the URI might be something like:
"component:/classpath/MyWebModulesProject/CustomerEJBClient.jar".
</p>
</td>
</tr>
</table>
<table width="500">
<tr>
<td>
<p>
The <b>WorkbenchComponent</b> has a <b>ComponentType</b>. The
<b>ComponentType</b> defines a <i>componentTypeId</i>
, which indicates the specific kind of component. The Web Tools Platform
uses the <i>componentTypeId</i>
to determine how to work with the content component of the <b>WorkbenchComponent</b>
and prepare the component for deployment. The <b>ComponentType</b> may
also define the runtime-paths of special metadata resources which are
important to the <b>WorkbenchComponent</b>. "Metadata" refers to resources
which explain the content details of the specific modules. An example of
such a file would be the "WEB-INF/web.xml" deployment descriptor for
Web Applications.
</p>
</td>
</tr>
</table>
<table width="500">
<tr>
<td>
<p>
The <b>WorkbenchComponent</b> contains a list of ComponentResources. Each
<b>ComponentResource</b> has "sourcePath" and a corresponding
"runtimePath". The "sourcePath" can reference either a file or folder,
but the referenced resource must be contained in the same project as the
<b>WorkbenchComponent</b> definition. The "runtimePath" specifies a location
relative to the deployed structure of the <b>WorkbenchComponent</b> where the
contents of the referenced resource will be represented when the module is
prepared for runtime.
</p>
</td>
</tr>
</table>
<table width="500">
<tr>
<td>
<p>
The <b>WorkbenchComponent</b> contains a list of <b>ReferencedComponent</b>s.
Each <b>ReferencedComponent</b> provides a handle that must resolve to a
<b>WorkbenchComponent</b>, a runtimePath that defines where the constructed
component will be placed within the context of the runtime
<b>WorkbenchComponent</b>, and a <b>DependencyType</b>
that can be either "consume" or "use" to indicate how the contents of
that <b>ReferencedComponent</b> should be absorbed by the <b>WorkbenchComponent</b>.
<b>ReferencedComponent</b>s may reference <b>WorkbenchComponent</b>s in
other projects and on current project's classpath (Not yet implemented).
The <b>DependencyType</b> will determine whether the contents of
the <b>ReferencedComponent</b> are absorbed as-is or archived into a *.{w|j|e}ar
file.
</p>
</td>
</tr>
</table>
<table width="500">
<tr>
<td>
<p>
The <b>ProjectComponents</b> object provides a root container for all
<b>WorkbenchComponent</b>s defined in a given project.
</p>
</td>
</tr>
</table>
<table width="500">
<tr>
<td>
<p>
<b>ComponentCore</b> provides a facade to manage the underlying model for
clients. Static methods
<code>ModuleCore.getModuleCoreForRead()</code>
and
<code>ModuleCore.getModuleCoreForWrite()</code>
may be used to acquire an ModuleCore adapter, and clients are responsible
for invoking
<code>dispose()</code>
whenever they are finished using the model.
</p>
</td>
</tr>
</table>
<a href="#top">top</a><a name="constraints"></a>
<table width="100%" cellspacing="5" cellpadding="2" border="0">
<tbody>
<tr>
<td valign="top" bgcolor="#0080c0" align="left" colspan="2"><b><font face="Arial,Helvetica" color="#ffffff">Constraints enforced by the CCM</font></b></td>
</tr>
</tbody>
</table>
<table width="500">
<tr>
<td>
<p>
The following constraints are enforced by the model:
<ol>
<li>
<p>
The solution will not check dependencies for components that are
contained in the same project. To get the full benefits of
inter-component dependency checking, components must be separated
into different projects. We do not have the necessary
flexibility in constructing and scoping classpaths on a level
more granular than the project level, which would be needed
to support this functionality.
</p>
</li>
<li>
<p>
The solution will not allow a single component to span more than
one project. Within that project, we will have fairly broad
flexibility to specify which resources map to which components.
Each component within a project must have its own source folder,
but a component may contain more than one source folder. Each
source folder may be contained by at most one component. Components
may reference dependent components in other projects (so a Web
Application may reference a Web Library outside of the
project that contains the Web Application).
</p>
</li>
<li>
<p>
The solution will not allow more than one server target per
component (and really per-project) at a time. The ability to
switch this server target (via some action or property
setting) will continue to be possible. Users that need the
capability to develop for multiple server targets will need
to manually switch and test as necessary.
</p>
</li>
<li>
<p>
Each component in a project may have its own output folder
structure automatically constructed for it. The output
structure will match the J2EE specification output structure
required for the component type (for J2EE modules). A new
builder will handle this responsibility and work
cooperatively with the Java builder to construct a
deployable, on-disk representation of the module structure.
The reference implementation will follow this pattern, but
hooks will be made available to vary this behavior.
The necessity for this on-disk structure to match a
J2EE-compliant layout is motivated by the requirement to have
in-workbench testing, so that users will not have to deal
with a deployer actually constructing a deployable module and
shipping it off to a server to test their code. This approach
is consistent with existing Ant-based approaches and
Application Servers which can run in a "debug" mode on disk.
Our value-add will be greater automation and integration with
the workbench -- particularly for incremental based support.
The specialized module builder would not be necessary if the
source was already in the appropriate J2EE specification
compliant structure. The default creation will still
encourage a single module per project, which conforms to the
correct J2EE structure.
</p>
</li>
<li>
<p>
Components will be described using a simple XML format, and each
project will contain one
<I>.wtpmodules</I>
file that will describe all of the components for that project.
The level of tooling to help users create these files is yet
to be determined for WTP M4. This would be a great area for
other interested developers to suggest and provide tooling
(e.g. a Wizard or Editor) to create these files from existing
structures. A schema is provided to make it easier for
consumers that want to build their own
<I>.wtpmodules</I>
by hand to take advantage of the content assist in the XML
editor.
</p>
</li>
</ol>
</p>
</td>
</tr>
</table>
<a href="#top">top</a><a name="module-core-examples"></a>
<table width="100%" cellspacing="5" cellpadding="2" border="0">
<tbody>
<tr>
<td valign="top" bgcolor="#0080c0" align="left" colspan="2"><b><font face="Arial,Helvetica" color="#ffffff">ComponentCore API: Working with the metamodel</font></b></td>
</tr>
</tbody>
</table>
<BR>
<table width="500">
<tr>
<td>
<p>
ComponentCore uses a handle based model much like the existing Platform
Resource model. The ComponentCore facade is not tied to any project, and
the handles that it returns may or may not exist. The complexity of
managing the underlying EMF model is handled under the cover for users.
</p>
</td>
</tr>
</table>
<table cellpadding="10" cellspacing="10">
<tr>
<td>
<p>
<img src="../../../../../overview/componentcore_package.jpg"></p>
</td>
</tr>
<tr>
<td>
<p>
<i>Figure 2: The ComponentCore API</i>
</p>
</td>
</tr>
</table>
<a href="#top">top</a>
</body>
</html>
|
