com.atlassian.plugin.osgi.container.felix

Class FelixOsgiContainerManager

java.lang.Object

com.atlassian.plugin.osgi.container.felix.FelixOsgiContainerManager

All Implemented Interfaces:

OsgiContainerManager

public class FelixOsgiContainerManager
extends Object
implements OsgiContainerManager

Felix implementation of the OSGi container manager

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATLASSIAN_BOOTDELEGATION
static String	ATLASSIAN_BOOTDELEGATION_EXTRA
static String	ATLASSIAN_DISABLE_REFERENCE_PROTOCOL
static int	REFRESH_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
FelixOsgiContainerManager(File frameworkBundlesDirectory, OsgiPersistentCache persistentCache, PackageScannerConfiguration packageScannerConfig, HostComponentProvider provider, PluginEventManager eventManager) Constructs the container manager.
FelixOsgiContainerManager(URL frameworkBundlesZip, OsgiPersistentCache persistentCache, PackageScannerConfiguration packageScannerConfig, HostComponentProvider provider, PluginEventManager eventManager) Constructs the container manager.

Method Summary

Modifier and Type	Method and Description
void	addBundleListener(org.osgi.framework.BundleListener listener) That is shortcut to access SystemBundle.
void	clearExportCache() Clears export cache.
org.osgi.framework.Bundle[]	getBundles() Gets a list of installed bundles
List<HostComponentRegistration>	getHostComponentRegistrations() Gets a list of host component registrations
org.osgi.framework.ServiceReference[]	getRegisteredServices() Gets a list of service references
org.osgi.util.tracker.ServiceTracker	getServiceTracker(String interfaceClassName) Gets a service tracker to follow a service registered under a certain interface.
org.osgi.util.tracker.ServiceTracker	getServiceTracker(String interfaceClassName, org.osgi.util.tracker.ServiceTrackerCustomizer serviceTrackerCustomizer) Gets a service tracker to follow a service registered under a certain interface with a ServiceTrackerCustomizer attached for customizing tracked service objects.
org.osgi.framework.Bundle	installBundle(File file, ReferenceMode referenceMode) Installs a bundle into a running OSGI container.
boolean	isRunning()
void	onPluginFrameworkWarmRestarting(PluginFrameworkWarmRestartingEvent event)
void	onPluginUninstallation(PluginUninstalledEvent event)
void	onPluginUpgrade(PluginUpgradedEvent event)
void	onShutdown(PluginFrameworkShutdownEvent event)
void	onStart(PluginFrameworkStartingEvent event)
void	removeBundleListener(org.osgi.framework.BundleListener listener) That is shortcut to access SystemBundle.
void	setDisableMultipleBundleVersions(boolean val)
void	setFelixLogger(org.apache.felix.framework.Logger logger)
void	start() Starts the OSGi container
void	stop() Stops the OSGi container

Methods inherited from class java.lang.Object

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

Field Detail

REFRESH_TIMEOUT

public static final int REFRESH_TIMEOUT

See Also:

Constant Field Values

ATLASSIAN_BOOTDELEGATION

public static final String ATLASSIAN_BOOTDELEGATION

See Also:

Constant Field Values

ATLASSIAN_BOOTDELEGATION_EXTRA

public static final String ATLASSIAN_BOOTDELEGATION_EXTRA

See Also:

Constant Field Values

ATLASSIAN_DISABLE_REFERENCE_PROTOCOL

public static final String ATLASSIAN_DISABLE_REFERENCE_PROTOCOL

See Also:

Constant Field Values

Constructor Detail

FelixOsgiContainerManager

public FelixOsgiContainerManager(URL frameworkBundlesZip,
                                 OsgiPersistentCache persistentCache,
                                 PackageScannerConfiguration packageScannerConfig,
                                 HostComponentProvider provider,
                                 PluginEventManager eventManager)
                          throws OsgiContainerException

Constructs the container manager.

Parameters:

frameworkBundlesZip - The location of the zip file containing framework bundles

persistentCache - The persistent cache to use for the framework and framework bundles

packageScannerConfig - The configuration for package scanning

provider - The host component provider. May be null.

eventManager - The plugin event manager to register for init and shutdown events

Throws:

OsgiContainerException - If the host version isn't supplied and the cache directory cannot be cleaned.

Since:

2.2.0

FelixOsgiContainerManager

public FelixOsgiContainerManager(File frameworkBundlesDirectory,
                                 OsgiPersistentCache persistentCache,
                                 PackageScannerConfiguration packageScannerConfig,
                                 HostComponentProvider provider,
                                 PluginEventManager eventManager)
                          throws OsgiContainerException

Constructs the container manager.

This constructor is used when frameworkBundlesDirectory has already been populated with the framework bundles. It ignores OsgiPersistentCache.getFrameworkBundleCache().

Parameters:

