← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to j2ee/clientproject/arch.xml

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
j2ee/clientproject/arch.xml
 
1
<?xml version="1.0" encoding="UTF-8"?><!-- -*- sgml-indent-step: 1 -*- -->
 
2
<!--
 
3
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
4
 
 
5
Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
6
 
 
7
 
 
8
The contents of this file are subject to the terms of either the GNU
 
9
General Public License Version 2 only ("GPL") or the Common
 
10
Development and Distribution License("CDDL") (collectively, the
 
11
"License"). You may not use this file except in compliance with the
 
12
License. You can obtain a copy of the License at
 
13
http://www.netbeans.org/cddl-gplv2.html
 
14
or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
15
specific language governing permissions and limitations under the
 
16
License.  When distributing the software, include this License Header
 
17
Notice in each file and include the License file at
 
18
nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
19
particular file as subject to the "Classpath" exception as provided
 
20
by Sun in the GPL Version 2 section of the License file that
 
21
accompanied this code. If applicable, add the following below the
 
22
License Header, with the fields enclosed by brackets [] replaced by
 
23
your own identifying information:
 
24
"Portions Copyrighted [year] [name of copyright owner]"
 
25
 
 
26
Contributor(s):
 
27
 
 
28
The Original Software is NetBeans. The Initial Developer of the Original
 
29
Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
 
30
Microsystems, Inc. All Rights Reserved.
 
31
 
 
32
If you wish your version of this file to be governed by only the CDDL
 
33
or only the GPL Version 2, indicate your decision by adding
 
34
"[Contributor] elects to include this software in this distribution
 
35
under the [CDDL or GPL Version 2] license." If you do not indicate a
 
36
single choice of license, a recipient has the option to distribute
 
37
your version of this file under either the CDDL, the GPL Version 2 or
 
38
to extend the choice of license to its licensees as provided above.
 
39
However, if you add GPL Version 2 code and therefore, elected the GPL
 
40
Version 2 license, then the option applies only if the new code is
 
41
made subject to such option by the copyright holder.
 
42
-->
 
43
<!DOCTYPE api-answers PUBLIC "-//NetBeans//DTD Arch Answers//EN" "../../nbbuild/antsrc/org/netbeans/nbbuild/Arch.dtd" [
 
44
  <!ENTITY api-questions SYSTEM "../../nbbuild/antsrc/org/netbeans/nbbuild/Arch-api-questions.xml">
 
45
]>
 
46
 
 
47
<api-answers
 
48
  question-version="1.26"
 
49
  author="jungi@netbeans.org"
 
50
>
 
51
 
 
52
  &api-questions;
 
53
 
 
54
 
 
55
<!--
 
56
        <question id="arch-overall" when="init">
 
57
            Describe the overall architecture. 
 
58
            <hint>
 
59
            What will be API for 
 
60
            <a href="http://openide.netbeans.org/tutorial/api-design.html#design.apiandspi">
 
61
                clients and what support API</a>? 
 
62
            What parts will be pluggable?
 
63
            How will plug-ins be registered? Please use <code>&lt;api type="export"/&gt;</code>
 
64
            to describe your general APIs.
 
65
            If possible please provide 
 
66
            simple diagrams. 
 
67
            </hint>
 
68
        </question>
 
69
-->
 
70
 <answer id="arch-overall">
 
71
  <p>
 
72
   The module exposes a new NetBeans project type to create Java EE Enterprise
 
73
   Application Client Module project, where a developer can create standard Java SE
 
74
   applications, which have direct access to the server environment and resources
 
75
   (such as EJBs, Web Services), develop these applications, assemble them according
 
76
   to Java EE specification, build them and deploy them to Application servers.
 
77
  </p>
 
78
  <p>
 
79
   It uses various project APIs to implement the project type. <a
 
80
   href="http://projects.netbeans.org/buildsys/design.html">Build system design
 
81
   document</a>. Implements j2ee/ejbapi to provide a project container
 
82
   for an Enterprise application client module.
 
83
  </p>
 
84
  <ol>
 
85
   <li>
 
86
    <api group="dtd" name="car-project.xsd" type="export" category="devel" url="http://www.netbeans.org/ns/car-project/1.xsd">
 
87
     <p>
 
88
      Definition of clientproject-specific portions of <code>project.xml</code>.
 
89
     </p>
 
90
    </api>
 
91
   </li>
 
92
   <li>
 
93
    <api group="java.io.File" name="project.properties" type="export" category="devel">
 
94
     <p>
 
95
      Definition of recognized keys in <code>project.properties</code> and/or
 
96
      <code>private.properties</code>. XXX not yet formally specified.
 
97
     </p>
 
98
    </api>
 
99
   </li>
 
100
   <li>
 
101
    <api group="java.io.File" name="build-impl.xml" type="export" category="devel">
 
102
     <p>
 
103
      Definition of targets in <code>build-impl.xml</code> which may be called or
 
104
      overridden in <code>build.xml</code>. XXX not yet formally specified.
 
105
     </p>
 
106
    </api>
 
107
   </li>
 
108
   <li>
 
109
    <api group="java.io.File" name="LayoutOfProjectFiles" type="export" category="private">
 
110
     <p>
 
111
      Modules should make no assumptions about the layout of project directory other then
 
112
      what is explicitly exposed via API (such as J2eeModuleProvider from j2eeserver API,
 
113
      AntArtifact).
 
114
     </p>
 
115
    </api>
 
116
   </li>
 
117
  </ol>
 
118
 </answer>
 
