|
|
|
FileSystemProvider.
MasterFileSystem doesn't provide pure client API but has tiny API that
is intended just for SPI providers (slightly disputable if it should be called API or SPI).
All SPI are plugable, registred by Lookup.
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:
MasterFileSystem is just implementation of FileSystem. There are no special use
cases. FileObjects erlier returned from URLMapper or
FileUtil.fromFile provided by LocalFileSystem or
CvsFileSystem will be now provided by MasterFileSystem.
There will be guaranteed that there won't be more instances of FileObject
addressing one java.ioFile.
Question (arch-time):
What are the time estimates of the work?
Answer:
MasterFileSysetm is already implemented, tested and used in current dev builds.
There are a few requests for enhancements including API changes that should be incorporated.
Expected milestone is promo-D.
Currently there doesn't exist any SPI provider that supports automounting
(AutoMountProvider), this feature isn't tested yet and isn't planned to
be used in promo-D.
Question (arch-quality):
How will the quality
of your code be tested and
how are future regressions going to be prevented?
Answer:
Junit tests as much as possible and as soon as possible.
Question (arch-where):
Where one can find sources for your module?
WARNING: Question with id="arch-where" has not been answered!
The default answer to this question is:
These modules are required in project.xml:
The entire API and SPI are in its own public packages.
The implementation is in another package and is not considered public.
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 currently. Most "clients" are really callers ofFileUtil.toFileObject and so on, and thus
implicitly depend on the existence of this module. In the
future a provide-require token might make sense.
java.io.File directly?
Answer:
Yes, this module provides implementation of FileSystem addresing resources accessible by java.io.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:
Yes, MasterFileSystem is automaticaly mounted into Repository via its registration
in /Mount folder in mf-layer.
Question (resources-read):
Does your module read any resources from layers? For what purpose?
Answer:
No hidden intermodule dependency.
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!
org.openide.util.Lookup
or any similar technology to find any components to communicate with? Which ones?
Answer:
All registered FileSystemProvider and AutoMountProvider
instances are queried and used.
Question (lookup-register):
Do you register anything into lookup for other code to find?
Answer:
URLMapper implementation is registered using META-INF/services. URLMapper
is supposed to find it (may sound strange but in filesystems isn't separated API, SPI
and implementation).
Question (lookup-remove):
Do you remove entries of other modules from lookup?
Answer:
No.
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:
org.netbeans.modules.masterfs.case
-
To address problems when mixing various types of network file systems
(as described in bug 198946)
there is a special property org.netbeans.modules.masterfs.case
that can be set to sensitive or insensitive value
in order to override the system default. This is intended only for end user
consumption, not for consumption by other parts of the system. The name and
meaning of this property may change in any release.
org.netbeans.io.suspend
-
Native listeners check the org.netbeans.io.suspend property.
If it is set to integer greater than zero, they stop delivering file change events.
The list of modified directories is recorded (its size is made available
by setting its string value into org.netbeans.io.pending property),
but its processing is suspended. Events are delivered when
org.netbeans.io.suspend property changes its value to 0
or becomes empty.
I/O intensive operations in other NetBeans modules are advised
to honour the org.netbeans.io.suspend property as well and
suspend their I/O activities too.
In order to properly communicate changes to the property between multiple
receivers and multiple controllers it is suggested to
only manipulate the value under synchronized("org.netbeans.io.suspend".intern())
lock. Those changing the value are supposed to increment it by one when they
request the suspend and decrement it by one when they want to resume their
own suspend.
Whenever a change to the state of the property is made,
controllers are supposed to
"org.netbeans.io.suspend".intern().notifyAll().
Runnable with intricate behavior. This is a private contract
used from core.ui module to show refresh progress and tested
in masterfs/test/unit/src/org/netbeans/modules/masterfs/SlowRefreshTest.java.
org.netbeans.modules.masterfs.watcher.disable
-
It is possible to disable native listening on filesystem changes.
Useful mostly in testing environment, but it may be interesting for some
users too. Don't rely (much) on this property from production code however.
org.netbeans.modules.masterfs.watcher.FAM
-
It is possible to enable use of FAM notifier on Solaris disabled by default.
Useful mostly in testing environment, but it may be interesting for some
users too. Don't rely (much) on this property from production code however.
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?
Answer:
No.
Question (exec-privateaccess):
Are you aware of any other parts of the system calling some of
your methods by reflection?
Answer:
FileObjectMoveLookup
-
BaseFileObj implementation of FileObject is using
a reflection to re-associate the lookup after a move operation. This is a
contract established with openide.filesystems module.
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:
Naturally this module uses instanceof but I don't think its usage isn't suspicious or
worth of mentioning.
Question (exec-threading):
What threading models, if any, does your module adhere to? How the
project behaves with respect to threading?
Answer:
Supposed to be thread-safe - complex fine-grained locking. Relies on Filesystems thread semantics.
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!
java.awt.datatransfer.Transferable?
Answer:
No.
AutomountSupportcode>.
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 higher number of registered instances of AutoMountProvider and
the higher number of mounted filesystems then more negatively affected
performance.
Question (perf-limit):
Are there any hard-coded or practical limits in the number or size of
elements your code can handle?
Answer:
No hard-coded limits. Practical limit of registered instances of AutoMountProvider
depends on performance meassurement.
Question (perf-mem):
How much memory does your component consume? Estimate
with a relation to the number of windows, etc.
Answer:
Memory occupation varies widely - the more FileObjects are requested the higher memory
consumption.
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 polling.
Question (perf-progress):
Does your module execute any long-running tasks?
Answer:
Mounting new FileSystem could be considered long-running task under some circumstances.
Cache with living FileObjects must be traversed and delegates are changed if necessary.
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:
No enforcement.