Overview

# NetBeans Architecture Answers for Loaders module

- Author: dstrupl@netbeans.org
- Answers as of: Dec 7, 2006
- Answers for questions version: 1.13
- Latest available version of questions: 1.26

WARNING: answering questions version 1.13 rather than the current 1.26.

## Interfaces table

##### Group of java interfaces

Interface Name | In/Out | Stability | Specified in What Document?
LoadersAPI | Exported | Official | .../openide/loaders/doc-files/api.html
FilesystemsAPI | Imported | Official | .../openide/filesystems/doc-files/api.html .../overview-summary.html The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
LookupAPI | Imported | Official | .../org/openide/util/doc-files/api.html
UtilitiesAPI | Imported | Official | .../org/openide/util/doc-files/api.html ../org-openide-util/overview-summary.html The module is needed for compilation. The module is used during runtime. Specification version 6.4 is required.
ActionsAPI | Imported | Official | .../overview-summary.html The module is needed for compilation. The module is used during runtime. Specification version 6.3 is required.
org.openide.awt | Imported | Official | ../org-openide-awt/overview-summary.html The module is needed for compilation. The module is used during runtime. Specification version 6.5 is required.
DialogsAPI | Imported | Official | .../overview-summary.html The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
ExplorerAPI | Imported | Official | .../overview-summary.html The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
ModulesAPI | Imported | Official | .../overview-summary.html The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
NodesAPI | Imported | Official | .../overview-summary.html The module is needed for compilation. The module is used during runtime. Specification version 6.5 is required.
EditorAPI | Imported | Official | ../org-openide-text/overview-summary.html The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
WindowSystemAPI | Imported | Official | .../overview-summary.html The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.

##### Group of layer interfaces

Interface Name | In/Out | Stability | Specified in What Document?
Loaders-folder-any-Actions | Exported | Stable | The actions that the default folder loader shows in its popup menu are read from a layer folder `Loaders/folder/any/Actions` so if any module wishes to extend, hide or reorder some of them it can just register its actions there.
Loaders-text-xml-Actions | Exported | Stable | The actions that the standard XML loader shows in its popup menu are read from a layer folder `Loaders/text/xml/Actions`
Loaders-content-unknown-Actions | Exported | Stable | The actions that the loader for unrecognized files shows in its popup menu are read from a layer folder `Loaders/content/unknown/Actions`
Loaders-application-x-nbsettings-Actions | Exported | Stable | The actions that the loader for instance and settings files shows in its popup menu are read from a layer folder `Loaders/application/x-nbsettings/Actions`
PrivilegedTemplates | Exported | Under Development | A folder Privileged offers to other module possibility add own templates.
RecentTemplates | Exported | Private | A folder Recent stores a set of recently used templates, it's not open to other module.

##### Group of property interfaces

Interface Name | In/Out | Stability | Specified in What Document?
NetBeansAttrAssignedLoader | Exported | Stable | Extended attribute for holding the class of the loader that should be used to recognize a file object before the normal processing takes place.
NetBeansAttrAssignedLoaderModule | Exported | Private | Extended attribute which may be used in addition to EA_ASSIGNED_LOADER which indicates the code name base of the module that installed that preferred loader. If the indicated module is not installed, ignore the loader request. See #13816.
template | Exported | Stable | If set to Boolean.TRUE the file is recognized as template and its instantiation is allowed.
isRemoteAndSlow | Exported | Private | NewObjectWizardPanel: The Attribute "isRemoteAndSlow" will be checked for on the targetFolder, and if it is found and true, then targetFolder.getPrimaryFile().getFileObject will NOT be called.
templateWizardURL | Exported | Stable | Attribute that defines a template wizard description page (type `URL` to HTML).
templateWizardIterator | Exported | Stable | Attribute that defines a custom template wizard iterator (type `TemplateWizard.Iterator`).
originalFile | Exported | Stable | Path to the target file in its filesystem (type `String`).
originalFileSystem | Exported | Stable | System name of filesystem of target file (type `String`; default is same as that of shadow).
UseOwnName | Exported | Private | if true, the DataShadow name is used instead of original's name, affects DataShadows of filesystem roots only
PartialOrders | Exported | Stable | Read the list of intended partial orders from disk. Each element is a string of the form `a/b` for `a`, `b` filenames with extension, where `a` should come before `b`. The value of the attribute must be of type `Boolean`; ignored unless `true`.
OpenIDE-Folder-SortMode | Exported | Private | Extended attribute for order of children. The values are "F", "N", "C", "0" (type `String`).
OpenIDE-Folder-Order | Exported | Private | Extended attribute for order of children - stores list of file names separated by '/' (type `String`).
EA-OpenIDE-Connection | Exported | Private | Extended attribute to store (ArrayList of Type and Node.Handle). Used by Java synchronization feature at least; generally, `ConnectionCookie`.
DataFolder.Index.reorderable | Exported | Friend | If set to `Boolean.TRUE` on a folder not in the system filesystem, make its node reorderable.
org.xml.sax.driver | Imported | Private | This is a standard way to find a class of a SAX2 driver. See SAX2 documentation
netbeans.profile.memory | Imported | Private | Boolean.TRUE means to dettach from shared impl of parser, it is static!?
org.openide.loaders.FolderList.refresh.interval | Exported | Private | The value of type integer determines the number of milliseconds between successive refreshes of contents of a folder. Can be used to tweak performance of folder refresh. Defaults to 10.
netbeans.dataobject.insecure.operation | Exported | Friend | If set to true, the `DataObject.copy, move, createFromTemplate` are executed in insecure way. That means that other threads can access the products of such operation before it finishes. This is a friend contract with projects, that need to do such strange things. Will be removed when they fix it.