frameworkBundlesDirectory - The directory containing framework bundles

persistentCache - The persistent cache to use for the framework

packageScannerConfig - The configuration for package scanning

provider - The host component provider. May be null.

eventManager - The plugin event manager to register for init and shutdown events

Throws:

OsgiContainerException - If the host version isn't supplied and the cache directory cannot be cleaned.

Since:

3.0.21

Method Detail

setFelixLogger

public void setFelixLogger(org.apache.felix.framework.Logger logger)

setDisableMultipleBundleVersions

public void setDisableMultipleBundleVersions(boolean val)

clearExportCache

public void clearExportCache()

Clears export cache.

Since:

2.9.0

onStart

public void onStart(PluginFrameworkStartingEvent event)

onShutdown

public void onShutdown(PluginFrameworkShutdownEvent event)

onPluginUpgrade

public void onPluginUpgrade(PluginUpgradedEvent event)

onPluginUninstallation

public void onPluginUninstallation(PluginUninstalledEvent event)

onPluginFrameworkWarmRestarting

public void onPluginFrameworkWarmRestarting(PluginFrameworkWarmRestartingEvent event)

start

public void start()
           throws OsgiContainerException

Description copied from interface: OsgiContainerManager

Starts the OSGi container

Specified by:

start in interface OsgiContainerManager

Throws:

OsgiContainerException - If the container cannot be started

stop

public void stop()
          throws OsgiContainerException

Description copied from interface: OsgiContainerManager

Stops the OSGi container

Specified by:

stop in interface OsgiContainerManager

Throws:

OsgiContainerException - If the container cannot be stopped

getBundles

public org.osgi.framework.Bundle[] getBundles()

Description copied from interface: OsgiContainerManager

Gets a list of installed bundles

Specified by:

getBundles in interface OsgiContainerManager

Returns:

An array of bundles

getRegisteredServices

public org.osgi.framework.ServiceReference[] getRegisteredServices()

Description copied from interface: OsgiContainerManager

Gets a list of service references

Specified by:

getRegisteredServices in interface OsgiContainerManager

Returns:

An array of service references

getServiceTracker

public org.osgi.util.tracker.ServiceTracker getServiceTracker(String interfaceClassName)

Description copied from interface: OsgiContainerManager

Gets a service tracker to follow a service registered under a certain interface. Will return a new ServiceTracker instance for every call, so don't call more than necessary. Any provided ServiceTracker instances will be opened before returning and automatically closed on shutdown.

Specified by:

getServiceTracker in interface OsgiContainerManager

Parameters:

interfaceClassName - The interface class as a String

Returns:

A service tracker to follow all instances of that interface

getServiceTracker

public org.osgi.util.tracker.ServiceTracker getServiceTracker(String interfaceClassName,
                                                              org.osgi.util.tracker.ServiceTrackerCustomizer serviceTrackerCustomizer)

Description copied from interface: OsgiContainerManager

Gets a service tracker to follow a service registered under a certain interface with a ServiceTrackerCustomizer attached for customizing tracked service objects. Will return a new ServiceTracker instance for every call, so don't call more than necessary. Any provided ServiceTracker instances will be opened before returning and automatically closed on shutdown.

Specified by:

getServiceTracker in interface OsgiContainerManager

Parameters:

interfaceClassName - The interface class as a String

serviceTrackerCustomizer - service tracker customizer for the created service tracker

Returns:

A service tracker to follow all instances of that interface

addBundleListener

public void addBundleListener(org.osgi.framework.BundleListener listener)

Description copied from interface: OsgiContainerManager

That is shortcut to access SystemBundle.

Specified by:

addBundleListener in interface OsgiContainerManager

removeBundleListener

public void removeBundleListener(org.osgi.framework.BundleListener listener)

Description copied from interface: OsgiContainerManager

That is shortcut to access SystemBundle.

Specified by:

removeBundleListener in interface OsgiContainerManager

installBundle

public org.osgi.framework.Bundle installBundle(File file,
                                               ReferenceMode referenceMode)
                                        throws OsgiContainerException

Description copied from interface: OsgiContainerManager

Installs a bundle into a running OSGI container.

Specified by:

installBundle in interface OsgiContainerManager

Parameters:

file - The bundle file to install.

referenceMode - specifies whether the container may install a reference to, rather than copy, the bundle file.

Returns:

The installed bundle.

Throws:

OsgiContainerException - If the bundle cannot be loaded

isRunning

public boolean isRunning()

Specified by:

isRunning in interface OsgiContainerManager

Returns:

If the container is running or not

getHostComponentRegistrations

public List<HostComponentRegistration> getHostComponentRegistrations()

Description copied from interface: OsgiContainerManager

Gets a list of host component registrations

Specified by:

getHostComponentRegistrations in interface OsgiContainerManager

Returns:

A list of host component registrations