119
 
 
120
 
 
121
 
 
122
<!--
 
123
        <question id="arch-quality" when="init">
 
124
            How will the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html">quality</a>
 
125
            of your code be tested and 
 
126
            how are future regressions going to be prevented?
 
127
            <hint>
 
128
            What kind of testing do
 
129
            you want to use? How much functionality, in which areas,
 
130
            should be covered by the tests? 
 
131
            </hint>
 
132
        </question>
 
133
-->
 
134
 <answer id="arch-quality">
 
135
  <p>
 
136
   There are some unit tests (not enough). IDE-wide functional testing covers
 
137
   much of the module's functionality.
 
138
  </p>
 
139
 </answer>
 
140
 
 
141
 
 
142
 
 
143
<!--
 
144
        <question id="arch-time" when="init">
 
145
            What are the time estimates of the work?
 
146
            <hint>
 
147
            Please express your estimates of how long the design, implementation,
 
148
            stabilization are likely to last. How many people will be needed to
 
149
            implement this and what is the expected milestone by which the work should be 
 
150
            ready?
 
151
            </hint>
 
152
        </question>
 
153
-->
 
154
 <answer id="arch-time">
 
155
  <p>
 
156
   Done.
 
157
  </p>
 
158
 </answer>
 
159
 
 
160
 
 
161
 
 
162
<!--
 
163
        <question id="arch-usecases" when="init">
 
164
            <hint>
 
165
                Content of this answer will be displayed as part of page at
 
166
                http://www.netbeans.org/download/dev/javadoc/usecases.html 
 
167
                You can use tags &lt;usecase name="name&gt; regular html description &lt;/usecase&gt;
 
168
                and if you want to use an URL you can prefix if with @TOP@ to begin
 
169
                at the root of your javadoc
 
170
            </hint>
 
171
        
 
172
            Describe the main <a href="http://openide.netbeans.org/tutorial/api-design.html#usecase">
 
173
            use cases</a> of the new API. Who will use it under
 
174
            what circumstances? What kind of code would typically need to be written
 
175
            to use the module?
 
176
        </question>
 
177
-->
 
178
 <answer id="arch-usecases">
 
179
  <p>
 
180
    <usecase id="id" name="Project Generator" >
 
181
       AppClientProjectGenerator can be used to generate an Application Client module
 
182
       project. This can be used for example to create a populated EAR project
 
183
       together with an Application Client module project.
 
184
       This is the only (private) API.
 
185
    </usecase>
 
186
  </p>
 
187
  <p>
 
188
   The rest is covered by UI specification and design document.
 
189
  </p>
 
190
 </answer>
 
191
 
 
192
 
 
193
 
 
194
<!--
 
195
        <question id="arch-what" when="init">
 
196
            What is this project good for?
 
197
            <hint>
 
198
            Please provide here a few lines describing the project, 
 
199
            what problem it should solve, provide links to documentation, 
 
200
            specifications, etc.
 
201
            </hint>
 
202
        </question>
 
203
-->
 
204
 <answer id="arch-what">
 
205
  <p>
 
206
   Provides a project type for Java EE enterprise application client module
 
207
   projects. Application client projects can be created from scratch,
 
208
   or you can import existing application client module source trees. Creates an Ant
 
209
   script letting you build the project (and subprojects), deploy it, debug it, run
 
210
   JUnit-format tests, and build Javadoc. Standard and server specific
 
211
   configuration files are displayed in project and can be edited. GUI customizer
 
212
   permits easy customization of the most commonly needed project parameters.
 
213
   Provides code completion and other services for editing Java sources.
 
214
   Classpaths can include other projects, raw JARs, or configured libraries.
 
215
   Specific J2SE platforms may be configured. Target J2EE server can be selected
 
216
   and provides code completion for the Java EE APIs available on the server.
 
217
   <a
 
218
   href="http://j2ee.netbeans.org/docs/promog/appclient-project-ui-spec-promog.html">Full UI
 
219
   specification</a>
 
220
  </p>
 
221
  <api name="ClientProject" category="friend" group="java" type="export">
 
222
   <p>
 
223
    The module exposes a new NetBeans project type to create Java EE Application
 
224
    Client Module project, where a developer can add EJBs, develop them, assemble them, build them and deploy them to Application servers.
 
225
    The friend API allows EAR project to create an Application Client module project. It also allows the ejbcore project to set
 
226
    one property in nbproject\project.properties file.
 
227
   </p>
 
228
  </api>
 
229
 </answer>
 
230
 
 
231
 
 
232
 
 
233
<!--
 
234
        <question id="arch-where" when="init">
 
235
            Where one can find sources for your module?
 
236
            <hint>
 
237
                Please provide link to the CVS web client at
 
238
                http://www.netbeans.org/download/source_browse.html
 
239
                or just use tag defaultanswer generate='here'
 
240
            </hint>
 
241
        </question>
 
242
-->
 
243
 <answer id="arch-where">
 
244
  <defaultanswer generate='here' />
 
245
 </answer>
 
246
 
 
247
 
 
248
 
 
249
<!--
 
250
        <question id="compat-i18n" when="impl">
 
251
            Is your module correctly internationalized?
 
252
            <hint>
 
253
            Correct internationalization means that it obeys instructions 
 
254
            at <a href="http://www.netbeans.org/download/dev/javadoc/org-openide-modules/org/openide/modules/doc-files/i18n-branding.html">
 
255
            NetBeans I18N pages</a>.
 
256
            </hint>
 
