This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Skip to end of metadata
Go to start of metadata

You can use the OSGI Bundles portlet to install and manage bundles. On the administration console, select the OSGI Bundles portlet in the Resources folder from the left navigation panel to access the portlet.

This document is organized into the following sections:

Installing an OSGi Bundle

You can install an OSGi Bundle by using the OSGI Bundles portlet on the administration console with the following steps:

  1. Click Browse to specify the location of the bundle you want to install.
  2. (Optional) Input a non-negative integer into the Start Level field to set a start level for your bundle. By default, the start level of a bundle is set to 60.
  3. (Optional) Select the Start check box if you want to start the bundle after installation.
  4. Click Install.

Each OSGi Bundle is associated with a start level that enable the server to control the relative starting and stopping order of bundles. Only bundles that have a start level less or equal to the active start level of the server framework must be active. Usually, a bundle with a smaller start level tend to be started earlier.

Managing the Status of OSGi Bundles

The OSGI Bundles portlet displays the installed OSGi Bundles by different groups and their status in the table under the installation area. You can start, stop and uninstall the bundles listed in this table.

The table includes the following sections:

  1. Id: This column displays the bundle Id which is unique for each bundle. The bundles in the table are sorted according to the ascending order of their Ids. This listing order complies with the starting order of the bundles. The bundles with smaller start levels tend to have smaller Id numbers.
  2. Symbolic Name: This column displays the Symbolic Name of each bundle. This attribute is set by the Bundle-SymbolicName header in the MANIFEST.MF file in the bundle.
  3. Version: This column displays the version of each bundle, which is set by the Bundle-Version header in the MANIFEST.MF file in the bundle.
  4. State: This column displays the state of each bundle.
    • Bundles that are started are shown as Active. You can stop the bundle by using the Stop button.
    • Bundles that are stopped are shown as Resolved. You can start the bundle by using the Start button.
  5. Utilities: This column displays the actions you can perform to view different information of each bundle.

Viewing Different Groups of Bundles

By default, all installed bundled are listed when you open the OSGi portlet. However, you can choose to show only specific group of bundles:

  • Select WAB to list web bundles only;
  • Select Blueprint to list blueprint bundles only;
  • Select System to list system bundles only, the start level of system bundle must be less than 50;
  • Select Configuration to list all configuration bundles used by Geronimo system modules;

You can also filter bundles according to the bundle symbolic name by using Search by symbolic-name function on the portlet.

Viewing the Package of OSGi Bundles

You can use Find Packages to view the information of a specific package and its wired bundles. The input box supports wildcards.

Click the package to review the bundle which exports the package and which imports the package.

Viewing the Information of OSGi Bundles

The following are actions listed within Utilities column, and which you can perform to view the information of each bundle:

  • Click View Manifest to see the content of the MANIFEST.MF file of the bundle. This file contains headers that specify information that the server Framework needs to install correctly and activate a bundle. Such information includes: Import-Package, Export-Packages, Bundle-SymbolicName, Bundle-Version, and so on.
  • Click View wired bundles to see which bundles those imported packages are from and which bundles are using exported packages from the current one.
  • Click View services to see the services that the bundle is using and that the bundle has registered with the Framework.

For more information about the OSGi Bundles, see the OSGi Specifications.

  • No labels