Overview (NetBeans OSGi Integration)

NetBeans OSGi Integration
Package	Description
org.netbeans.core.netigso.spi	Special hooks for OSGi framework providers.

Netigso the heart of NetBeans integration with OSGi with NetBeans module system is contained in this module. This module locates the OSGi framework implmentation and is then responsible for finding, registering and starting OSGi bundles provided by the NetBeans module system.

What is New (see all changes)?

Sep 20 '12 Use -J-D to influence configuration of Felix
One can influence behavior of Felix OSGi container by specifying system properties.
Feb 17 '12 Updated to OSGi 4.3
OSGi specification bundle with NetBeans has been upgraded to version 4.3. Both containers were upgraded too. Felix to version 4.0.2 and Equinox to 3.7.1.
Jan 10 '12 Is archive active?
One can check whether the access to resource archive is safe or not by calling isActive() method.
Sep 14 '11 Friend API is no longer accessible
Only NetBeans modules with public API can be accessed from OSGi bundles. One can specify direct value for Netigso-Export-Package to export also non-public APIs.
Mar 29 '10 Netigso grants access to archives
OSGi frameworks can get access on Netigso's resource cache and store classes in there, rather in their own private caches.

Use Cases

Share NetBeans Resource Cache

The only supported usecase right now is to allow any framework to obtain access to internal cache and load classes from it. See NetigsoArchive.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
Netigso	Exported	Under Development	the heart of NetBeans integration with OSGi with NetBeans module system is contained in this module. This module locates the OSGi framework implmentation and is then responsible for finding, registering and starting OSGi bundles provided by the NetBeans module system.

Group of property interfaces

Interface Name	In/Out	Stability	Specified in What Document?
netigso.archive	Exported	Under Development	Inside of your `FrameworkFactory` you can use `map.get("netigso.archive")` to get instance of NetigsoArchive.
Netigso-Export-Package	Exported	Stable	If a NetBeans module's manifest contains tag `Netigso-Export-Package`, then it is used as a value of `Export-Package` OSGi tag, when re-exporting the module as OSGi bundle.

Group of java.io.File interfaces

Interface Name In/Out Stability Specified in What Document?

netigso-bundles

Exported

Friend

List of registered OSGi bundles as well as mapping of their packages to individual bundles is stored in var/cache/netigso-bundles. This file works in orchestration with content of var/cache/netigso directory where the OSGi framework usually stores its own information about bundles.

The content of the cache file is private, but the location is well known (including its relation with netigso directory), so the installer can store necessary data and speed first start of the application up.

Group of branding interfaces

Interface Name	In/Out	Stability	Specified in What Document?
org.netbeans.core.netigso.FRAMEWORK_START_LEVEL	Exported	Under Development	One can influence the initial OSGi framework start level by rebranding the `FRAMEWORK_START_LEVEL` key in `org/netbeans/core/netigso/Bundle.properties`. By default the key is empty, which means no change to default OSGi start level of `1`.
org.netbeans.core.netigso.MODULE_START_LEVEL	Exported	Under Development	The meaning of enabled module (a NetBeans terminology) and started bundle (an OSGi terminology) is not the same. Although in general we recommend to start all bundles that are marked as enabled, you may want to configure this. To do so, you can use various start levels and re-brand `MODULE_START_LEVEL` key in `org/netbeans/core/netigso/Bundle.properties` to specify the start level of modules that are supposed to be started. Only modules with lower or equal start level than value of this key will be started.
org.netbeans.core.netigso.DEFAULT_BUNDLE_START_LEVEL	Exported	Under Development	Bundles that don't provide own start level (via config/Modules/*.xml files), get no start level by default in the NetBeans Platform, however that can be changed by branding the `DEFAULT_BUNDLE_START_LEVEL` key in `org/netbeans/core/netigso/Bundle.properties`. NetBeans IDE brands it to 4.
org.netbeans.core.netigso.FIND_COVERED_PKGS	Exported	Under Development	The FIND_COVERED_PKGS branding key defines method to find list of covered packages for an OSGi bundle. Currently it can be empty or `findEntries`, which means Netigso will use `bundle.findEntries("", null, true)`. As that method resolves the bundle, it may not always be appropriate. In such case brand this token to empty string and only "Export-Package" values will be used.

Group of systemproperty interfaces

Interface Name	In/Out	Stability	Specified in What Document?
felix_org.osgi.framework	Exported	Under Development	`System.getProperties()` that start with prefix `felix.` or `org.osgi.framework.` are read on initialization of the Netigso system and injected into configuration of OSGi container before it starts.

Implementation Details

Where are the sources for the module?

The sources for the module are in the NetBeans Mercurial repositories.

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

XXX no answer for deploy-dependencies

Read more about the implementation in the answers to architecture questions.

NetBeans OSGi IntegrationUnder Development