257
        </question>
 
258
-->
 
259
 <answer id="compat-i18n">
 
260
  <p>
 
261
   Yes, although the project type does not yet internationalize messages coming
 
262
   from its (unedited) build scripts. This is possible but not yet implemented.
 
263
  </p>
 
264
 </answer>
 
265
 
 
266
 
 
267
 
 
268
<!--
 
269
        <question id="compat-standards" when="init">
 
270
            Does the module implement or define any standards? Is the 
 
271
            implementation exact or does it deviate somehow?
 
272
        </question>
 
273
-->
 
274
 <answer id="compat-standards">
 
275
  <p>
 
276
  The module follows the Java EE 5 specifications. It allows the user
 
277
  to develop applications conforming to this standard. The implementation is exact,
 
278
  in the sense that the module accepts any compliant Application Client Module.
 
279
  Since Java EE 5 has to be backward comaptible with J2EE 1.4, this module
 
280
  supports J2EE 1.4 Application Client Modules. This module also supports J2EE 1.3
 
281
  compliant Application Client modules, but it does not help you to create NEW ones,
 
282
  it will just behave nicely with 1.3 Apps, due to the API layer designed in the j2ee/ddapi
 
283
  module that handles more than one specification version of J2EE.
 
284
  </p>
 
285
 </answer>
 
286
 
 
287
 
 
288
 
 
289
<!--
 
290
        <question id="compat-version" when="impl">
 
291
            Can your module coexist with earlier and future
 
292
            versions of itself? Can you correctly read all old settings? Will future
 
293
            versions be able to read your current settings? Can you read
 
294
            or politely ignore settings stored by a future version?
 
295
            
 
296
            <hint>
 
297
            Very helpful for reading settings is to store version number
 
298
            there, so future versions can decide whether how to read/convert
 
299
            the settings and older versions can ignore the new ones.
 
300
            </hint>
 
301
        </question>
 
302
-->
 
303
 <answer id="compat-version">
 
304
  <p>
 
305
  The module stores some information into persistent data, and makes the best
 
306
  effort to correctly interpret information stored by previous versions of the 
 
307
  module. It is anticipated that future versions of the module will be able to
 
308
  interpret information stored by the current version, whenever possible and practical.
 
309
  </p>
 
310
 </answer>
 
311
 
 
312
 
 
313
 
 
314
<!--
 
315
        <question id="dep-jre" when="final">
 
316
            Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?
 
317
            <hint>
 
318
            It is expected that if your module runs on 1.x that it will run 
 
319
            on 1.x+1 if no, state that please. Also describe here cases where
 
320
            you run different code on different versions of JRE and why.
 
321
            </hint>
 
322
        </question>
 
323
-->
 
324
 <answer id="dep-jre">
 
325
  <p>
 
326
   1.5 and higher.
 
327
  </p>
 
328
 </answer>
 
329
 
 
330
 
 
331
 
 
332
<!--
 
333
        <question id="dep-jrejdk" when="final">
 
334
            Do you require the JDK or is the JRE enough?
 
335
        </question>
 
336
-->
 
337
 <answer id="dep-jrejdk">
 
338
  <p>
 
339
   The JDK is needed for critical functionality such as compiling sources.
 
340
  </p>
 
341
 </answer>
 
342
 
 
343
 
 
344
 
 
345
<!--
 
346
        <question id="dep-nb" when="init">
 
347
            What other NetBeans projects and modules does this one depend on?
 
348
            <hint>
 
349
            If you want, describe such projects as imported APIs using
 
350
            the <code>&lt;api name="identification" type="import or export" category="stable" url="where is the description" /&gt;</code>
 
351
            </hint>
 
352
        </question>
 
353
-->
 
354
 <answer id="dep-nb">
 
355
  <defaultanswer generate='here' />
 
356
 </answer>
 
357
 
 
358
 
 
359
 
 
360
<!--
 
361
        <question id="dep-non-nb" when="init">
 
362
            What other projects outside NetBeans does this one depend on?
 
363
            
 
364
            <hint>
 
365
            Some non-NetBeans projects are packaged as NetBeans modules
 
366
            (see <a href="http://libs.netbeans.org/">libraries</a>) and
 
367
            it is preferred to use this approach when more modules may
 
368
            depend on such third-party library.
 
369
            </hint>
 
370
        </question>
 
371
-->
 
372
 <answer id="dep-non-nb">
 
373
  <p>
 
374
   Indirectly, Apache Ant and JUnit.
 
375
  </p>
 
376
 </answer>
 
377
 
 
378
 
 
379
 
 
380
<!--
 
381
        <question id="dep-platform" when="init">
 
382
            On which platforms does your module run? Does it run in the same
 
383
            way on each?
 
384
            <hint>
 
385
            If your module is using JNI or deals with special differences of
 
386
            OSes like filesystems, etc. please describe here what they are.
 
387
            </hint>
 
388
        </question>
 
389
-->
 
390
 <answer id="dep-platform">
 
391
  <p>
 
392
   Any.
 
393
  </p>
 
394
 </answer>
 
395
 
 
396
 
 
397
 
 
398
<!--
 
399
        <question id="deploy-dependencies" when="final">
 
400
            What do other modules need to do to declare a dependency on this one?
 
401
            <hint>
 
402
                Provide a sample of the actual lines you would add to a module manifest
 
403
                to declare a dependency, for example using OpenIDE-Module-Module-Dependencies
 
404
                or OpenIDE-Module-Requires. You may use the magic token @SPECIFICATION-VERSION@
 
