Neil’s point-free blog

BundleMonitor is a plug-in for Eclipse that allows you to view and manipulate OSGi bundles, services and configurations in the running Eclipse instance. It works in Eclipse RCP applications as well as IDE or SDK-based applications. It provides three views: Bundles, Services and Configuration.

Download

You can install BundleMonitor using Eclipse’s built-in update mechanism:

1. Open Help > Software Updates… from the main menu.
2. Select the Available Software tab.
3. Click Add Site… and copy the following URL:

http://neilbartlett.name/downloads/bundlemonitor/site.xml

4. Expand the new entry and tick the Bundle Monitor Feature.
5. Click Install… and follow the rest of the installation wizard.

Opening the Views

The views offered by the plug-in can be opened by opening the Window menu and selecting Show View > Other…. The view selection dialog will open. Navigate to OSGi Runtime and select the view(s) you wish to use.

Bundles View

The Bundles view shows all of the installed bundles in the running OSGi framework along with their states and locations. You can filter the displayed bundles based on their state by dropping down the view menu (small down-arrow on the toolbar), or you can filter based on the symbolic name by toggling the Filter button () on the view toolbar and typing part of the name.

Via the toolbar you can also install new bundles from a file or from an arbitrary URL, and attempt to resolve all unresolved bundles. By right-clicking on a bundle from the list you can view its properties, resolve it, start/stop it, uninstall it or diagnose resolution problems.

Services View

The Services view shows all of the registered services. The first column shows the service interface name and the right column shows the symbolic name of the bundle that registered the service. Each entry expandable to show the service properties.

Like the Bundles view, you can filter the displayed services based on all or part of the interface name by toggling the Filter button on the view toolbar.

Configuration View

The Configuration view allows you to view, create and edit configuration entries as defined by the Configuration Admin (CM) specification (OSGi Services Compendium, Section 104). Note that this view requires an implementation of the CM bundle to be installed and running. You can obtain a CM implementation from the Equinox download page by downloading either the individual bundle org.eclipse.equinox.cm or the complete Equinox or Equinox SDK zip (version 3.4 or higher). Once the CM bundle is installed, use the Bundles view to ensure it is active.

The main view shows a list of configuration entries, with the PID in the left column and the bound bundle location in the right column. Each entry is expandable to show the properties of the configuration, i.e., the dictionary content. The displayed configurations can be filtered based on all or part of the PID by toggling the Filter button on the view toolbar.

Via the toolbar you can also delete or create configuration entries. When a configuration entry is created you will be asked for a PID — note that entering a PID that already exists will result in editing the existing configuration for that PID, which is the usual behaviour in Configuration Admin. In the PID entry dialog you can specify that you are creating a factory configuration, in which case the PID entered will be interpreted as the Factory PID — the specific PID of the new entry will be generated by the CM implementation.

After creating a configuration it will be opened in a text editor for editing. You can also edit an existing configuration entry by double-clicking it in the main Configuration view. When the text editor is saved, the contents will be immediately parsed as a Java Properties file, and the result passed to CM. The editor does not use a temporary file, you are directly editing the configuration object held by CM.

Source Code

BundleMonitor is licensed under the Eclipse Public Licence (EPL). The source code is available from the Git repository at git://github.com/njbartlett/bundlemonitor.git. For help using Git, see GitHub’s guide page.

UPDATE: If you can’t or don’t want to use Git to pull the source code, you can download a snapshot as a ZIP or tarball from the GitHub project page. Go to http://github.com/njbartlett/bundlemonitor and click the Download button near the top of the page.

Bugs and Enhancements

Report bugs or request enhancements using the bug tracker. Please be sure to select the “BundleMonitor” project when reporting an issue.