org.jboss.osgi.framework.spi

Interface BundleManager

All Superinterfaces:

org.jboss.msc.service.Service<BundleManager>, org.jboss.msc.value.Value<BundleManager>

public interface BundleManager
extends org.jboss.msc.service.Service<BundleManager>

Integration point for Bundle management.

Since:

24-Mar-2011

Author:

thomas.diesler@jboss.com

Field Summary

Fields inherited from interface org.jboss.msc.service.Service

NULL, NULL_VALUE

Method Summary

Modifier and Type	Method and Description
XBundle	getBundleById(long bundleId) Get a bundle by id Note, this will get the bundle regadless of its state.
XBundle	getBundleByLocation(String location) Get a bundle by location
Set<XBundle>	getBundles() Get the set of bundles that are not in state Bundle.UNINSTALLED.
Set<XBundle>	getBundles(Integer states) Get the set of bundles that are in one of the given states.
Set<XBundle>	getBundles(String symbolicName, org.osgi.framework.VersionRange versionRange) Get the set of bundles with the given symbolic name and version Note, this will get bundles regadless of their state.
Map<String,Object>	getProperties() Returns the framework properties merged with the System properties.
Object	getProperty(String key) Get a framework property
org.jboss.msc.service.ServiceContainer	getServiceContainer() Get the service container
org.jboss.msc.service.ServiceTarget	getServiceTarget() Get the service target
XBundle	getSystemBundle() Get the system bundle
XBundleRevision	installBundleRevision(org.osgi.framework.BundleContext context, Deployment deployment, org.jboss.msc.service.ServiceTarget serviceTarget) Install a XBundleRevision from the given deployment
boolean	isFrameworkActive() True the framework has reached the Services.FRAMEWORK_ACTIVE state
void	registerExecutorService(ExecutorService executorService) Register an executor service with the bundle manager When the framework stops all the executor services are shutdown.
void	removeRevision(XBundleRevision revision, int options) Remove a bundle revision from the framework
void	resolveBundle(XBundle bundle) Resolve the given bundle
void	startBundle(XBundle bundle, int options) Start the given bundle
void	stopBundle(XBundle bundle, int options) Stop the given bundle
void	uninstallBundle(XBundle bundle, int options) Uninstall the given bundle
void	unregisterExecutorService(ExecutorService executorService) Register an executor service with the bundle manager When the framework stops all the executor services are shutdown.
void	updateBundle(XBundle bundle, InputStream input) Update the given bundle

Methods inherited from interface org.jboss.msc.service.Service

start, stop

Methods inherited from interface org.jboss.msc.value.Value

getValue

Method Detail

getBundles

Set<XBundle> getBundles()

Get the set of bundles that are not in state Bundle.UNINSTALLED.

getBundles

Set<XBundle> getBundles(Integer states)

Get the set of bundles that are in one of the given states. If the states pattern is null, it returns all registered bundles.

Parameters:

states - The binary or combination of states or null

getBundles

Set<XBundle> getBundles(String symbolicName,
                        org.osgi.framework.VersionRange versionRange)

Get the set of bundles with the given symbolic name and version Note, this will get bundles regadless of their state. i.e. The returned bundles may have been UNINSTALLED

Parameters:

symbolicName - The bundle symbolic name

versionRange - The optional bundle version range

Returns:

The bundles or an empty set if there is no bundle with that name and version

getBundleById

XBundle getBundleById(long bundleId)

Get a bundle by id Note, this will get the bundle regadless of its state. i.e. The returned bundle may have been UNINSTALLED

Parameters:

bundleId - The identifier of the bundle

Returns:

The bundle or null if there is no bundle with that id

getBundleByLocation

XBundle getBundleByLocation(String location)

Get a bundle by location

Parameters:

location - the location of the bundle

Returns:

the bundle or null if there is no bundle with that location

getSystemBundle

XBundle getSystemBundle()

Get the system bundle

Returns:

the system bundle or null if the framework has not reached the IntegrationServices.SYSTEM_BUNDLE_INTERNAL state

isFrameworkActive

boolean isFrameworkActive()

True the framework has reached the Services.FRAMEWORK_ACTIVE state

installBundleRevision

XBundleRevision installBundleRevision(org.osgi.framework.BundleContext context,
                                      Deployment deployment,
                                      org.jboss.msc.service.ServiceTarget serviceTarget)
                               throws org.osgi.framework.BundleException

Install a XBundleRevision from the given deployment

Parameters:

context - The context that is used to install the revision

deployment - The bundle deployment

serviceTarget - The service target for the service

Returns:

The bundle revision

Throws:

org.osgi.framework.BundleException

resolveBundle

void resolveBundle(XBundle bundle)
            throws ResolutionException

Resolve the given bundle

Throws:

ResolutionException

startBundle

void startBundle(XBundle bundle,
                 int options)
          throws org.osgi.framework.BundleException

Start the given bundle

Throws:

org.osgi.framework.BundleException

stopBundle

void stopBundle(XBundle bundle,
                int options)
         throws org.osgi.framework.BundleException

Stop the given bundle

Throws:

org.osgi.framework.BundleException

updateBundle

void updateBundle(XBundle bundle,
                  InputStream input)
           throws org.osgi.framework.BundleException

Update the given bundle

Throws:

org.osgi.framework.BundleException

uninstallBundle

void uninstallBundle(XBundle bundle,
                     int options)
              throws org.osgi.framework.BundleException

Uninstall the given bundle

Throws:

org.osgi.framework.BundleException

removeRevision

void removeRevision(XBundleRevision revision,
                    int options)

Remove a bundle revision from the framework

Parameters:

revision - The bundle revision

options - TODO

getServiceContainer

org.jboss.msc.service.ServiceContainer getServiceContainer()

Get the service container

getServiceTarget

org.jboss.msc.service.ServiceTarget getServiceTarget()

Get the service target

registerExecutorService

void registerExecutorService(ExecutorService executorService)

Register an executor service with the bundle manager When the framework stops all the executor services are shutdown.

unregisterExecutorService

void unregisterExecutorService(ExecutorService executorService)

Register an executor service with the bundle manager When the framework stops all the executor services are shutdown.

getProperties

Map<String,Object> getProperties()

Returns the framework properties merged with the System properties.

Returns:

The effective framework properties in a map

getProperty

Object getProperty(String key)

Get a framework property

Returns:

The properties value or the given default