405
                to represent the current specification version of the module.
 
406
            </hint>
 
407
        </question>
 
408
-->
 
409
 <answer id="deploy-dependencies">
 
410
  <p>
 
411
   N/A
 
412
  </p>
 
413
 </answer>
 
414
 
 
415
 
 
416
 
 
417
<!--
 
418
        <question id="deploy-jar" when="impl">
 
419
            Do you deploy just module JAR file(s) or other files as well?
 
420
            <hint>
 
421
            Usually a module consist of one JAR file (perhaps with Class-Path
 
422
            extensions) and also a configuration file that enables it. If you
 
423
            have any other files, use
 
424
            &lt;api group="java.io.File" name="yourname" type="export" category="friend"&gt;...&lt;/api&gt;
 
425
            to define the location, name and stability of your files (of course
 
426
            changing "yourname" and "friend" to suit your needs).
 
427
            
 
428
            If it uses more than one JAR, describe where they are located, how
 
429
            they refer to each other. 
 
430
            If it consist of module JAR(s) and other files, please describe
 
431
            what is their purpose, why other files are necessary. Please 
 
432
            make sure that installation/uninstallation leaves the system 
 
433
            in state as it was before installation.
 
434
            </hint>
 
435
        </question>
 
436
-->
 
437
 <answer id="deploy-jar">
 
438
  <p>
 
439
   Just a JAR.
 
440
  </p>
 
441
 </answer>
 
442
 
 
443
 
 
444
 
 
445
<!--
 
446
        <question id="deploy-nbm" when="impl">
 
447
            Can you deploy an NBM via the Update Center?
 
448
            <hint>
 
449
            If not why?
 
450
            </hint>
 
451
        </question>
 
452
-->
 
453
 <answer id="deploy-nbm">
 
454
  <p>
 
455
   Yes.
 
456
  </p>
 
457
 </answer>
 
458
 
 
459
 
 
460
 
 
461
<!--
 
462
        <question id="deploy-packages" when="init">
 
463
            Are packages of your module made inaccessible by not declaring them
 
464
            public?
 
465
            
 
466
            <hint>
 
467
            NetBeans module system allows restriction of access rights to
 
468
            public classes of your module from other modules. This prevents
 
469
            unwanted dependencies of others on your code and should be used
 
470
            whenever possible (<a href="http://www.netbeans.org/download/javadoc/OpenAPIs/org/openide/doc-files/upgrade.html#3.4-public-packages">
 
471
            public packages
 
472
            </a>). If you do not restrict access to your classes you are
 
473
            making it too easy for other people to misuse your implementation
 
474
            details, that is why you should have good reason for not 
 
475
            restricting package access.
 
476
            </hint>
 
477
        </question>
 
478
-->
 
479
 <answer id="deploy-packages">
 
480
  <p>
 
481
   No.
 
482
  </p>
 
483
 </answer>
 
484
 
 
485
 
 
486
 
 
487
<!--
 
488
        <question id="deploy-shared" when="final">
 
489
            Do you need to be installed in the shared location only, or in the user directory only,
 
490
            or can your module be installed anywhere?
 
491
            <hint>
 
492
            Installation location shall not matter, if it does explain why.
 
493
            Consider also whether <code>InstalledFileLocator</code> can help.
 
494
            </hint>
 
495
        </question>
 
496
-->
 
497
 <answer id="deploy-shared">
 
498
  <p>
 
499
   Either way is possible.
 
500
  </p>
 
501
 </answer>
 
502
 
 
503
 
 
504
 
 
505
<!--
 
506
        <question id="exec-ant-tasks" when="impl">
 
507
            Do you define or register any ant tasks that other can use?
 
508
            
 
509
            <hint>
 
510
            If you provide an ant task that users can use, you need to be very
 
511
            careful about its syntax and behaviour, as it most likely forms an
 
512
                  API for end users and as there is a lot of end users, their reaction
 
513
            when such API gets broken can be pretty strong.
 
514
            </hint>
 
515
        </question>
 
516
-->
 
517
 <answer id="exec-ant-tasks">
 
518
  <p>
 
519
   No.
 
520
  </p>
 
521
 </answer>
 
522
 
 
523
 
 
524
 
 
525
<!--
 
526
        <question id="exec-classloader" when="impl">
 
527
            Does your code create its own class loader(s)?
 
528
            <hint>
 
529
            A bit unusual. Please explain why and what for.
 
530
            </hint>
 
531
        </question>
 
532
-->
 
533
 <answer id="exec-classloader">
 
534
  <p>
 
535
   No.
 
536
  </p>
 
537
 </answer>
 
538
 
 
539
 
 
540
 
 
541
<!--
 
542
        <question id="exec-component" when="impl">
 
543
            Is execution of your code influenced by any (string) property
 
544
            of any of your components?
 
545
            
 
546
            <hint>
 
547
            Often <code>JComponent.getClientProperty</code>, <code>Action.getValue</code>
 
548
            or <code>PropertyDescriptor.getValue</code>, etc. are used to influence
 
549
            a behavior of some code. This of course forms an interface that should
 
550
            be documented. Also if one depends on some interface that an object
 
551
            implements (<code>component instanceof Runnable</code>) that forms an
 
552
            API as well.
 
553
            </hint>
 
554
        </question>
 
555
-->
 
556
 <answer id="exec-component">
 
557
  <p>
 
558
   Uses property <code>platform.ant.name</code> returned by the <code>J2SEPlatformImpl.getProperties()</code>
 
