org.jahia.osgi

Class BundleLifecycleUtils

java.lang.Object

org.jahia.osgi.BundleLifecycleUtils

public final class BundleLifecycleUtils
extends Object

Convenient utilities for OSGi bundle lifecycle and framework wiring.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
BundleLifecycleUtils()

Method Summary

Modifier and Type	Method and Description
static int	getBundleStartLevel(org.osgi.framework.Bundle bundle) Returns the start level of the provided bundle.
static int	getFrameworkStartLevel() Returns the start level of the OSGi framework.
static org.osgi.framework.wiring.FrameworkWiring	getFrameworkWiring() Obtains the FrameworkWiring.
static Set<org.osgi.framework.Bundle>	getHostsFragment(org.osgi.framework.Bundle fragment) Collect a set of hosts bundles for a fragment
static void	refreshBundle(org.osgi.framework.Bundle bundle) Refreshes the specified bundle and its "dependencies".
static void	refreshBundles(Collection<org.osgi.framework.Bundle> bundlesToRefresh, boolean considerFragments, boolean considerBundlesWithOptionalPackages) Refreshes the specified bundles and optionally their "dependencies".
static boolean	resolveBundle(org.osgi.framework.Bundle bundle) Resolves the specified bundle.
static boolean	resolveBundles(Collection<org.osgi.framework.Bundle> bundlesToResolve) Resolves the specified bundles.
static void	startBundlesPendingDependencies() Tries to start all the bundles which somehow got stopped mainly due to a missing dependencies.
static void	startModules(List<org.osgi.framework.Bundle> moduleBundles, boolean useModuleManagerApi) Start the specified module bundles in the order which tries to consider the dependencies between them.
static void	updateBundle(org.osgi.framework.Bundle bundle) Will update the bundle, calling stop/start on it.

Methods inherited from class java.lang.Object

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

Constructor Detail

BundleLifecycleUtils

public BundleLifecycleUtils()

Method Detail

getHostsFragment

public static Set<org.osgi.framework.Bundle> getHostsFragment(org.osgi.framework.Bundle fragment)

Collect a set of hosts bundles for a fragment

Parameters:

fragment - is the fragment to collect hosts bundles for

Returns:

a set of all bundles that match fragment's hosts

getBundleStartLevel

public static int getBundleStartLevel(org.osgi.framework.Bundle bundle)

Returns the start level of the provided bundle.

Parameters:

bundle - the bundle to get start level for

Returns:

the start level of the provided bundle

getFrameworkStartLevel

public static int getFrameworkStartLevel()

Returns the start level of the OSGi framework.

Returns:

the start level of the OSGi framework

getFrameworkWiring

public static org.osgi.framework.wiring.FrameworkWiring getFrameworkWiring()

Obtains the FrameworkWiring.

Returns:

the FrameworkWiring

refreshBundle

public static void refreshBundle(org.osgi.framework.Bundle bundle)

Refreshes the specified bundle and its "dependencies".

Parameters:

bundle - the bundle to refresh

refreshBundles

public static void refreshBundles(Collection<org.osgi.framework.Bundle> bundlesToRefresh,
                                  boolean considerFragments,
                                  boolean considerBundlesWithOptionalPackages)

Refreshes the specified bundles and optionally their "dependencies".

Parameters:

bundlesToRefresh - the bundles to refresh

considerFragments - should we also refresh the related fragment bundles?

considerBundlesWithOptionalPackages - should we consider bundles with optional package dependencies?

resolveBundle

public static boolean resolveBundle(org.osgi.framework.Bundle bundle)

Resolves the specified bundle.

Parameters:

bundle - the bundle to be resolved

Returns:

true if the specified bundle is resolved; false otherwise.

resolveBundles

public static boolean resolveBundles(Collection<org.osgi.framework.Bundle> bundlesToResolve)

Resolves the specified bundles.

Parameters:

bundlesToResolve - the bundles to resolve or null to resolve all unresolved bundles installed in the Framework

Returns:

true if all specified bundles are resolved; false otherwise.

startBundlesPendingDependencies

public static void startBundlesPendingDependencies()

Tries to start all the bundles which somehow got stopped mainly due to a missing dependencies. Inspired by the DirectoryWatcher from Felix FileInstall.

startModules

public static void startModules(List<org.osgi.framework.Bundle> moduleBundles,
                                boolean useModuleManagerApi)

Start the specified module bundles in the order which tries to consider the dependencies between them.

Parameters:

moduleBundles - the bundles to be started

useModuleManagerApi - should we use ModuleManager or call OSGi API directly?

updateBundle

public static void updateBundle(org.osgi.framework.Bundle bundle)
                         throws org.osgi.framework.BundleException

Will update the bundle, calling stop/start on it. Sometimes a refresh is necessary in case the bundle is providing wires to other bundles. The refresh will actualize the wires to the updated bundle revision.

Parameters:

bundle - the bundle to update

Throws:

org.osgi.framework.BundleException