## General Information

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

Answer: In summary, the LoadersAPI is responsible for scanning files in a directory on disk, weeding out irrelevant files of no interest to the IDE, and grouping the rest into logical chunks, or just determining what type of data each represents. It does this scanning by asking each registered data loader whether or not the given file(s) should be handled. The first loader to recognize a file takes ownership of it, and creates a matching data object to represent it to the rest of the IDE.

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

WARNING: Question with id="arch-overall" has not been answered!

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: A lot of usecases is described in the javadoc. Here is the list of some faqs:

#### How to add action to folder's popup menu?

Loaders-folder-any-Actions - The actions that the default folder loader shows in its popup menu are read from a layer folder `Loaders/folder/any/Actions` so if any module wishes to extend, hide or reorder some of them it can just register its actions there. As code like this does:

        <folder name="Loaders" >
            <folder name="folder" >
                <folder name="any" >
                    <folder name="Actions" >
                        <file name="org-mymodule-MyAction.instance" >
                            <attr name="instanceCreate" stringvalue="org.mymodule.MyAction" />
                        </file>
                    </folder>
                </folder>
            </folder>
        </folder>

As described in general actions registration tutorial.

This functionality is available since version 5.0 of the loaders module. Please use `OpenIDE-Module-Module-Dependencies: org.openide.loaders > 5.0` in your module dependencies.

In version 5.8 all the standard loaders were changed to read actions from layer:

- Loaders-text-xml-Actions - The actions that the standard XML loader shows in its popup menu are read from a layer folder `Loaders/text/xml/Actions`
- Loaders-content-unknown-Actions - The actions that the loader for unrecognized files shows in its popup menu are read from a layer folder `Loaders/content/unknown/Actions`
- Loaders-application-x-nbsettings-Actions - The actions that the loader for instance and settings files shows in its popup menu are read from a layer folder `Loaders/application/x-nbsettings/Actions`

#### How to allow others to enhance actions of your loader?

If you want other modules to enhance or modify actions that are visible on `DataObject`s produced by your `DataLoader` and you are either using `DataNode` or its subclass, you can just override `protected String actionsContext()` method to return non-null location of context in layers from where to read the actions.

The usual value should match `Loaders/mime/type/Actions` scheme, for example java is using `Loaders/text/x-java/Actions`, but the name can be arbitrary.

This functionality is available since version 5.0 of the loaders module. Please use `OpenIDE-Module-Module-Dependencies: org.openide.loaders > 5.0` in your module dependencies.

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

WARNING: Question with id="arch-time" has not been answered!

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

WARNING: Question with id="arch-quality" has not been answered!

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

WARNING: Question with id="arch-where" has not been answered!

## Project and platform dependencies

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

Answer: It depends on FilesystemsAPI, LookupAPI, UtilitiesAPI.

Default answer to this question is:

These modules are required in project.xml file:

- ActionsAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.3 is required.
- org.openide.awt - The module is needed for compilation. The module is used during runtime. Specification version 6.5 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.2 is required.
- FilesystemsAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
- ModulesAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
- NodesAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.5 is required.
- EditorAPI - 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 6.4 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: It does not depend on any external library.

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

Answer: It runs on any platform.

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

Answer: JRE 1.3.

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: Data Systems are integral part of openide.jar.

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

Answer: Yes. openide.jar can be deployed via AutoUpdate.

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: openide.jar needs to be in the system directory.

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

Answer: No.

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

WARNING: Question with id="deploy-dependencies" has not been answered!

## 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: No answer

## 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: Yes, module creates the folders in layer `org/netbeans/core/ui/resources/layer.xml` in `core-ui.jar`. The folders are instrumental to store information about used templates. Provided folderes:

- PrivilegedTemplates - A folder Privileged offers to other module possibility add own templates.

- RecentTemplates - A folder Recent stores a set of recently used templates, it's not open to other module.

None of them is forced to found.

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

