NetBeans Architecture Answers for module

General Information

Question (arch-what): What is this project good for?
Answer:

No need for adding JAX-WS 2.1 and JAXB 2.1 API libraries to the project.

Question (arch-overall): Describe the overall architecture.
Answer:

The API is useful for plugins that want to integrate JAX-WS 2.1 and JAXB 2.1 technology.

Question (arch-usecases): Describe the main use cases of the new API. Who will use it under what circumstances? What kind of code would typically need to be written to use the module?
Answer:

Typical usecase is the following :
A plugin developer want to make use of a well known web service (search service, translator web service, etc.) and integrate a client for that web service in a plugin.
Usually, the client artifacts must be generated from a wsdl file: either using of Netbeans 6.0 IDE or manually (by JAX-WS 2.1 wsimport command). Then the java artifacts can be copied to the plugin module and whatever client code can be written.
The advantage of this API is obvious : The plugin will be working without need for adding external (JAX-WS 2.1) libraries to it, forasmuch as the generated java artifacts depend on jAX-WS 2.1 APIs.

Question (arch-time): What are the time estimates of the work?
Answer:

Implementation is straightforward. Expected milestone : Netbeans 6.0 (Beta 1)

Question (arch-quality): How will the quality of your code be tested and how are future regressions going to be prevented?
Answer:

This API is in fact a wraper library module for JAX-WS 2.1 and JAXB 2.1 API libraries. There is no need for testing this library.

Question (arch-where): Where one can find sources for your module?
Answer:

The sources for the module are in NetBeans CVS in websvc/jaxws21api directory.

Project and platform dependencies

Question (dep-nb): What other NetBeans projects and modules does this one depend on?
Answer:

These modules are required in project.xml:

Question (dep-non-nb): What other projects outside NetBeans does this one depend on?
Answer:

JAX-WS APIs. See https://jax-ws.dev.java.net/

Question (dep-platform): On which platforms does your module run? Does it run in the same way on each?
Answer:

All platforms.

Question (dep-jre): Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?
Answer:

JRE 1.5 and higher

Question (dep-jrejdk): Do you require the JDK or is the JRE enough?
Answer:

JRE is enough

Deployment

Question (deploy-jar): Do you deploy just module JAR file(s) or other files as well?
Answer:

<api group = "java.io.File" name="jaxws-api.jar" type="export" category="standard"/>
<api group = "java.io.File" name="jaxb-api.jar" type="export" category="standard"/>
<api group = "java.io.File" name="jsr173_api.jar" type="export" category="standard"/>
<api group = "java.io.File" name="jsr181-api.jar" type="export" category="standard"/>
<api group = "java.io.File" name="jsr250-api.jar" type="export" category="standard"/>
<api group = "java.io.File" name="saaj-api.jar" type="export" category="standard"/>

Question (deploy-nbm): Can you deploy an NBM via the Update Center?
Answer:

Yes

Question (deploy-shared): Do you need to be installed in the shared location only, or in the user directory only, or can your module be installed anywhere?
Answer:

The module can be installed anywhere.

Question (deploy-packages): Are packages of your module made inaccessible by not declaring them public?
Answer:

XXX no answer for deploy-packages

Question (deploy-dependencies): What do other modules need to do to declare a dependency on this one, in addition to or instead of the normal module dependency declaration (e.g. tokens to require)?
Answer:

No extra work is needed.

Compatibility with environment

Question (compat-i18n): Is your module correctly internationalized?
Answer:

Yes

Question (compat-standards): Does the module implement or define any standards? Is the implementation exact or does it deviate somehow?
Answer:

No

Question (compat-version): Can your module coexist with earlier and future versions of itself? Can you correctly read all old settings? Will future versions be able to read your current settings? Can you read or politely ignore settings stored by a future version?
Answer:

It is not expected that JAX-WS 2.1 API's will be changed.

Question (compat-deprecation): How the introduction of your project influences functionality provided by previous version of the product?
Answer:

Previous version of JAX-WS 2.1 library module existed in a form of Friend API. Standard API significantly simplifies the usage.

Access to resources

Question (resources-file): Does your module use java.io.File directly?
Answer:

