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

Methods

Modifier and Type	Method and Description
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	addDynamicImportPackage(String imported)
OSGiManifestBuilder	addDynamicImportPackages(Class<?>... imported)
OSGiManifestBuilder	addDynamicImportPackages(Package... imported)
OSGiManifestBuilder	addDynamicImportPackages(String... imported)
OSGiManifestBuilder	addExportPackage(Class<?> exported, org.osgi.framework.Version version)
OSGiManifestBuilder	addExportPackage(Package exported, org.osgi.framework.Version version)
OSGiManifestBuilder	addExportPackage(String packageSpec)
OSGiManifestBuilder	addExportPackage(String packageName, org.osgi.framework.Version version)
OSGiManifestBuilder	addExportPackages(Class<?>... packages)
OSGiManifestBuilder	addExportPackages(Package... packages)
OSGiManifestBuilder	addExportPackages(String... packages)
OSGiManifestBuilder	addFragmentHost(String fragmentHost)
OSGiManifestBuilder	addFragmentHost(String fragmentHost, org.osgi.framework.VersionRange version)
OSGiManifestBuilder	addImportPackage(Class<?> imported, org.osgi.framework.VersionRange version)
OSGiManifestBuilder	addImportPackage(Package imported, org.osgi.framework.VersionRange version)
OSGiManifestBuilder	addImportPackage(String packageSpec)
OSGiManifestBuilder	addImportPackage(String packageName, org.osgi.framework.VersionRange version)
OSGiManifestBuilder	addImportPackages(Class<?>... packages)
OSGiManifestBuilder	addImportPackages(Package... packages)
OSGiManifestBuilder	addImportPackages(String... packages)
OSGiManifestBuilder	addManifestHeader(String key, String value)
OSGiManifestBuilder	addProvidedCapabilities(String... capabilities)
OSGiManifestBuilder	addProvidedCapability(String namespace, Map<String,String> atts, Map<String,String> dirs)
OSGiManifestBuilder	addRequireBundle(String requiredBundle)
OSGiManifestBuilder	addRequireBundle(String requiredBundle, org.osgi.framework.VersionRange version)
OSGiManifestBuilder	addRequiredCapabilities(String... capabilities)
OSGiManifestBuilder	addRequiredCapability(String namespace, Map<String,String> atts, Map<String,String> dirs)
OSGiManifestBuilder	addRequiredExecutionEnvironment(String execenv)
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)

addRequiredExecutionEnvironment

public OSGiManifestBuilder addRequiredExecutionEnvironment(String execenv)

addFragmentHost

public OSGiManifestBuilder addFragmentHost(String fragmentHost)

addFragmentHost

public OSGiManifestBuilder addFragmentHost(String fragmentHost,
                                  org.osgi.framework.VersionRange version)

addManifestHeader

public OSGiManifestBuilder addManifestHeader(String key,
                                    String value)

addRequireBundle

public OSGiManifestBuilder addRequireBundle(String requiredBundle)

addRequireBundle

public OSGiManifestBuilder addRequireBundle(String requiredBundle,
                                   org.osgi.framework.VersionRange version)

addRequireExecutionEnvironment

public OSGiManifestBuilder addRequireExecutionEnvironment(String... environments)

addImportPackages

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

addImportPackages

public OSGiManifestBuilder addImportPackages(Package... packages)

addImportPackages

public OSGiManifestBuilder addImportPackages(String... packages)

addImportPackage

public OSGiManifestBuilder addImportPackage(Class<?> imported,
                                   org.osgi.framework.VersionRange version)

addImportPackage

public OSGiManifestBuilder addImportPackage(Package imported,
                                   org.osgi.framework.VersionRange version)

addImportPackage

public OSGiManifestBuilder addImportPackage(String packageName,
                                   org.osgi.framework.VersionRange version)

addImportPackage

public OSGiManifestBuilder addImportPackage(String packageSpec)

addDynamicImportPackages

public OSGiManifestBuilder addDynamicImportPackages(Class<?>... imported)

addDynamicImportPackages

public OSGiManifestBuilder addDynamicImportPackages(Package... imported)

addDynamicImportPackages

public OSGiManifestBuilder addDynamicImportPackages(String... imported)

addDynamicImportPackage

public OSGiManifestBuilder addDynamicImportPackage(String imported)

addExportPackages

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

addExportPackages

public OSGiManifestBuilder addExportPackages(Package... packages)

addExportPackages

public OSGiManifestBuilder addExportPackages(String... packages)

addExportPackage

public OSGiManifestBuilder addExportPackage(Class<?> exported,
                                   org.osgi.framework.Version version)

addExportPackage

public OSGiManifestBuilder addExportPackage(Package exported,
                                   org.osgi.framework.Version version)

addExportPackage

public OSGiManifestBuilder addExportPackage(String packageName,
                                   org.osgi.framework.Version version)

addExportPackage

public OSGiManifestBuilder addExportPackage(String packageSpec)

addProvidedCapabilities

public OSGiManifestBuilder addProvidedCapabilities(String... capabilities)

addProvidedCapability

public OSGiManifestBuilder addProvidedCapability(String namespace,
                                        Map<String,String> atts,
                                        Map<String,String> dirs)

addRequiredCapabilities

public OSGiManifestBuilder addRequiredCapabilities(String... capabilities)

addRequiredCapability

public OSGiManifestBuilder addRequiredCapability(String namespace,
                                        Map<String,String> atts,
                                        Map<String,String> dirs)

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