559
   to determine the name of platform used in build scripts.
 
560
  </p>
 
561
 </answer>
 
562
 
 
563
 
 
564
 
 
565
<!--
 
566
        <question id="exec-introspection" when="impl">
 
567
            Does your module use any kind of runtime type information (<code>instanceof</code>,
 
568
            work with <code>java.lang.Class</code>, etc.)?
 
569
            <hint>
 
570
            Check for cases when you have an object of type A and you also
 
571
            expect it to (possibly) be of type B and do some special action. That
 
572
            should be documented. The same applies on operations in meta-level
 
573
            (Class.isInstance(...), Class.isAssignableFrom(...), etc.).
 
574
            </hint>
 
575
        </question>
 
576
-->
 
577
 <answer id="exec-introspection">
 
578
  <p>
 
579
   No.
 
580
  </p>
 
581
 </answer>
 
582
 
 
583
 
 
584
 
 
585
<!--
 
586
        <question id="exec-privateaccess" when="final">
 
587
            Are you aware of any other parts of the system calling some of 
 
588
            your methods by reflection?
 
589
            <hint>
 
590
            If so, describe the "contract" as an API. Likely private or friend one, but
 
591
            still API and consider rewrite of it.
 
592
            </hint>
 
593
        </question>
 
594
-->
 
595
 <answer id="exec-privateaccess">
 
596
  <p>
 
597
   No.
 
598
  </p>
 
599
 </answer>
 
600
 
 
601
 
 
602
 
 
603
<!--
 
604
        <question id="exec-process" when="impl">
 
605
            Do you execute an external process from your module? How do you ensure
 
606
            that the result is the same on different platforms? Do you parse output?
 
607
            Do you depend on result code?
 
608
            <hint>
 
609
            If you feed an input, parse the output please declare that as an API.
 
610
            </hint>
 
611
        </question>
 
612
-->
 
613
 <answer id="exec-process">
 
614
  <p>
 
615
   No.
 
616
  </p>
 
617
 </answer>
 
618
 
 
619
 
 
620
 
 
621
<!--
 
622
        <question id="exec-property" when="impl">
 
623
            Is execution of your code influenced by any environment or
 
624
            Java system (<code>System.getProperty</code>) property?
 
625
            
 
626
            <hint>
 
627
            If there is a property that can change the behavior of your 
 
628
            code, somebody will likely use it. You should describe what it does 
 
629
            and the <a href="http://openide.netbeans.org/tutorial/api-design.html#life">stability category</a>
 
630
            of this API. You may use
 
631
            <pre>
 
632
                &lt;api type="export" group="property" name="id" category="private" url="http://..."&gt;
 
633
                    description of the property, where it is used, what it influence, etc.
 
634
                &lt;/api&gt;            
 
635
            </pre>
 
636
            </hint>
 
637
        </question>
 
638
-->
 
639
 <answer id="exec-property">
 
640
  <p>
 
641
   No.
 
642
  </p>
 
643
 </answer>
 
644
 
 
645
 
 
646
 
 
647
<!--
 
648
        <question id="exec-reflection" when="impl">
 
649
            Does your code use Java Reflection to execute other code?
 
650
            <hint>
 
651
            This usually indicates a missing or insufficient API in the other
 
652
            part of the system. If the other side is not aware of your dependency
 
653
            this contract can be easily broken.
 
654
            </hint>
 
655
        </question>
 
656
-->
 
657
 <answer id="exec-reflection">
 
658
  <p>
 
659
   No.
 
660
  </p>
 
661
 </answer>
 
662
 
 
663
 
 
664
 
 
665
<!--
 
666
        <question id="exec-threading" when="impl">
 
667
            What threading models, if any, does your module adhere to?
 
668
            <hint>
 
669
                If your module calls foreign APIs which have a specific threading model,
 
670
                indicate how you comply with the requirements for multithreaded access
 
671
                (synchronization, mutexes, etc.) applicable to those APIs.
 
672
                If your module defines any APIs, or has complex internal structures
 
673
                that might be used from multiple threads, declare how you protect
 
674
                data against concurrent access, race conditions, deadlocks, etc.,
 
675
                and whether such rules are enforced by runtime warnings, errors, assertions, etc.
 
676
                Examples: a class might be non-thread-safe (like Java Collections); might
 
677
                be fully thread-safe (internal locking); might require access through a mutex
 
678
                (and may or may not automatically acquire that mutex on behalf of a client method);
 
679
                might be able to run only in the event queue; etc.
 
680
                Also describe when any events are fired: synchronously, asynchronously, etc.
 
681
                Ideas: <a href="http://core.netbeans.org/proposals/threading/index.html#recommendations">Threading Recommendations</a> (in progress)
 
682
            </hint>
 
683
        </question>
 
684
-->
 
685
 <answer id="exec-threading">
 
686
  <p>
 
687
   Mixture, according to particular functionality:
 
688
   <code>ProjectManager.mutex()</code>, EQ, etc.
 
689
  </p>
 
690
 </answer>
 
691
 
 
692
 
 
693
 
 
694
<!--
 
695
        <question id="format-clipboard" when="impl">
 
696
            Which data flavors (if any) does your code read from or insert to
 
