org.jboss.osgi.metadata
Class OSGiManifestBuilder

java.lang.Object
  org.jboss.osgi.metadata.OSGiManifestBuilder

All Implemented Interfaces:

org.jboss.shrinkwrap.api.asset.Asset

public final class OSGiManifestBuilder
extends Object
implements org.jboss.shrinkwrap.api.asset.Asset

A simple OSGi manifest builder.

Since:

08-Mar-2010

Author:

thomas.diesler@jboss.com

Method Summary

OSGiManifestBuilder	addBundleActivationPolicy(String activationPolicy)
OSGiManifestBuilder	addBundleActivator(Class<?> bundleActivator)
OSGiManifestBuilder	addBundleActivator(String bundleActivator)
OSGiManifestBuilder	addBundleClasspath(String classpath)
OSGiManifestBuilder	addBundleManifestVersion(int version)
OSGiManifestBuilder	addBundleName(String name)
OSGiManifestBuilder	addBundleSymbolicName(String symbolicName)
OSGiManifestBuilder	addBundleVersion(String version)
OSGiManifestBuilder	addBundleVersion(org.osgi.framework.Version version)
OSGiManifestBuilder	addDynamicImportPackages(String... packages)
OSGiManifestBuilder	addExportPackages(Class<?>... packages)
OSGiManifestBuilder	addExportPackages(String... packages)
OSGiManifestBuilder	addFragmentHost(String fragmentHost)
OSGiManifestBuilder	addImportPackages(Class<?>... packages)
OSGiManifestBuilder	addImportPackages(String... packages)
OSGiManifestBuilder	addManifestHeader(String key, String value)
OSGiManifestBuilder	addProvidedCapabilities(String... capabilities)
OSGiManifestBuilder	addRequireBundle(String requiredBundle)
OSGiManifestBuilder	addRequiredCapabilities(String... capabilities)
OSGiManifestBuilder	addRequireExecutionEnvironment(String... environments)
static int	getBundleManifestVersion(Manifest manifest) Get the bundle manifest version.
Manifest	getManifest()
static boolean	isValidBundleManifest(Manifest manifest) Validate a given bundle manifest.
static OSGiManifestBuilder	newInstance()
InputStream	openStream()
static void	validateBundleManifest(Manifest manifest) Validate a given manifest.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newInstance

public static OSGiManifestBuilder newInstance()

addBundleManifestVersion

public OSGiManifestBuilder addBundleManifestVersion(int version)

addBundleSymbolicName

public OSGiManifestBuilder addBundleSymbolicName(String symbolicName)

addBundleName

public OSGiManifestBuilder addBundleName(String name)

addBundleVersion

public OSGiManifestBuilder addBundleVersion(org.osgi.framework.Version version)

addBundleVersion

public OSGiManifestBuilder addBundleVersion(String version)

addBundleActivator

public OSGiManifestBuilder addBundleActivator(Class<?> bundleActivator)

addBundleActivator

public OSGiManifestBuilder addBundleActivator(String bundleActivator)

addBundleActivationPolicy

public OSGiManifestBuilder addBundleActivationPolicy(String activationPolicy)

addBundleClasspath

public OSGiManifestBuilder addBundleClasspath(String classpath)

addFragmentHost

public OSGiManifestBuilder addFragmentHost(String fragmentHost)

addManifestHeader

public OSGiManifestBuilder addManifestHeader(String key,
                                             String value)

addRequireBundle

public OSGiManifestBuilder addRequireBundle(String requiredBundle)

addRequireExecutionEnvironment

public OSGiManifestBuilder addRequireExecutionEnvironment(String... environments)

addImportPackages

public OSGiManifestBuilder addImportPackages(Class<?>... packages)

addImportPackages

public OSGiManifestBuilder addImportPackages(String... packages)

addDynamicImportPackages

public OSGiManifestBuilder addDynamicImportPackages(String... packages)

addExportPackages

public OSGiManifestBuilder addExportPackages(Class<?>... packages)

addExportPackages

public OSGiManifestBuilder addExportPackages(String... packages)

addProvidedCapabilities

public OSGiManifestBuilder addProvidedCapabilities(String... capabilities)

addRequiredCapabilities

public OSGiManifestBuilder addRequiredCapabilities(String... capabilities)

getManifest

public Manifest getManifest()

isValidBundleManifest

public static boolean isValidBundleManifest(Manifest manifest)

Validate a given bundle manifest.

Parameters:

manifest - The given manifest

Returns:

True if the manifest is valid

validateBundleManifest

public static void validateBundleManifest(Manifest manifest)
                                   throws org.osgi.framework.BundleException

Validate a given manifest.

Parameters:

manifest - The given manifest

Throws:

org.osgi.framework.BundleException - if the given manifest is not a valid OSGi manifest

getBundleManifestVersion

public static int getBundleManifestVersion(Manifest manifest)

Get the bundle manifest version.

Parameters:

manifest - The given manifest

Returns:

The value of the Bundle-ManifestVersion header, or -1 for a non OSGi manifest

openStream

public InputStream openStream()

Specified by:

openStream in interface org.jboss.shrinkwrap.api.asset.Asset