10. The Provisioning Repository

10.1 Overview of the Provisioning Repository

This section describes the provisioning repository feature of Virgo, the reasons for using it, and how to configure it.

[Note]Note
This section is not applicable to Virgo Nano. The provisioning mechanism used there is p2.

In most use cases, your application has a dependency on one or more separate artifacts; these artifacts might include OSGi bundles, configuration artifacts, third-party libraries, PARs or plans. A typical example is a Spring application that depends on a third-party library such as Spring Framework or Hibernate.

The way you express this dependency depends on the artifact. For example, a plan is by definition a list of dependent bundles.

Libraries are another example. Some third-party dependencies consist of multiple bundles but are logically one unit. To support this, Virgo has a concept of a library. A library is a collection of related bundles that can be referenced as a whole. You typically express the dependencies between your application and third-party libraries using the Import-Package, Import-Bundle, or Import-Library manifest header in the MANIFEST.MF file of your application. The Import-Package header is standard to OSGi; Import-Bundle and Import-Library, however, are specific to Virgo.

For additional details about the creation and usage of libraries, as well as general information about dependencies, see Programmer’s Guide.

In Virgo, you store all third-party dependencies required by your applications, such as Spring Framework and Hibernate, as artifacts in the provisioning repository. As mentioned above, you can store the following types of artifacts in the repository:

  • OSGi bundles
  • Libraries
  • PARs
  • Plans
  • Configuration Artifacts

When you deploy your application, Virgo installs the bundle(s) comprising the application to the Virgo runtime; part of this internal installation procedure is to satisfy all the application’s dependencies. If your application has a dependency that cannot be satisfied from the bundles that you have already deployed (and Virgo has thus installed), then Virgo searches the provisioning repository for an artifact that can satisfy that dependency.

The provisioning repository for a particular instance of Virgo can include artifacts in the following general locations:

  • Local: This means that artifacts have been physically installed in the provisioning repository directory structure of the local Virgo instance. The artifacts in a local repository include installed third-party libraries, bundles supplied by Virgo, bundles supplied by an end user, and internal bundles used only by Virgo. You can further categorize this location into external directories that adhere to a specified search pattern and are scanned by Virgo just on a clean startup, or watched directories that point to a single directory location and which Virgo scans on a regular basis.
  • Remote: This means that a local instance of Virgo gets the artifact from a remotely-hosted repository that is physically located on a remote Virgo Server for Apache Tomcat instance.

You configure the provisioning repository using the $SERVER_HOME/configuration/org.eclipse.virgo.repository.properties file.

As previously described, a particular instance of Virgo Server for Apache Tomcat can itself also act as a repository host for remote server instances to use when satisfying the dependencies of the applications deployed to it. In this case, you configure a hosted repository using the $SERVER_HOME/configuration/org.eclipse.virgo.apps.repository.properties file. Typically, only remote clients use hosted repositories and their contents; the Virgo Server for Apache Tomcat instance that actually hosts the repository does not typically use the artifacts in it. Rather, it uses artifacts in its local repository.

Making a third-party dependency available to your application is simply a matter of adding its artifact to the appropriate location in the provisioning repository. This could be either in the local directories or the remote ones if you are getting artifacts from a remotely-hosted repository.

Local Repository Structure

When you first install Virgo, the local provisioning repository is located at $SERVER_HOME/repository by default and consists of two main directories: ext and usr. The ext directory contains artifacts supplied with the Virgo and usr contains artifacts supplied by the user and is initially empty.

Installing Artifacts to a Repository

To install an artifact into the default repository, simply copy it into the $SERVER_HOME/repository/usr directory.

If you have configured additional watched or external repositories (additional, that is, to the default ones already configured in a freshly-installed Virgo instance), you install the artifacts in the same way: simply copy the files to the configured directories. You configure additional watched or external repositories in the same file as the default repositories: $SERVER_HOME/configuration/org.eclipse.virgo.repository.properties.

When you install a plan or a library into the repository, you must ensure that all referenced artifacts within the plan or library have been installed as well.

Artifacts must have unique names so it is considered best practice to include the version number in the file name, allowing for multiple versions of the artifact to be installed at the same time. For example, a bundle file name might be my-exciting-bundle.2.1.0.jar.

For watched repositories, such as $SERVER_HOME/repository/usr, Virgo automatically detects changes at runtime, thereby avoiding the need to restart Virgo.

Of specific relevance during development is picking up changes to an application’s direct dependencies during deployment of the application. For example, if you deploy an application and receive a message that a dependency is missing, you can simply add the dependency to the repository and then redeploy the application. The redeploy will cause the new dependency to be picked up, allowing progress to be made without restarting Virgo. For other changes such as addition of optional dependencies, Virgo must be restarted to pick up any changes to the provisioning repository.