NetBeans Architecture Answers for XML WSDL API module

General Information

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

The WSDL model provides the ability to read, write, and extend documents complying with the WSDL 1.1 specification.

• Full document fidelty
• Support for undo/redo
• Support for sync which allow changes to be detected in the underlying source and mutating the model to be compatible
• Visitor support
• Incorporation of the XAM locator for catalog based resolution of referenced wsdl artifacts
• Use of reference instead of raw URI to support retrieving the actual component referenced instead of a URI
• Support for generic and strongly typed extensibility elements
Question (arch-overall): Describe the overall architecture.
Answer:

The wsdl model provides a read and write model based on XDM and XAM.

wsdl.model - This package provides API's for obtaining a wsdl model using the factory pattern as well as reading and writing the wsdl structure. This package is made up mostly of interfaces, which are not expected to be implemented by the client. The entry point is the wsdl model factory. The components are based on the structure of wsdl and the names should reflect element and attribute names from the specification. wsdl.model.visitor - Generic visitor pattern support (such as empty and deep visitors) as well as visitors for finding usages. wsdl.model.spi - The SPI package provides the ability to plug-in strongly typed extensibility elements, which are used in every concrete wsdl for bindings. wsdl.model.extensions.soap - Strongly typed extensibility elements for the SOAP binding. wsdl.model.extensions.xsd - Strongly typed extensibility element for Schema. This supports embedding the schema model within the WSDL model to introspect the types section of WSDL.
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:

The typical client of the WSDL model would be a tool author requiring read or write access to WSDL.

customization editor

Both Tango and JAXWS define WSDL extensions which support customization of their capabilities. The WSDL model supports the ability to add strongly typed extensions. The Web Service customization relies on this support to read and write extensibility elements from an existing WSDL document.

WSDL editor

The WSDL editor uses the WSDL model to support both textual and graphical editing.

Validation

Only some of the WSDL semantics can be described in terms of XML schema. The visitor is used to provide additional validation semantics to ensure successful deployment to the BPEL engine. Here is a code sample for working with the WSDL model:

FileObject wsdlFileObj = ...; // get file object for WSDL
ModelSource source =
org.netbeans.modules.xml.xam.locator.api.Utilities.getModelSource(wsdlFileObj, true);
WSDLModel model = WSDLModelFactory.getDefault().getModel(source);
// access port types
Collection<PortType> portTypes = model.getDefinitions().getPortTypes();

// add port type
PortType pt = model.getFactory().createPortType();
pt.setName("newPortType");
// pt manipulation before adding to model, name, etc.
try {
// model must be manipulated in transaction
model.startTransaction();
// add port type to model
model.getDefinitions().addPortType(pt);
} finally {
model.endTransaction();
}

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

This module is implementation complete, but will require additional effort for ongoing maintenence in conjunction with the other modules.

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

Junit tests are provided and expected to cover the common functionality. The implementation is based on XDM and XAM and thus the implementations of the classes mostly perform parameterized manipulation of the underlying XDM model. Thus the testing approach is to have extensive unit testing for areas where custom code needs to be written (such as resolving references and sync) and course grained (does wsdl x work appropriately) for the balance of the features. As part of the development process we also use findBugs for static analysis.

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

The sources for the module are in the Apache Git repositories or in the GitHub repositories.

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:

• org.netbeans.modules.xml.schema.model - The module is needed for compilation. The module is used during runtime. Specification version 1.0 is required.
• org.netbeans.modules.xml.xam - The module is needed for compilation. The module is used during runtime. Specification version 1.11.0 is required.
• FilesystemsAPI - The module is needed for compilation. The module is used during runtime. Specification version 9.0 is required.
• UtilitiesAPI - The module is needed for compilation. The module is used during runtime. Specification version 9.3 is required.
• WeakListener.setAccessible - The module is needed for compilation. The module is used during runtime. Specification version 9.3 is required.
• LookupAPI - The module is needed for compilation. The module is used during runtime. Specification version 8.0 is required.
Question (dep-non-nb): What other projects outside NetBeans does this one depend on?
Answer:

none

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

100% pure java

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

1.5

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

jre is sufficient

Deployment

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

jar only

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:

installed anywhere

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

yes, only the packages which are intended for external use are marked public. Additionally the friend mechanism is used.

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:

The API's are currently exposed through the friend mechanism, thus another module would need to be added to the friends list.

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:

This modules supports reading and writing WSDL 1.1 compliant documents.

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:

no settings are used.

Question (compat-deprecation): How the introduction of your project influences functionality provided by previous version of the product?
WARNING: Question with id="compat-deprecation" has not been answered!

Access to resources

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

no

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

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 ?
WARNING: Question with id="resources-preferences" has not been answered!

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:

lookup - org.openide.util.Lookup is used to obtain the list of org.netbeans.modules.xml.wsdl.model.spi.ElementFactory instances. A factory supports recognition and creation of extensibility elements based on the specified QNames. The first factory supporting a given QName is the factory providing the component instance (Order is important).

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

The extension mechanism for registering external factories is also used for internal factories. These factories are expected to be discovered when creating the WSDL model components. The factories are registered using 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? On a similar note, is there something interesting that you pass to java.util.logging.Logger? Or do you observe what others log?
Answer:

no

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:

Yes, but this is minimal and documented.

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

This model uses the threading model of XAM/XDM. No additional synchronization has been added in the module.

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:

WSDL version 1.1 compatible XML documents.

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:

The size of the WSDL document and the number of components affect scalability. Performance testing has been performed on industry standard WSDL documents to ensure reasonable performance in practical situatitions.

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

There are no hard coded limits.

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

A empty populated model is about 8000 bytes, this depends on how many components and the size of the file. Each additional component adds about 20 bytes.

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, this module is called by other modules.

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:

There are no special provisions.