NetBeans Architecture Answers for Scripting API Wrapper module

General Information

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

NetBeans specific extensions to JDK's Scripting API can be found in this module.

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

This module provides a wrapper around JDK's ScriptEngineManager that is aware of NetBeans specific extensions. Please see the scripting tutorial to read about many interesting use-cases.

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:

Create ScriptEngineManager

To create new instance script engine manager ready for the NetBeans execution environment use org.netbeans.api.scripting - Scripting class offers static createManager() method that should be used whenever one needs an instance of ScriptEngineManager inside of NetBeans based application. Many client oriented use-cases are covered in the scripting tutorial.

Dynamic registration of ScriptEngineFactory

org.netbeans.spi.scripting - Implement EngineProvider and register it into global lookup via ServiceProvider to dynamically discover and offer new ScriptEngines to users of ScriptEngineManager obtained via Scripting factory methods.

Static registration of ScriptEngineFactory

To register additional scripting engine, just include its JAR file in the application. Its factory registration in META-INF/services/javax.script.ScriptEngineFactory will be found and used by Scripting factory methods. Alternatively you can implement and register EngineProvider as in the dynamic registration use-case.

In any case don't forget to advertise your engine to the runtime container via OpenIDE-Module-Providers: javax.script.ScriptEngine."engineName" tag as specified by manifest registration API.

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

Ready for Apache NetBeans 11 release.

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

Unit tested.

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:

• LookupAPI - The module is needed for compilation. The module is used during runtime. Specification version 8.36 is required.
Question (dep-non-nb): What other projects outside NetBeans does this one depend on?
Answer:

XXX no answer for dep-non-nb

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

XXX no answer for dep-platform

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

XXX no answer for dep-jre

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

XXX no answer for dep-jrejdk

Deployment

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

XXX no answer for deploy-jar

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

XXX no answer for deploy-nbm

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:

XXX no answer for deploy-shared

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:

XXX no answer for deploy-dependencies

Compatibility with environment

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

XXX no answer for compat-i18n

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

Provides extended version of JDK's ScriptEngineManager.

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:

XXX no answer for compat-version

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

XXX no answer for compat-deprecation

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:

XXX no answer for resources-layer

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

XXX no answer for resources-read

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

XXX no answer for resources-mask

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:

XXX no answer for resources-preferences

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:

XXX no answer for lookup-lookup

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

XXX no answer for lookup-register

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

XXX no answer for lookup-remove

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: manifest.ScriptEngine - If your module wants to use a script engine of given name, then include a token dependency
• for example OpenIDE-Module-Needs: javax.script.ScriptEngine.js
• or OpenIDE-Module-Needs: javax.script.ScriptEngine.python
• or OpenIDE-Module-Recommends: javax.script.ScriptEngine.ruby
in your manifest file (also accessible through project customizer GUI) to indicate to the system that you need it.
Modules that provide implementations of enginesshould use OpenIDE-Module-Provides tag to advertise them. Only then the runtime container can make sure all requested providers in the application are really enabled and the dependencies are satisfied.
Question (exec-component): Is execution of your code influenced by any (string) property of any of your components?
Answer:

allowAllAccess - If Scripting.allowAllAccess is used, then a property allowAllAccess is placed into the ScriptManager.getBindings() with value true.

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

XXX no answer for exec-ant-tasks

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

XXX no answer for exec-classloader

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

XXX no answer for exec-reflection

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

XXX no answer for exec-privateaccess

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:

XXX no answer for exec-process

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

XXX no answer for exec-introspection

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

XXX no answer for exec-threading

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

XXX no answer for security-policy

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

XXX no answer for security-grant

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:

XXX no answer for format-types

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

XXX no answer for format-dnd

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:

XXX no answer for format-clipboard

Performance and Scalability

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

XXX no answer for perf-startup

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

XXX no answer for perf-exit

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:

XXX no answer for perf-scale

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

XXX no answer for perf-limit

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:

XXX no answer for perf-wakeup

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

XXX no answer for perf-progress

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:

XXX no answer for perf-huge_dialogs

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

XXX no answer for perf-menus

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

XXX no answer for perf-spi