org.osgi.service.bindex
Interface BundleIndexer

public interface BundleIndexer

The BundleIndexer is an OSGi service for indexing bundle capabiilities and requirements and create an OBR XML representation.

Field Summary

static java.lang.String	LICENSE_URL
static java.lang.String	REPOSITORY_NAME
static java.lang.String	ROOT_URL
static java.lang.String	STYLESHEET
static java.lang.String	URL_TEMPLATE

Method Summary

void	index(java.util.Set<java.io.File> jarFiles, java.io.OutputStream out, java.util.Map<java.lang.String,java.lang.String> config) Index the input files and write the result to the given OutputStream

Field Detail

REPOSITORY_NAME

static final java.lang.String REPOSITORY_NAME

See Also:

Constant Field Values

STYLESHEET

static final java.lang.String STYLESHEET

See Also:

Constant Field Values

URL_TEMPLATE

static final java.lang.String URL_TEMPLATE

See Also:

Constant Field Values

ROOT_URL

static final java.lang.String ROOT_URL

See Also:

Constant Field Values

LICENSE_URL

static final java.lang.String LICENSE_URL

See Also:

Constant Field Values

Method Detail

index

void index(java.util.Set<java.io.File> jarFiles,
           java.io.OutputStream out,
           java.util.Map<java.lang.String,java.lang.String> config)
           throws java.lang.Exception

Index the input files and write the result to the given OutputStream

Parameters:

jarFiles - a set of input jar files or directories

out - the OutputStream to write to

config - a set of optional parameters (use constants of this interface as keys)

Throws:

java.lang.Exception