Overview

The bundle scanner installs bundles specified by bundles url.

Syntax

scan-bundle:bundle_url[@start_level][@nostart][@update]

where:

• bundle_url : mandatory; is the url of the bundle to be installed. It can be any valid url (see also Pax Runner Handler for custom url handlers);
• start_level : optional; an integer representing the start level of the bundle. If present and OSGi Start Level Service is available then the bundle is installed with that specific start level;
  This option overwrites the startLevel configuration property;
• nostart : optional; this should be the hardcoded string "nostart" (not case sensitive); if present the bundle will not be started. Default, if the value is not present the bundle will be started depending on the service configuration.
  This option overwrites the start configuration property;
• update : optional; the hardcoded string "update" (not case sensitive)
  If present the bundles will be updated.
  This option overwrites the update configuration property;

The above options: start_level/nostart/update can be specified in any order.

Examples

• scan-bundle:file:/C:/localRepository/org/ops4j/pax/web/bundles/service/0.2.0/service-0.2.0.jar - installs the and bundle from the local hard drive with no specific start level that is installed and started;
• scan-bundle:mvn:org.ops4j.pax.web.bundles/service@5 - installs a maven artifact bundle installed with start level = 5 and started;
• scan-bundle:http://repository.ops4j.org/maven2/org/ops4j/pax/web/bundles/service/0.2.0/service-0.2.0.jar@nostart - installs a bundle from http with no specific start level that is just installed and not started

Note that, as stated by the maven handler, if you use an mvn: url, you could use in your url the repository from where the bundle could be downloaded.

Configuration

The service can be configured in two ways: via configuration admin if available and via framework/system properties where the configuration via config admin has priority.

Installation guide

This bundle is part of Pax Runner so if you are using pax runner you have nothing more to do about.
If you wanna use the bundle as a standalone bundle you could install it using the following methods:

Manual installation

• Download the latest version from http://repository.ops4j.org/maven2/org/ops4j/pax/runner/pax-runner-scanner-bundle/
  • java >=5.0: 0.16.0
  • java 1.4: 0.16.0
• Deploy the downloaded bundle to your preferred OSGi framework

Pax Runner installation

Source code

https://scm.ops4j.org/repos/ops4j/projects/pax/runner/pax-runner-scanner-bundle ( or browse via FishEye )
This project builds with Apache Maven and uses Apache Felix's maven-bundle-plugin, and Peter Krien's bnd tool.

See also

Pax URL - classpath — classpath: protocol handler. Provides access to classpath resources from your bundle or other bundles installed.

Pax URL - ivy — ivy: protocol handler. Provides access to Ivy artifacts. (not implemented yet)

Pax URL - mvn — mvn: protocol handler. Provide access to maven repository artifacts based on the well known groupId, artifactId, version and type

PAX URL - obr — obr: protocol handler. Make use of OBR bundle repository.

Pax URL - war — war:/war-i: protocol handlers. Automates war deployment.

Pax URL - wrap — wrap: protocol handler. Wraps "classic" jars as OSGi bundles.

Platform - Concierge — Starts up Concierge OSGi framework

Platform - Equinox — Starts up Equinox OSGI framework

Platform - Extender — Installs platform services based via a whiteboard pattern

Platform - Felix — Starts up Felix OSGi framework

Platform - Knopflerfish — Starts up Knopflerfish OSGi framework

Scanner - Bundle — Installs a bundle specified as url.

Scanner - Directory — Install bundles available in a file system directory or zip

Scanner - File — Install bundles listed in a plain text file

Scanner - Maven 2 POM — Installs bundles listed as dependencies in a maven 2 pom.xml file

Scanner - OBR — Resolves and installs bundles references listed in a plain text file