NetBeans Architecture Answers for Core module

General Information

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

XXX no answer for arch-what

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

NetBeansCore - The heart of NetBeans. It contains basic implementation of all necessary interfaces, takes care of the startup sequence and the whole lifecycle of any NetBeans based application.

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: No special APIs exported beyond few friend contracts:
• org.netbeans.core.modules.AutomaticDependencies
• org.netbeans.core.WindowSystem
Question (arch-time): What are the time estimates of the work?
Answer:

Done.

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

Tests in core/test.

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:

XXX no answer for dep-nb

The default answer to this question is:


These modules are required in project.xml:

• ExceptionAnnotatableUsingLogRecords - The module is needed for compilation. The module is used during runtime. Specification version 2.38 is required.
• org.netbeans.core.startup - The module is needed for compilation. The module is used during runtime. Specification version 1.60 is required.
• Keyring-API - The module is needed for compilation. The module is used during runtime. Specification version 1.0 is required.
• SamplerAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.0 is required.
• PlafAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.16 is required.
• ActionsAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
• org.openide.awt - The module is needed for compilation. The module is used during runtime. Specification version 7.82 is required.
• DialogsAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
• ExplorerAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.23 is required.
• FilesystemsAPI - The module is needed for compilation. The module is used during runtime. Specification version 9.0 is required.
• InputOutputAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.11 is required.
• LoadersAPI - The module is needed for compilation. The module is used during runtime. Specification version 7.61 is required.
• ModulesAPI - The module is needed for compilation. The module is used during runtime. Specification version 7.25 is required.
• NodesAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.2 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.
• WindowSystemAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.2 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:

Nothing.

Compatibility with environment

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

Yes, fully I18Ned.

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

Yes.

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:

Only one core can be present in running NetBeans based application.

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:

Keymaps - Keymaps folder contains subfolders for individual keymaps (Emacs, JBuilder, NetBeans). The name of keymap can be localized. Use "SystemFileSystem.localizingBundle" attribute of your folder for this purpose. Individual keymap folder contains shadows to actions. Shortcut is mapped to the name of file. Emacs shortcut format is used, multikeys are separated by space chars ("C-X P" means Ctrl+X followed by P). "currentKeymap" property of "Keymaps" folder contains original (not localized) name of current keymap. Shortcuts - This folder contains registration of shortcuts. Its supported for backward compatibility purpose only. All new shortcuts should be registerred in "Keymaps/NetBeans" folder. Shortcuts installed ins Shortcuts folder will be added to all keymaps, if there is no conflict. It means that if the same shortcut is mapped to different actions in Shortcut folder and current keymap folder (like Keymap/NetBeans), the Shortcuts folder mapping will be ignored.

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:

The core module use NbPreferences for storring properties describe current settings of Network Proxy. org.netbeans.core -