697
            the clipboard (by access to clipboard on means calling methods on <code>java.awt.datatransfer.Transferable</code>?
 
698
            
 
699
            <hint>
 
700
            Often Node's deal with clipboard by usage of <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>.
 
701
            Check your code for overriding these methods.
 
702
            </hint>
 
703
        </question>
 
704
-->
 
705
 <answer id="format-clipboard">
 
706
  <p>
 
707
   None.
 
708
  </p>
 
709
 </answer>
 
710
 
 
711
 
 
712
 
 
713
<!--
 
714
        <question id="format-dnd" when="impl">
 
715
            Which protocols (if any) does your code understand during Drag &amp; Drop?
 
716
            <hint>
 
717
            Often Node's deal with clipboard by usage of <code>Node.drag, Node.getDropType</code>. 
 
718
            Check your code for overriding these methods. Btw. if they are not overridden, they
 
719
            by default delegate to <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>.
 
720
            </hint>
 
721
        </question>
 
722
-->
 
723
 <answer id="format-dnd">
 
724
  <p>
 
725
   None.
 
726
  </p>
 
727
 </answer>
 
728
 
 
729
 
 
730
 
 
731
<!--
 
732
        <question id="format-types" when="impl">
 
733
            Which protocols and file formats (if any) does your module read or write on disk,
 
734
            or transmit or receive over the network? Do you generate an ant build script?
 
735
            Can it be edited and modified? 
 
736
            
 
737
            <hint>
 
738
            <p>
 
739
            Files can be read and written by other programs, modules and users. If they influence
 
740
            your behaviour, make sure you either document the format or claim that it is a private
 
741
            api (using the &lt;api&gt; tag). 
 
742
            </p>
 
743
            
 
744
            <p>
 
745
            If you generate an ant build file, this is very likely going to be seen by end users and
 
746
            they will be attempted to edit it. You should be ready for that and provide here a link
 
747
            to documentation that you have for such purposes and also describe how you are going to
 
748
            understand such files during next release, when you (very likely) slightly change the 
 
749
            format.
 
750
            </p>
 
751
            </hint>
 
752
        </question>
 
753
-->
 
754
 <answer id="format-types">
 
755
  <p>
 
756
   It writes files through the OpenAPIs, specifically through the FileSystem API
 
757
   and the Settings API.
 
758
   Additionally, it reads the files in the formats specified by the J2EE 1.4
 
759
   and Java EE 5 specification.
 
760
  </p>
 
761
  <p>
 
762
   The usual Ant-based project metadata files and build scripts.
 
763
  </p>
 
764
  <p>
 
765
   Depends on the structure of built Javadoc. It tries to find the <code>overview-summary.html</code> in the
 
766
   <code>api</code> folder, and the <code>package-summary.html</code> and Javadoc pages for classes in the
 
767
   package structure under the <code>api</code> folder.
 
768
  </p>
 
769
  <p>
 
770
   <!-- #58823 --> Writes XML-format JUnit results to <code>${build.test.results.dir}</code> for use by
 
771
   <code>org.netbeans.modules.junit</code>.
 
772
  </p>
 
773
 </answer>
 
774
 
 
775
 
 
776
 
 
777
<!--
 
778
        <question id="lookup-lookup" when="init">
 
779
            Does your module use <code>org.openide.util.Lookup</code>
 
780
            or any similar technology to find any components to communicate with? Which ones?
 
781
            
 
782
            <hint>
 
783
            Please describe the interfaces you are searching for, where 
 
784
            are defined, whether you are searching for just one or more of them,
 
785
            if the order is important, etc. Also classify the stability of such
 
786
            API contract. For that use &lt;api group=&amp;lookup&amp; /&gt; tag.
 
787
            </hint>
 
788
        </question>
 
789
-->
 
790
 <answer id="lookup-lookup">
 
791
  <p>
 
792
   Nothing special.
 
793
  </p>
 
794
 </answer>
 
795
 
 
796
 
 
797
 
 
798
<!--
 
799
        <question id="lookup-register" when="final">
 
800
            Do you register anything into lookup for other code to find?
 
801
            <hint>
 
802
            Do you register using layer file or using <code>META-INF/services</code>?
 
803
            Who is supposed to find your component?
 
804
            </hint>
 
805
        </question>
 
806
-->
 
807
 <answer id="lookup-register">
 
808
  <p>
 
809
   Project type and various query implementations are registered. An
 
810
   <code>AntLogger</code> is registered which currently just tweaks the
 
811
   appearance of compiler errors.
 
812
  </p>
 
813
 </answer>
 
814
 
 
815
 
 
816
 
 
817
<!--
 
818
        <question id="lookup-remove" when="final">
 
819
            Do you remove entries of other modules from lookup?
 
820
            <hint>
 
821
            Why? Of course, that is possible, but it can be dangerous. Is the module
 
822
            your are masking resource from aware of what you are doing?
 
823
            </hint>
 
824
        </question>
 
825
-->
 
826
 <answer id="lookup-remove">
 
827
  <p>
 
828
   No.
 
829
  </p>
 
830
 </answer>
 
831
 
 
832
 
 
833
 
 
834
<!--
 
835
        <question id="perf-exit" when="final">
 
836
            Does your module run any code on exit?
 
837
        </question>
 
838
-->
 
839
 <answer id="perf-exit">
 
840
  <p>
 
841
   Not usually, though modified project metadata is saved on close or exit.
 
842
   (Normally all GUI actions autosave immediately anyway.) It also unregisters
 
843
   some listeners.
 
844
  </p>
 
845
 </answer>
 
846
 
 
847
 
 
848
 
 
849
<!--
 
850
        <question id="perf-huge_dialogs" when="final">
 
851
            Does your module contain any dialogs or wizards with a large number of
 
852
            GUI controls such as combo boxes, lists, trees, or text areas?
 
853
        </question>
 
854
-->
 
855
 <answer id="perf-huge_dialogs">
 
856
  <p>
 
857
   No, all dialogs and wizards are of reasonable complexity.
 
858
  </p>
 
859
 </answer>
 
860
 
 
861
 
 
862
 
 
863
<!--
 
864
        <question id="perf-limit" when="init">
 
865
            Are there any hard-coded or practical limits in the number or size of
 
866
            elements your code can handle?
 
867
        </question>
 
868
-->
 
869
 <answer id="perf-limit">
 
870
  <p>
 
871
   None known.
 
872
  </p>
 
873
 </answer>
 
874
 
 
875
 
 
876
 
 
877
<!--
 
878
        <question id="perf-mem" when="final">
 
879
            How much memory does your component consume? Estimate
 
880
            with a relation to the number of windows, etc.
 
881
        </question>
 
882
-->
 
883
 <answer id="perf-mem">
 
884
  <p>
 
885
   Unknown. Probably not much.
 
886
  </p>
 
887
 </answer>
 
888
 
 
889
 
 
890
 
 
891
<!--
 
892
        <question id="perf-menus" when="final">
 
893
            Does your module use dynamically updated context menus, or
 
894
            context-sensitive actions with complicated and slow enablement logic?
 
895
            <hint>
 
896
                If you do a lot of tricks when adding actions to regular or context menus, you can significantly
 
897
                slow down display of the menu, even when the user is not using your action. Pay attention to
 
898
                actions you add to the main menu bar, and to context menus of foreign nodes or components. If
 
899
                the action is conditionally enabled, or changes its display dynamically, you need to check the
 
900
                impact on performance. In some cases it may be more appropriate to make a simple action that is
 
901
                always enabled but does more detailed checks in a dialog if it is actually run.
 
902
            </hint>
 
903
        </question>
 
904
-->
 
905
 <answer id="perf-menus">
 
906
  <p>
 
907
   No.
 
908
  </p>
 
909
 </answer>
 
910
 
 
911
 
 
912
 
 
913
<!--
 
914
        <question id="perf-progress" when="final">
 
915
            Does your module execute any long-running tasks?
 
916
            
 
917
            <hint>Long running tasks should never block 
 
918
            AWT thread as it badly hurts the UI
 
919
            <a href="http://performance.netbeans.org/responsiveness/issues.html">
 
920
            responsiveness</a>.
 
921
            Tasks like connecting over
 
922
            network, computing huge amount of data, compilation
 
923
            be done asynchronously (for example
 
924
            using <code>RequestProcessor</code>), definitively it should 
 
925
            not block AWT thread.
 
926
            </hint>
 
927
        </question>
 
928
-->
 
929
 <answer id="perf-progress">
 
930
  <p>
 
931
   It launches the compilation of Java files, and deployment of
 
932
   standalone Application Client Module.
 
933
   Although ultimately these tasks are not directly performed 
 
934
   by this module (but by cooperating modules), it can be assumed that these tasks 
 
935
   will be long running.
 
936
   Another long running task is the mounting of additional filesystems when
 
937
   an application client module is registered or created in the IDE.
 
938
  </p>
 
939
 </answer>
 
940
 
 
941
 
 
942
 
 
943
<!--
 
944
        <question id="perf-scale" when="init">
 
945
            Which external criteria influence the performance of your
 
946
            program (size of file in editor, number of files in menu, 
 
947
            in source directory, etc.) and how well your code scales?
 
948
            <hint>
 
949
            Please include some estimates, there are other more detailed 
 
950
            questions to answer in later phases of implementation. 
 
951
            </hint>
 
952
        </question>
 
953
-->
 
954
 <answer id="perf-scale">
 
955
  <p>
 
956
   Number of source files in the project will affect the time it takes to scan
 
957
   for a main class.
 
958
  </p>
 
959
 </answer>
 
960
 
 
961
 
 
962
 
 
963
<!--
 
964
        <question id="perf-spi" when="init">
 
965
            How the performance of the plugged in code will be enforced?
 
966
            <hint>
 
967
            If you allow foreign code to be plugged into your own module, how
 
968
            do you enforce that it will behave correctly and quickly and will not
 
969
            negatively influence the performance of your own module?
 
970
            </hint>
 
971
        </question>
 
972
-->
 
973
 <answer id="perf-spi">
 
974
  <p>
 
975
   N/A
 
976
  </p>
 
977
 </answer>
 
978
 
 
979
 
 
980
 
 
981
<!--
 
982
        <question id="perf-startup" when="final">
 
983
            Does your module run any code on startup?
 
984
        </question>
 
985
-->
 
986
 <answer id="perf-startup">
 
987
  <p>
 
988
   No.
 
989
  </p>
 
990
 </answer>
 
991
 
 
992
 
 
993
 
 
994
<!--
 
995
        <question id="perf-wakeup" when="final">
 
996
            Does any piece of your code wake up periodically and do something
 
997
            even when the system is otherwise idle (no user interaction)?
 
998
        </question>
 
999
-->
 
1000
 <answer id="perf-wakeup">
 
1001
  <p>
 
1002
   No.
 
1003
  </p>
 
1004
 </answer>
 
1005
 
 
1006
 
 
1007
 
 
1008
<!--
 
1009
        <question id="resources-file" when="final">
 
1010
            Does your module use <code>java.io.File</code> directly?
 
1011
            
 
1012
            <hint>
 
1013
            NetBeans provide a logical wrapper over plain files called 
 
1014
            <code>org.openide.filesystems.FileObject</code> that
 
1015
            provides uniform access to such resources and is the preferred
 
1016
            way that should be used. But of course there can be situations when
 
1017
            this is not suitable.
 
1018
            </hint>
 
1019
        </question>
 
1020
-->
 
1021
 <answer id="resources-file">
 
1022
  <p>
 
1023
   Yes. The use of <code>java.io.File</code> is needed for interaction with the
 
1024
   Server Integration APIs, which expect it as parameters in some API calls.
 
1025
  </p>
 
1026
 </answer>
 
1027
 
 
1028
 
 
1029
 
 
1030
<!--
 
1031
        <question id="resources-layer" when="final">
 
1032
            Does your module provide own layer? Does it create any files or
 
1033
            folders in it? What it is trying to communicate by that and with which 
 
1034
            components?
 
1035
            
 
1036
            <hint>
 
1037
            NetBeans allows automatic and declarative installation of resources 
 
1038
            by module layers. Module register files into appropriate places
 
1039
            and other components use that information to perform their task
 
1040
            (build menu, toolbar, window layout, list of templates, set of
 
1041
            options, etc.). 
 
1042
            </hint>
 
1043
        </question>
 
1044
-->
 
1045
 <answer id="resources-layer">
 
1046
  <p>
 
1047
   The new project wizard is registered in the layer.
 
1048
  </p>
 
1049
 </answer>
 
1050
 
 
1051
 
 
1052
 
 
1053
<!--
 
1054
        <question id="resources-mask" when="final">
 
1055
            Does your module mask/hide/override any resources provided by other modules in
 
1056
            their layers?
 
1057
            
 
1058
            <hint>
 
1059
            If you mask a file provided by another module, you probably depend
 
1060
            on that and do not want the other module to (for example) change
 
1061
            the file's name. That module shall thus make that file available as an API
 
1062
            of some stability category.
 
1063
            </hint>
 
1064
        </question>
 
1065
-->
 
1066
 <answer id="resources-mask">
 
1067
  <p>
 
1068
   No.
 
1069
  </p>
 
1070
 </answer>
 
1071
 
 
1072
 
 
1073
 
 
1074
<!--
 
1075
        <question id="resources-read" when="final">
 
1076
            Does your module read any resources from layers? For what purpose?
 
1077
            
 
1078
            <hint>
 
1079
            As this is some kind of intermodule dependency, it is a kind of API.
 
1080
            Please describe it and classify according to 
 
1081
            <a href="http://openide.netbeans.org/tutorial/api-design.html#categories">
 
1082
            common stability categories</a>.
 
1083
            </hint>
 
1084
        </question>
 
1085
-->
 
1086
 <answer id="resources-read">
 
1087
    <api group="layer" name="ClientLookup" type="export" category="official">
 
1088
     <p>
 
1089
       "Projects/org-netbeans-modules-j2ee-clientproject/Lookup" folder's content is used to construct the project's additional lookup.
 
1090
       It's content is expected to be <code>LookupProvider</code> instances. AppClient project provides <code>LookupMerger</code>s 
 
1091
       for <code>Sources</code>, <code>PrivilegedTemplates</code> and <code>RecommendedTemplates</code>. Implementations added by 3rd parties 
 
1092
       will be merged into a single instance in the project's lookup.
 
1093
     </p>
 
1094
    </api>
 
1095
    <api group="layer" name="ClientProjectCustomizer" type="export" category="official">
 
1096
     <p>
 
1097
       "Projects/org-netbeans-modules-j2ee-clientproject/Customizer" folder's content is used to construct the project's customizer.
 
1098
       It's content is expected to be <code>ProjectCustomizer.CompositeCategoryProvider</code> instances.
 
1099
       The lookup passed to the panels contains an instance of <code>Project</code> and <code>org.netbeans.modules.j2ee.clientproject.ui.customizer.AppClientProjectProperties</code>
 
1100
       Please note that the latter is not part of any public APIs and you need implementation dependency to make use of it.
 
1101
     </p>
 
1102
    </api>
 
1103
 </answer>
 
1104
 
 
1105
 
 
1106
 
 
1107
<!--
 
1108
        <question id="security-grant" when="final">
 
1109
            Does your code grant additional rights to some other code?
 
1110
            <hint>Avoid using a class loader that adds extra
 
1111
            permissions to loaded code unless really necessary.
 
1112
            Also note that your API implementation
 
1113
            can also expose unneeded permissions to enemy code by
 
1114
            calling AccessController.doPrivileged().</hint>
 
1115
        </question>
 
1116
-->
 
1117
 <answer id="security-grant">
 
1118
  <p>
 
1119
   No.
 
1120
  </p>
 
1121
 </answer>
 
1122
 
 
1123
 
 
1124
 
 
1125
<!--
 
1126
        <question id="security-policy" when="final">
 
1127
            Does your functionality require modifications to the standard policy file?
 
1128
            <hint>Your code might pass control to third-party code not
 
1129
            coming from trusted domains. This could be code downloaded over the
 
1130
            network or code coming from libraries that are not bundled
 
1131
            with NetBeans. Which permissions need to be granted to which domains?</hint>
 
1132
        </question>
 
1133
-->
 
1134
 <answer id="security-policy">
 
1135
  <p>
 
1136
   No.
 
1137
  </p>
 
1138
 </answer>
 
1139
 
 
1140
</api-answers>