NetBeans Architecture Answers for web/freeform module

General Information

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

This module implements Web development support in Freeform project type. See Freeform project type documentation for its general description. The main features of this extension are:

1. Answers Web specific queries like WebModule provider, etc.

2. Provides wizard to help the user set up a new project with Web support.

Specifications:

1. UI Specification
2. Architecture Sketch
Question (arch-overall): Describe the overall architecture.
Answer:

Web development support for freeform project. There is no API/SPI.

The behavior of this extension is entirely controlled by project.xml:

1. freeform-project-web.xsd -

   XML schema for the Web-specific section.

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:

See the Architecture Sketch for justifications of the module.

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

Complete.

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

Unit test coverage should be high, except for the GUI portions which may be covered by functional tests in the future.

Project and platform dependencies

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

  Base Freeform SPI.

• AntProjectAPI -

  The SPI is used heavily to implement various queries, evaluate Ant properties at development time, etc.

• JavaSupportAPIs -

  Implements the classpath query.

• JavaPlatformAPI -

  Looks for registered Java platforms to handle the boot classpath.

• JavaFreeformProjectSPI -

  Used for instantiation of Java support in Web freeform project.

• JavaProjectAPI -

  Used for the Java package view, etc.

• WebModuleAPI -

  Used to answer web-app-specific queries.

• ProjectAPI -

  Basic project API.

• ProjectUIAPI -

  Used to register the project open hook, etc.

• GeneralQueriesAPI -

  For checking file collocation.

• Filesystems -

  Used for many purposes.

• Nodes -

  Used to show the logical view.

• Wizards -

  For the new project wizards.

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

None. (Implicitly Apache Ant.)

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

Any.

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

1.4+.

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

JRE.

Deployment

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

Just a JAR.

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:

Anywhere.

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

Yes

Question (deploy-dependencies): What do other modules need to do to declare a dependency on this one?
Answer:

N/A

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:

Defines project syntax of Web support. There is no known independent format for this.

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:

Project XML schemas namespaces are versioned.

Access to resources

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

Where needed to evaluate Ant properties or satisfy queries.

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:

Registers new project wizards.

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.

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:

Just usual getDefault methods.

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

Implementation of ProjectNature is registered in META-INF/services.

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?
Answer:

No.

Question (exec-component): Is execution of your code influenced by any (string) property of any of your components?
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?
Answer:

Uses ProjectManager.mutex() in some cases. Mostly depends on threading model of queries. EQ for GUI things of course.

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?
Answer:

None.

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

None.

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:

None.

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:

Nothing known.

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

None in particular.

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

Unknown; probably small.

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. There is one customizer panel which is provided by this extension and which is part of Freeform project customizer, but it is of reasonable size.

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

No.

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

N/A