key	description	read	write
proxyHttpHost	Host name of HTTP Proxy	Y	Y
proxyHttpPort	Port of HTTP Proxy	Y	Y
proxyHttpsHost	Host name of HTTPS Proxy	Y	Y
proxyHttpsPort	Port of HTTPS Proxy	Y	Y
proxySocksHost	Host name of Socks server	Y	Y
proxySocksPort	Port of Socks server	Y	Y
proxyNonProxyHosts	Ignore host list	Y	Y
proxyType	Type of Proxy Setting (DIRECT_CONNECTION, AUTO_DETECT_PROXY, MANUAL_SET_PROXY	Y	Y
useProxyAuthentication	Proxy Server requires user authentication	Y	Y
proxyAuthenticationUsername	Username for authentication on Proxy Server	Y	Y
proxyAuthenticationUsername	Password for authentication on Proxy Server	Y	Y

Does it share preferences with other modules ? Yes, the Welcome Screen module listens for changes Proxy Settings and reload content when Proxy changes.

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:

The core module registers an implementation of org.netbeans.core.StatusLineElementProvider interface, it allows to display in the status line a notification about thrown exception. It's registered by META-INF/services.

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:

ErrorNotification -

Enabling assertions (either global -ea or for class org.netbeans.core.NotifyException only) changes the default error notification behavior. When assertions are enabled an error window pops up each time an error is encountered. Otherwise a small icon start flashing in the main status bar and clicking the icon then brings up the error dialog.

• The status bar notification shows a small icon starts flashing at the rightmost part of the main status bar when an exception occurs
• The icon is flashing for 5 seconds, then it stays visible for another 30 seconds. Positioning the mouse pointer over the icon changes the default mouse cursor to 'hand' and stops the flashing. Icon's tooltip provides the exception message or the exception class name when no message is available. Single-clicking the icon brings up the exception dialog and the icon disappers. The exception dialog shows all exceptions encountered since the icon started flashing. When the exception dialog is closed via the Ok button, the exception list is cleared.
• The exception dialog window 'remembers' (per IDE session) the status of the 'Show Details' flag. So when the dialog is displayed again, the last user's settings are reused.
• When another exception is encountered while the icon is already flashing or visible, the flashing timer and the hide icon timer will restart.
• When another exception is encountered while the exception dialog is visible, the exception message is displayed in the current dialog and the icon does not appear.
• There's no tooltip nor any indication on status bar when the icon is not visible. Only a part of status bar area is reserved for the icon.
• It is possible to switch the status bar notification off, e.g. for beta releases, by enabling assertions in JVM (-ea). Then each exception shows the exception dialog.
netbeans.hack.50423 - Set this property to true to workaround the bug #50423 which appears on some linuxes on JDK 1.5. netbeans.close.no.exit - Set this property to true if you do want to cleanup the module system, but not call System.exit at the end. Used from NbModuleSuite from nbjunit library.
java.net.useSystemProxies - Get this property to determine when use JDK's java.net.ProxySelector or core's implementation of ProxySelector. org.netbeans.core.TimableEventQueue.install - By default NetBeans based applications install their own EventQueue. One can suppress that since version 3.27 of org.netbeans.core module by branding key TimableEventQueue.install in org/netbeans/core/Bundle to false.
Question (exec-component): Is execution of your code influenced by any (string) property of any of your components?
Answer:

Yes. org.netbeans.core.actions.OptionsAction.additionalActionName - Creates button with given string in bottom left corner of Options Dialog. org.netbeans.core.actions.OptionsAction.additionalActionListener - Given ActionListener is notified when custom button is pressed. org.netbeans.core.actions.OptionsAction.optionsDialogTitle - Allows to redefine default title of Options Dialog. USE_Authentication - One can use branding to disable installation of NetBeans own java.net.Authenticator. Just brand org.netbeans.core.Bundle to say USE_Authentication=false StaticNonProxyHosts - Some applications may want to proxy connections to localhost (which by default uses direct connection in NetBeans Platform). One can change the default by branding org.netbeans.core.Bundle specify something else than StaticNonProxyHosts=localhost|127.0.0.1.

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:

uihandler-hooks - This module exports an API that allows the UI Gestures Collector module to plug and enhance the behaviour of exception dialog by own buttons. The behaviour is like this: If any of Handlers of Logger.getLogger("") implements Callable<JButton> then such button is going to be inserted to the exception dialog and can react and change the behaviour of that dialog. Such a button is going to be a "closing" one - e.g. the dialog will close as soon as the button is pressed.

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

NbKeymap.context - The context field is accessed from editor module by reflection from MultiKeymap. SelfProfileAction - The module expects profiler to provide SelfProfileAction and interacts with it as described in profiler/test/unit/src/org/netbeans/modules/profiler/actions/SelfSamplerActionTest.java test.

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:

org.netbeans.core.TimeableEventQueue - This module contains a hook to identify long running tasks inside the AWT dispatch thread. It observers the AWT event queue and if a task takes longer than expected, it invokes a sampler that creates a profiling snapshot of the IDE until the task returns back to the event queue. Time limits can be configured via system properties (in milliseconds):

• org.netbeans.core.TimeableEventQueue.quantum=xyz - for how long the event queue must be blocked to start the self-sampler (by default 100ms),
• org.netbeans.core.TimeableEventQueue.report=xyz - total time of blocked event queue to report a problem (by default 3s),
• org.netbeans.core.TimeableEventQueue.waitcursor=xyz - time for which a problem is not reported if mouse wait cursor is in place (by default 15s),
• org.netbeans.core.TimeableEventQueue.pause=xyz - time after reporting a problem for which the detection is disabled (by default 15s).
In production builds the default time limits are different (10s to start sampler, 20s to report a problem).
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