Answer: Module reads a list of templates from folders Privileged and Recent from core/ui layer. This list is exposed in a popup menu.

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:

- DataLoaderPool.class
- ActionManager.class
- (in XMLDataObject) Node.Cookie.class
- RepositoryNodeFactory.class
- ModuleInfo.class
- ClassLoader.class

If there is no `DataLoaderPool` available in default lookup, the fallback is to use a simple loader pool that contains just the fixed system loaders, and any `DataLoader`s that can be found in default lookup.

DataFolder.FolderNode.setName() looks for one instance of org.openide.loaders.FolderRenameHandler.

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

Answer: Registration of

- DataLoaderPool.class
- Environment.Provider.class
- RepositoryNodeFactory.class

is done in core 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: org.xml.sax.driver - This is a standard way to find a class of a SAX2 driver. See SAX2 documentation netbeans.profile.memory - Boolean.TRUE means to dettach from shared impl of parser, it is static!? org.openide.loaders.FolderList.refresh.interval - The value of type integer determines the number of milliseconds between successive refreshes of contents of a folder. Can be used to tweak performance of folder refresh. Defaults to 10. netbeans.dataobject.insecure.operation - If set to true, the `DataObject.copy, move, createFromTemplate` are executed in insecure way. That means that other threads can access the products of such operation before it finishes. This is a friend contract with projects, that need to do such strange things. Will be removed when they fix it.

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

Answer: The data system stores some of its vital information in file attributes. Those attributes are accessible via calls to org.openide.filesystems.FileObject.getAttribute(name) org.openide.filesystems.FileObject.setAttribute(name, value) They can also be stored in the module layer. Please see filesystems for more information about this. NetBeansAttrAssignedLoader - Extended attribute for holding the class of the loader that should be used to recognize a file object before the normal processing takes place. NetBeansAttrAssignedLoaderModule - Extended attribute which may be used in addition to EA_ASSIGNED_LOADER which indicates the code name base of the module that installed that preferred loader. If the indicated module is not installed, ignore the loader request. See #13816. template - If set to Boolean.TRUE the file is recognized as template and its instantiation is allowed. isRemoteAndSlow -

NewObjectWizardPanel: The Attribute "isRemoteAndSlow" will be checked for on the targetFolder, and if it is found and true, then targetFolder.getPrimaryFile().getFileObject will NOT be called.

templateWizardURL - Attribute that defines a template wizard description page (type `URL` to HTML). templateWizardIterator - Attribute that defines a custom template wizard iterator (type `TemplateWizard.Iterator`). originalFile - Path to the target file in its filesystem (type `String`). originalFileSystem - System name of filesystem of target file (type `String`; default is same as that of shadow). UseOwnName - if true, the DataShadow name is used instead of original's name, affects DataShadows of filesystem roots only PartialOrders - Read the list of intended partial orders from disk. Each element is a string of the form `a/b` for `a`, `b` filenames with extension, where `a` should come before `b`. The value of the attribute must be of type `Boolean`; ignored unless `true`. OpenIDE-Folder-SortMode - Extended attribute for order of children. The values are "F", "N", "C", "0" (type `String`). OpenIDE-Folder-Order - Extended attribute for order of children - stores list of file names separated by '/' (type `String`). EA-OpenIDE-Connection - Extended attribute to store (ArrayList of Type and Node.Handle). Used by Java synchronization feature at least; generally, `ConnectionCookie`. DataFolder.Index.reorderable - If set to `Boolean.TRUE` on a folder not in the system filesystem, make its node reorderable.

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

WARNING: Question with id="exec-ant-tasks" has not been answered!

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?

WARNING: Question with id="exec-reflection" has not been answered!

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

WARNING: Question with id="exec-privateaccess" has not been answered!

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?

WARNING: Question with id="exec-process" has not been answered!

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

WARNING: Question with id="exec-introspection" has not been answered!

Question (exec-threading): What threading models, if any, does your module adhere to?

WARNING: Question with id="exec-threading" has not been answered!

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

WARNING: Question with id="security-policy" has not been answered!

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

WARNING: Question with id="security-grant" has not been answered!

## 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: Any file format.

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

Answer: We use following MIME type: application/x-java-openide-dataobjectdnd;class=org.openide.loaders.DataObject;mask={0}

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: We use following MIME type: application/x-java-openide-dataobjectdnd;class=org.openide.loaders.DataObject;mask={0}

## Performance and Scalability

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

Answer: Yes. The list of loaders is read from the disk to memory.

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: Performance of some operations is lineary proportional to number of files in a given folder times number of registered data loaders in the pool.

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: Unknown.

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: The module uses its own RequestProcessors to handle long running tasks.

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: This module contains infrastructure for creating "New" functionality wizards.

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?

WARNING: Question with id="perf-spi" has not been answered!

Built on December 7 2006. | Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.