XXX no answer for resources-file

Question (resources-layer): Does your module provide own layer? Does it create any files or folders in it? What it is trying to communicate by that and with which components?
Answer:

No layer file

Question (resources-read): Does your module read any resources from layers? For what purpose?
Answer:

No

Question (resources-mask): Does your module mask/hide/override any resources provided by other modules in their layers?
Answer:

No

Question (resources-preferences): Does your module uses preferences via Preferences API? Does your module use NbPreferences or or regular JDK Preferences ? Does it read, write or both ? Does it share preferences with other modules ? If so, then why ?
Answer:

No

Lookup of components

Question (lookup-lookup): Does your module use org.openide.util.Lookup or any similar technology to find any components to communicate with? Which ones?
Answer:

No

Question (lookup-register): Do you register anything into lookup for other code to find?
Answer:

Nothing

Question (lookup-remove): Do you remove entries of other modules from lookup?
Answer:

No

Execution Environment

Question (exec-property): Is execution of your code influenced by any environment or Java system (System.getProperty) property? On a similar note, is there something interesting that you pass to java.util.logging.Logger? Or do you observe what others log?
Answer:

Since most of those API classe are already integrated in jdk1.6, IDE masks all JAX-WS 2.1 packages, included in jre, and the system property "java.endorsed.dirs" doesn't need to be set up.

Question (exec-component): Is execution of your code influenced by any (string) property of any of your components?
Answer:

No

Question (exec-ant-tasks): Do you define or register any ant tasks that other can use?
Answer:

No

Question (exec-classloader): Does your code create its own class loader(s)?
Answer:

No

Question (exec-reflection): Does your code use Java Reflection to execute other code?
Answer:

No

Question (exec-privateaccess): Are you aware of any other parts of the system calling some of your methods by reflection?
Answer:

No

Question (exec-process): Do you execute an external process from your module? How do you ensure that the result is the same on different platforms? Do you parse output? Do you depend on result code?
Answer:

No

Question (exec-introspection): Does your module use any kind of runtime type information (instanceof, work with java.lang.Class, etc.)?
Answer:

No

Question (exec-threading): What threading models, if any, does your module adhere to? How the project behaves with respect to threading?
Answer:

No

Question (security-policy): Does your functionality require modifications to the standard policy file?
Answer:

No

Question (security-grant): Does your code grant additional rights to some other code?
Answer:

No

Format of files and protocols

Question (format-types): Which protocols and file formats (if any) does your module read or write on disk, or transmit or receive over the network? Do you generate an ant build script? Can it be edited and modified?
Answer:

No protocol, no file formats

Question (format-dnd): Which protocols (if any) does your code understand during Drag & Drop?
Answer:

No protocols

Question (format-clipboard): Which data flavors (if any) does your code read from or insert to the clipboard (by access to clipboard on means calling methods on java.awt.datatransfer.Transferable?
Answer:

No data flavors

Performance and Scalability

Question (perf-startup): Does your module run any code on startup?
Answer:

No

Question (perf-exit): Does your module run any code on exit?
Answer:

No

Question (perf-scale): Which external criteria influence the performance of your program (size of file in editor, number of files in menu, in source directory, etc.) and how well your code scales?
Answer:

Not aware of any

Question (perf-limit): Are there any hard-coded or practical limits in the number or size of elements your code can handle?
Answer:

No

Question (perf-mem): How much memory does your component consume? Estimate with a relation to the number of windows, etc.
Answer:

XXX no answer for perf-mem

Question (perf-wakeup): Does any piece of your code wake up periodically and do something even when the system is otherwise idle (no user interaction)?
Answer:

No

Question (perf-progress): Does your module execute any long-running tasks?
Answer:

No

Question (perf-huge_dialogs): Does your module contain any dialogs or wizards with a large number of GUI controls such as combo boxes, lists, trees, or text areas?
Answer:

No

Question (perf-menus): Does your module use dynamically updated context menus, or context-sensitive actions with complicated and slow enablement logic?
Answer:

No

Question (perf-spi): How the performance of the plugged in code will be enforced?
Answer:

No SPI