blob: 0a6c9cb90b99433ae39c30d5493cc87f1f299da9 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!DOCTYPE api-answers PUBLIC "-//NetBeans//DTD Arch Answers//EN" "../nbbuild/antsrc/org/netbeans/nbbuild/Arch.dtd" [
<!ENTITY api-questions SYSTEM "../nbbuild/antsrc/org/netbeans/nbbuild/Arch-api-questions.xml">
]>
<api-answers
question-version="1.14"
author="rkubacki@netbeans.org"
>
&api-questions;
<!--
<question id="arch-what">
What is this project good for?
<hint>
Please provide here few lines describing the the project,
what problem it should solve, provide links to documentation,
specifications, etc.
</hint>
</question>
-->
<answer id="arch-what">
The External Browser module enables the integration of external web browsers with the IDE
for viewing Javadoc documentation and testing applets and web (JSP and servlet) applications.
It provides an alternative to using the built-in HTML Browser.
</answer>
<!--
<question id="compat-i18n">
Is your module correctly internationalized?
<hint>
Correct internationalization means that it obeys instuctions
at <a href="http://www.netbeans.org/devhome/docs/i18n/index.html">
NetBeans I18N pages</a>.
</hint>
</question>
-->
<answer id="compat-i18n">
Yes
</answer>
<!--
<question id="compat-standards">
Does the module implement or define any standards? Is the
implementation exact or does it deviate somehow?
</question>
-->
<answer id="compat-standards">
No.
</answer>
<!--
<question id="compat-version">
Can your module coexist with earlier and future
versions? 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?
<hint>
Very helpful for reading settings is to store version number
there, so future versions can decide whether how to read/convert
the settings and older versions can ignore the new ones.
</hint>
</question>
-->
<answer id="compat-version">
Yes
</answer>
<!--
<question id="dep-jre">
Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?
<hint>
It is expected that if your module runs on 1.x that it will run
on 1.x+1 if no, state that please. Also describe here cases where
you run different code on different versions of JRE and why.
</hint>
</question>
-->
<answer id="dep-jre">
1.3
</answer>
<!--
<question id="dep-jrejdk">
Do you require the JDK or is the JRE enough?
</question>
-->
<answer id="dep-jrejdk">
JRE
</answer>
<!--
<question id="dep-nb">
What other NetBeans projects does this one depend on?
<hint>
If you want, describe such projects as imported API using
the <code>&lt;api name="identification" type="import or export" category="stable" url="where is the description" /&gt;</code>
</hint>
</question>
-->
<answer id="dep-nb">
<p>
XXX no answer for dep-nb
</p>
</answer>
<!--
<question id="dep-non-nb">
What other projects outside NetBeans does this one depend on?
<hint>
Some non-NetBeans projects are packaged as NetBeans modules
(see <a href="http://libs.netbeans.org">libraries</a>) and
it is prefered to use this approach when more modules may
depend on such third-party library.
</hint>
</question>
-->
<answer id="dep-non-nb">
The implementation relies on a possibility to control web browsers
specified at <a href="http://wp.netscape.com/newsref/std/x-remote.html">
Remote Control of Unix Netscape</a> or
<a href="http://www.mozilla.org/unix/remote.html">remote control of unix mozilla</a> documents
and <a href="http://developer.netscape.com/docs/manuals/communicator/DDE/index.htm">
Netscape's DDE Implementation</a>.
</answer>
<!--
<question id="dep-platform">
On which platforms does your module run? Does it run in the same
way on each?
<hint>
If your module is using JNI or deals with special differences of
OSes like filesystems, etc. please describe here what they are.
</hint>
</question>
-->
<answer id="dep-platform">
Though it has basic support for all platform it is platform dependent.
<p>
JNI access to native code is used on Windows OSes to cooperate with browsers
and read settings from system registry.
Executing commands that directly communicates with browser or check the environment
approach is used on Unix and Linux.
This can also used in a simpler version for all platforms including those that are not
officially supported.
</p>
</answer>
<!--
<question id="deploy-jar">
Do you deploy just module JAR file(s) or other files as well?
<hint>
If your module consist just from one module JAR file, just confirm that.
If it uses more than one JAR, describe where there are located, how
they refer to each other.
If it consist of module JAR(s) and other files, please describe
what is their purpose, why other files are necessary. Please
make sure that installation/deinstallation leaves the system
in state as it was before installation.
</hint>
</question>
-->
<answer id="deploy-jar">
<ul>
<li>extbrowser.jar - module JAR</li>
<li>extbrowser.dll - dynamically loaded library that performs Windows specific tasks.</li>
</ul>
</answer>
<!--
<question id="deploy-nbm">
Can you deploy an NBM via the Update Center?
<hint>
If not why?
</hint>
</question>
-->
<answer id="deploy-nbm">
Yes
</answer>
<!--
<question id="deploy-packages">
Are packages of your module made inaccessible by not declaring them
public?
<hint>
NetBeans module system allows restriction of access rights to
public classes of your module from other modules. This prevents
unwanted dependencies of others on your code and should be used
whenever possible (<a href="http://www.netbeans.org/download/apis/org/openide/doc-files/upgrade.html#3.4-public-packages">
public packages
</a>).
</hint>
</question>
-->
<answer id="deploy-packages">
The module has no official public API. However it does NOT delare this explicitly
in the manifest using: "OpenIDE-Module-Public-Packages: -"
</answer>
<!--
<question id="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?
<hint>
Installation location shall not matter, if it does explain why.
Consider also whether <code>InstalledFileLocator</code> can help.
</hint>
</question>
-->
<answer id="deploy-shared">
Module can be installed in shared location or in user directory.
</answer>
<!--
<question id="exec-classloader">
Does your code create its own class loader(s)?
<hint>
A bit unusual. Please explain why and what for.
</hint>
</question>
-->
<answer id="exec-classloader">
No
</answer>
<!--
<question id="exec-component">
Is execution of your code influenced by any (string) property
of any of your components?
<hint>
Often <code>JComponent.getClientProperty</code>, <code>Action.getValue</code>
or <code>PropertyDescriptor.getValue</code>, etc. are used to influence
a behaviour of some code. This of course forms an interface that should
be documented. Also if one depends on some interface that an object
implements (<code>component instanceof Runnable</code>) that forms an
API as well.
</hint>
</question>
-->
<answer id="exec-component">
<p>
Yes.
<api name='org.netbeans.modules.extbrowser.UseDesktopBrowse'
category='private'
type='import'
group='property'>
Controls use of java.awt.Desktop.browse() as a default browser integration if available.
</api>
</p>
No
</answer>
<!--
<question id="exec-privateaccess">
Are you aware of any other parts of the system calling some of
your methods by reflection?
<hint>
If so, describe the "contract" as an API. Likely private or friend one, but
still API and consider rewrite of it.
</hint>
</question>
-->
<answer id="exec-privateaccess">
No
</answer>
<!--
<question id="exec-property">
Is execution of your code influenced by any environment or
Java system (<code>System.getProperty</code>) property?
<hint>
If there is a property that can change the behaviour of your
code, somebody will likely use it. You should describe what it does
and the stability category of this API. You may use
<pre>
&lt;property name="id" category="private" &gt;
description of the property, where it is used, what it influence, etc.
&lt;/property&gt;
</pre>
</hint>
</question>
-->
<answer id="exec-property">
Yes.
<code>os.name</code> is used to determine what support can be provided.
</answer>
<!--
<question id="exec-reflection">
Does your code use Java Reflection to execute other code?
<hint>
This usually indicates a missing or unsufficient API in the other
part of the system. If the other side is not aware of your dependency
this contract can be easily broken.
</hint>
</question>
-->
<answer id="exec-reflection">
No.
</answer>
<!--
<question id="format-clipboard">
Which data flavors (if any) does your code read from or insert to
the clipboard?
</question>
-->
<answer id="format-clipboard">
None
</answer>
<!--
<question id="format-dnd">
Which protocols (if any) does your code understand during Drag &amp; Drop?
</question>
-->
<answer id="format-dnd">
None
</answer>
<!--
<question id="format-types">
Which file formats (if any) does your code read or write on disk?
</question>
-->
<answer id="format-types">
Customized browser settings in form of XML settings format
</answer>
<!--
<question id="lookup-lookup">
Does your module use <code>org.openide.util.Lookup</code>
to find any components to communicate with? Which ones?
<hint>
Please describe the interfaces you are searching for, where
are defined, whether you are searching for just one or more of them,
if the order is important, etc. Also clasify the stability of such
API contract.
</hint>
</question>
-->
<answer id="lookup-lookup">
URLMapper's are searched in order to convert URLs that cannot be accessed
from outside of process into URLs that are more general
</answer>
<!--
<question id="lookup-register">
Do you register anything into lookup for other code to find?
<hint>
Do you register using layer file or using <code>META-INF/services</code>?
Who is supposed to find your component?
</hint>
</question>
-->
<answer id="lookup-register">
Browsers are registered using layer file so they can be accessed from OpenIDE.
</answer>
<!--
<question id="lookup-remove">
Do you remove entries of other modules from lookup?
<hint>
Why? Of course, that is possible, but it can be dangerous. Is the module
your are masking resource from aware of what you are doing?
</hint>
</question>
-->
<answer id="lookup-remove">
No
</answer>
<!--
<question id="perf-exit">
Does your module run any code on exit?
</question>
-->
<answer id="perf-exit">
No.
</answer>
<!--
<question id="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?
</question>
-->
<answer id="perf-huge_dialogs">
No.
</answer>
<!--
<question id="perf-limit">
Are there any hardcoded or practical limits in the number or size of
elements your code can handle?
</question>
-->
<answer id="perf-limit">
No except the fact that there are hardcoded timeouts for receiving responses
from controled browser that are adjusted to work in most of cases but may cause
problems on slower machine with heavy load.
</answer>
<!--
<question id="perf-mem">
How much memory does your component consume? Estimate
with a relation to the number of windows, etc.
</question>
-->
<answer id="perf-mem">
Module memory usage is low but it cooperates with an external web browser
that can consume a lot of resources.
</answer>
<!--
<question id="perf-menus">
Does your module use dynamically updated context menus, or
context-sensitive actions with complicated enablement logic?
</question>
-->
<answer id="perf-menus">
No.
</answer>
<!--
<question id="perf-progress">
Does your module execute any long-running tasks?
<hint>Typically they are tasks like connecting over
network, computing huge amount of data, compilation.
Such communication should be done asynchronously (for example
using <code>RequestProcessor</code>), definitively it should
not block AWT thread.
</hint>
</question>
-->
<answer id="perf-progress">
Yes.
Communication with browser and running OS specific commands
can take some time (usually couple of seconds).
This doesn't block AWT processing.
</answer>
<!--
<question id="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?
Please include some estimates.
</question>
-->
<answer id="perf-scale">
The machine load has the biggest impact on module performance.
</answer>
<!--
<question id="perf-startup">
Does your module run any code on startup?
</question>
-->
<answer id="perf-startup">
No.
</answer>
<!--
<question id="perf-wakeup">
Does any piece of your code wake up periodically and do something
even when the system is otherwise idle (no user interaction)?
</question>
-->
<answer id="perf-wakeup">
No.
</answer>
<!--
<question id="resources-file">
Does your module use <code>java.io.File</code> directly?
<hint>
NetBeans provide a logical wrapper over plain files called
<code>org.openide.filesystems.FileObject</code> that
provides uniform access to such resources and is the prefered
way that should be used. But of course there can be situations when
this is not suitable.
</hint>
</question>
-->
<answer id="resources-file">
No.
</answer>
<!--
<question id="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?
<hint>
NetBeans allows automatic and declarative installation of resources
by module layers. Module register files into appropriate places
and other components use that information to perform their task
(build menu, toolbar, window layout, list of templates, set of
options, etc.).
</hint>
</question>
-->
<answer id="resources-layer">
Yes. It defines browser instances here that are accessible by lookup.
</answer>
<!--
<question id="resources-mask">
Does your module mask/hide/override any resources provided by other modules in
their layers?
<hint>
If you mask a file provided by another module, you probably depend
on that and do not want the other module to (for example) change
the file's name. That module shall thus make that file available as an API
of some stability category.
</hint>
</question>
-->
<answer id="resources-mask">
No.
</answer>
<!--
<question id="resources-read">
Does your module read any resources from layers? For what purpose?
<hint>
As this is some kind of intermodule dependency, it is a kind of API.
Please describe it and clasify according to
<a href="http://openide.netbeans.org/tutorial/api-design.html#categories">
common stability categories</a>.
</hint>
</question>
-->
<answer id="resources-read">
Yes. To restore browser definitions that is persistent.
Also it access system registry on Windows to read system setting for application
assocciated with html files and path for browsers.
</answer>
<!--
<question id="exec-introspection">
Does your module use any kind of runtime type information (<code>instanceof</code>,
work with <code>java.lang.Class</code>, etc.)?
</question>
-->
<answer id="exec-introspection">
No.
</answer>
<!--
<question id="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?
<hint>
If you feed an input, parse the output please declare that as an API.
</hint>
</question>
-->
<answer id="exec-process">
Yes. Since the whole external browser support is OS dependent there are different
ways how to get expected results.
Command is executed for each request to display URL in most of cases.
The only exception is Windows platform where native support send requests through
native DLL library that invokes DDE call.
If this communication fails the command is executed to start browser.
</answer>
<!--
<question id="arch-overall" when="init">
Describe the overall architecture.
<hint>
What will be API for
<a href="http://openide.netbeans.org/tutorial/api-design.html#design.apiandspi" shape="rect">
clients and what support API</a>?
What parts will be pluggable?
How will plug-ins be registered? Please use <code>&lt;api type="export"/&gt;</code>
to describe your general APIs and specify their
<a href="http://openide.netbeans.org/tutorial/api-design.html#category-private" shape="rect">
stability categories</a>.
If possible please provide simple diagrams.
</hint>
</question>
-->
<answer id="arch-overall">
<p>
XXX no answer for arch-overall
</p>
</answer>
<!--
<question id="arch-quality" when="init">
How will the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html" shape="rect">quality</a>
of your code be tested and
how are future regressions going to be prevented?
<hint>
What kind of testing do
you want to use? How much functionality, in which areas,
should be covered by the tests? How you find out that your
project was successful?
</hint>
</question>
-->
<answer id="arch-quality">
<p>
XXX no answer for arch-quality
</p>
</answer>
<!--
<question id="arch-time" when="init">
What are the time estimates of the work?
<hint>
Please express your estimates of how long the design, implementation,
stabilization are likely to last. How many people will be needed to
implement this and what is the expected milestone by which the work should be
ready?
</hint>
</question>
-->
<answer id="arch-time">
<p>
XXX no answer for arch-time
</p>
</answer>
<!--
<question id="arch-usecases" when="init">
<hint>
Content of this answer will be displayed as part of page at
http://www.netbeans.org/download/dev/javadoc/usecases.html
You can use tags &lt;usecase name="name&gt; regular html description &lt;/usecase&gt;
and if you want to use an URL you can prefix if with @TOP@ to begin
at the root of your javadoc
</hint>
Describe the main <a href="http://openide.netbeans.org/tutorial/api-design.html#usecase" shape="rect">
use cases</a> 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?
</question>
-->
<answer id="arch-usecases">
<p>
XXX no answer for arch-usecases
</p>
</answer>
<!--
<question id="arch-where" when="impl">
Where one can find sources for your module?
<hint>
Please provide link to the CVS web client at
http://www.netbeans.org/download/source_browse.html
or just use tag defaultanswer generate='here'
</hint>
</question>
-->
<answer id="arch-where">
<defaultanswer generate='here' />
</answer>
<!--
<question id="compat-deprecation" when="init">
How the introduction of your project influences functionality
provided by previous version of the product?
<hint>
If you are planning to deprecate/remove/change any existing APIs,
list them here accompanied with the reason explaining why you
are doing so.
</hint>
</question>
-->
<answer id="compat-deprecation">
<p>
XXX no answer for compat-deprecation
</p>
</answer>
<!--
<question id="deploy-dependencies" when="final">
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)?
<hint>
Provide a sample of the actual lines you would add to a module manifest
to declare a dependency, for example OpenIDE-Module-Requires: some.token.
If other modules should not depend on this module, or should just use a
simple regular module dependency, you can just answer "nothing". If you
intentionally expose a semistable API to clients using implementation
dependencies, you should mention that here (but there is no need to give
an example of usage).
</hint>
</question>
-->
<answer id="deploy-dependencies">
<p>
XXX no answer for deploy-dependencies
</p>
</answer>
<!--
<question id="exec-ant-tasks" when="impl">
Do you define or register any ant tasks that other can use?
<hint>
If you provide an ant task that users can use, you need to be very
careful about its syntax and behaviour, as it most likely forms an
API for end users and as there is a lot of end users, their reaction
when such API gets broken can be pretty strong.
</hint>
</question>
-->
<answer id="exec-ant-tasks">
<p>
XXX no answer for exec-ant-tasks
</p>
</answer>
<!--
<question id="exec-threading" when="init">
What threading models, if any, does your module adhere to? How the
project behaves with respect to threading?
<hint>
Is your API threadsafe? Can it be accessed from any threads or
just from some dedicated ones? Any special relation to AWT and
its Event Dispatch thread? Also
if your module calls foreign APIs which have a specific threading model,
indicate how you comply with the requirements for multithreaded access
(synchronization, mutexes, etc.) applicable to those APIs.
If your module defines any APIs, or has complex internal structures
that might be used from multiple threads, declare how you protect
data against concurrent access, race conditions, deadlocks, etc.,
and whether such rules are enforced by runtime warnings, errors, assertions, etc.
Examples: a class might be non-thread-safe (like Java Collections); might
be fully thread-safe (internal locking); might require access through a mutex
(and may or may not automatically acquire that mutex on behalf of a client method);
might be able to run only in the event queue; etc.
Also describe when any events are fired: synchronously, asynchronously, etc.
Ideas: <a href="http://core.netbeans.org/proposals/threading/index.html#recommendations" shape="rect">Threading Recommendations</a> (in progress)
</hint>
</question>
-->
<answer id="exec-threading">
<p>
XXX no answer for exec-threading
</p>
</answer>
<!--
<question id="perf-spi" when="init">
How the performance of the plugged in code will be enforced?
<hint>
If you allow foreign code to be plugged into your own module, how
do you enforce that it will behave correctly and quickly and will not
negatively influence the performance of your own module?
</hint>
</question>
-->
<answer id="perf-spi">
<p>
XXX no answer for perf-spi
</p>
</answer>
<!--
<question id="resources-preferences" when="final">
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 ?
<hint>
You may use
&lt;api type="export" group="preferences"
name="preference node name" category="private"&gt;
description of individual keys, where it is used, what it
influences, whether the module reads/write it, etc.
&lt;/api&gt;
Due to XML ID restrictions, rather than /org/netbeans/modules/foo give the "name" as org.netbeans.modules.foo.
Note that if you use NbPreferences this name will then be the same as the code name base of the module.
</hint>
</question>
-->
<answer id="resources-preferences">
<p>
XXX no answer for resources-preferences
</p>
</answer>
<!--
<question id="security-grant" when="final">
Does your code grant additional rights to some other code?
<hint>Avoid using a class loader that adds extra
permissions to loaded code unless really necessary.
Also note that your API implementation
can also expose unneeded permissions to enemy code by
calling AccessController.doPrivileged().</hint>
</question>
-->
<answer id="security-grant">
<p>
XXX no answer for security-grant
</p>
</answer>
<!--
<question id="security-policy" when="final">
Does your functionality require modifications to the standard policy file?
<hint>Your code might pass control to third-party code not
coming from trusted domains. This could be code downloaded over the
network or code coming from libraries that are not bundled
with NetBeans. Which permissions need to be granted to which domains?</hint>
</question>
-->
<answer id="security-policy">
<p>
XXX no answer for security-policy
</p>
</answer>
</api-answers>