HomeContactBlogMember Area

Creating a Bundle Repository with BIndex

Download the Bindex Program

The BIndex program is a small Java progam that implements the manifest header to repository format mapping as described in RFC-0112 Bundle Repository. BIndex can recurse over a directory structure and just creates a repository.xml file. The URLs can be rewritten using a template.

The program is a command line program that can easily be integrated in scripts. It is a JAR file with a Main-Class manifest. It therefore supports the following basic syntax: 

java -jar bindex.jar 
		[-help] 
		[-d rootdir ] 
		[-r repository.xml (.zip ext is ok)] 
		[-l file:license.html ] 
                [-ignore ]
		[-t http://w.com/servl?s=%s&v=%v %s=symbolic-name
                        %v=version %p=relative path %f=name] 
                [-stylesheet http://www.osgi.org/www/obr2html.xsl]
		[-q (quiet) ]
		<jar file>*
OptionDescription
-helpProvides a short description of the command line options.
-d rootdirSets the root directory from where files are indexed. Default is the current directory.
-r repository.xmlSet the name of the repository file as it is stored in the on the file system. The default is repository.xml. The extension may also be .zip. In that case a zip file is created with a single entry called repository.xml.
-stylesheet <stylesheet> Sets a custom stylesheet for the xml. The default style sheet is http://www.osgi.org/www/obr2html.xsl
-l <license.html>Provides a default for the license file. If the bundle itself does not provide a license file, this license is used. There is no default provided.
-ignoreIgnore exceptions when parsing manifests. Some bundles have no manifest or invalid information. The ignoring is logged to the stderr stream
-t <template>Use a template to make the URL of the resource. The template supports the following keys. The examples assume d1/d2/f1.jar with com.acme.b as symbolic name and 1.0 as version.
%s com.acme.bundle Bundle Symbolic Name
%v 1.0         Bundle Version
%p d1/d2       Relative directory path of current 
               working directory
%f f1.jar      File name of resource
-q Do not show the repository.xml file to the console.

For example, to index all bundles that reside in the bundles directory:

java -jar bindex.jar bundles/*.jar

Source Code

The Bindex program is now available as open source. You can check out the project with SVN, use org.osgi.impl.bundle.bindex. Please provide any to improve this project. If you have created an XML repository file, do not hesitate to share it with us so we can link it into OBR.


Home | Trademark Policy | Privacy Policy

Copyright © 2012 OSGi™ Alliance. Comments about the site?  Send them to: OSGi Alliance WebMaster.