com.atlassian.plugin.osgi.factory

Class OsgiBundlePlugin

java.lang.Object

com.atlassian.plugin.impl.AbstractPlugin

com.atlassian.plugin.osgi.factory.OsgiBundlePlugin

All Implemented Interfaces:

ContainerManagedPlugin, OsgiBackedPlugin, Plugin, PluginInternal, Resourced, ScopeAware, Comparable<Plugin>, EventListener, org.osgi.framework.BundleListener, org.osgi.framework.SynchronousBundleListener

public class OsgiBundlePlugin
extends AbstractPlugin
implements OsgiBackedPlugin, ContainerManagedPlugin, org.osgi.framework.SynchronousBundleListener

Plugin that wraps an OSGi bundle

That kind of plugins might have or do not have plugin descriptor and must manage internal IoC by themselves if it is present. Note that some modules require access to plugin IoC to work properly so it is plugin responsibility to provide a such access and manage internal container lifecycle.

To export any container to PluginsFramework bundle should export ContainerAccessor interface implementation as a service before move to ACTIVE state. Behavior is not defined if plugin provides more then one instances of ContainerAccessor Plugin of that type has lifecycle duplicates underlying OSGi Bundle natural states

Field Summary

Fields inherited from class com.atlassian.plugin.impl.AbstractPlugin

pluginArtifact

Fields inherited from interface com.atlassian.plugin.Plugin

VERSION_1, VERSION_2, VERSION_3

Constructor Summary

Constructors

Constructor and Description
OsgiBundlePlugin(OsgiContainerManager osgiContainerManager, String pluginKey, PluginArtifact pluginArtifact) Create a plugin wrapper which installs the bundle when the plugin is installed.

Method Summary

Modifier and Type	Method and Description
void	bundleChanged(org.osgi.framework.BundleEvent event)
protected void	disableInternal() Perform any internal disabling logic.
protected PluginState	enableInternal() Perform any internal enabling logic.
org.osgi.framework.Bundle	getBundle() Returns OSGi Bundle that corresponds to the current plugin
ClassLoader	getClassLoader() Get the classloader for the plugin.
ContainerAccessor	getContainerAccessor()
Date	getDateInstalled() The date this plugin was installed into the system, is the same as the loaded date for non artifact backed plugins
Date	getDateLoaded() The date this plugin was loaded into the system.
PluginDependencies	getDependencies() Determines which plugin keys are dependencies, categorising them as mandatory, optional or dynamic.
URL	getResource(String name) Retrieve the URL of the resource from the plugin.
InputStream	getResourceAsStream(String name) Load a given resource from the plugin.
protected void	installInternal() Perform any internal installation logic.
boolean	isDeleteable() Should the plugin file be deleted on uninstall?
boolean	isDynamicallyLoaded() Whether or not this plugin is loaded dynamically at runtime.
boolean	isUninstallable() Whether or not this plugin can be 'uninstalled'.
<T> Class<T>	loadClass(String clazz, Class<?> callingClass) Get the plugin to load a specific class.
void	resolve() Perform any required resolution.
protected void	uninstallInternal() Perform any internal uninstallation logic.

Methods inherited from class com.atlassian.plugin.impl.AbstractPlugin

addDynamicModuleDescriptor, addModuleDescriptor, cleanVersionString, close, compareAndSetPluginState, compareTo, containsSystemModule, disable, enable, getActivePermissions, getDateEnabled, getDateEnabling, getDynamicModuleDescriptors, getI18nNameKey, getInstallationMode, getKey, getLog, getModuleDescriptor, getModuleDescriptors, getModuleDescriptorsByModuleClass, getName, getPluginArtifact, getPluginInformation, getPluginState, getPluginsVersion, getRequiredPlugins, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hasAllPermissions, install, isBundledPlugin, isEnabledByDefault, isSystemPlugin, removeDynamicModuleDescriptor, removeModuleDescriptor, setBundledPlugin, setEnabledByDefault, setI18nNameKey, setKey, setName, setPluginInformation, setPluginState, setPluginsVersion, setResources, setSystemPlugin, toString, uninstall

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.plugin.Plugin

addModuleDescriptor, containsSystemModule, disable, enable, getActivePermissions, getDateEnabled, getDateEnabling, getI18nNameKey, getInstallationMode, getKey, getModuleDescriptor, getModuleDescriptors, getModuleDescriptorsByModuleClass, getName, getPluginArtifact, getPluginInformation, getPluginState, getPluginsVersion, hasAllPermissions, install, isBundledPlugin, isEnabledByDefault, isSystemPlugin, setEnabledByDefault, setI18nNameKey, setKey, setName, setPluginInformation, setPluginsVersion, setResources, setSystemPlugin, uninstall

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

OsgiBundlePlugin

public OsgiBundlePlugin(OsgiContainerManager osgiContainerManager,
                        String pluginKey,
                        PluginArtifact pluginArtifact)

Create a plugin wrapper which installs the bundle when the plugin is installed.

Parameters:

osgiContainerManager - the container to install into when the plugin is installed.

pluginKey - The plugin key.

pluginArtifact - The The plugin artifact to install.

Method Detail

getBundle

public org.osgi.framework.Bundle getBundle()
                                    throws IllegalPluginStateException

Description copied from interface: OsgiBackedPlugin

Returns OSGi Bundle that corresponds to the current plugin

Note that Bundle could be not available on some of Plugin lifecycle stages. In that case method call results in IllegalPluginStateException

Specified by:

getBundle in interface OsgiBackedPlugin

Returns:

OSGi representation of the current plugin

Throws:

IllegalPluginStateException - if plugin has no OSGi representation yet

getDateLoaded

public Date getDateLoaded()

Description copied from interface: Plugin

The date this plugin was loaded into the system.

Specified by:

getDateLoaded in interface Plugin

Overrides:

getDateLoaded in class AbstractPlugin

Returns:

The date this plugin was loaded into the system.

getDateInstalled

public Date getDateInstalled()

Description copied from interface: Plugin

The date this plugin was installed into the system, is the same as the loaded date for non artifact backed plugins

Specified by:

getDateInstalled in interface Plugin

Overrides:

getDateInstalled in class AbstractPlugin

Returns:

The date this plugin was installed into the system

isUninstallable

public boolean isUninstallable()

Description copied from interface: Plugin

Whether or not this plugin can be 'uninstalled'.

Specified by:

isUninstallable in interface Plugin

Returns:

true if this plugin can be 'uninstalled'.

isDeleteable

public boolean isDeleteable()

Description copied from interface: Plugin

Should the plugin file be deleted on uninstall?

Specified by:

isDeleteable in interface Plugin

Returns:

true if this plugin file should be deleted on uninstall.

isDynamicallyLoaded

public boolean isDynamicallyLoaded()

Description copied from interface: Plugin

Whether or not this plugin is loaded dynamically at runtime.

Specified by:

isDynamicallyLoaded in interface Plugin

Returns:

true if this plugin is loaded dynamically at runtime.

loadClass

public <T> Class<T> loadClass(String clazz,
                              Class<?> callingClass)
                       throws ClassNotFoundException

Description copied from interface: Plugin

Get the plugin to load a specific class.

Specified by:

loadClass in interface Plugin

Parameters:

clazz - The name of the class to be loaded

callingClass - The class calling the loading (used to help find a classloader)

Returns:

The loaded class.

Throws:

ClassNotFoundException - if the class cannot be located.

getResource

public URL getResource(String name)

Description copied from interface: Plugin

Retrieve the URL of the resource from the plugin.

Specified by:

getResource in interface Plugin

Parameters:

name - the name of the resource to be loaded

Returns:

The URL to the resource, or null if the resource is not found

getResourceAsStream

public InputStream getResourceAsStream(String name)

Description copied from interface: Plugin

Load a given resource from the plugin. Plugins that are loaded dynamically will need to implement this in a way that loads the resource from the same context as the plugin. Static plugins can just pull them from their own classloader.

Specified by:

getResourceAsStream in interface Plugin

Parameters:

name - The name of the resource to be loaded.

Returns:

An InputStream for the resource, or null if the resource is not found.

resolve

public void resolve()

Description copied from interface: Plugin

Perform any required resolution. This is a hook to allow the plugin system to perform a resolution pass over a group of modules before the enable pass.

Specified by:

resolve in interface Plugin

Overrides:

resolve in class AbstractPlugin

getDependencies

@Nonnull
public PluginDependencies getDependencies()

Description copied from interface: Plugin

Determines which plugin keys are dependencies, categorising them as mandatory, optional or dynamic.

Specified by:

getDependencies in interface Plugin

Overrides:

getDependencies in class AbstractPlugin

Returns:

not null, possibly empty

See Also:

Plugin.getDependencies()

installInternal

protected void installInternal()
                        throws OsgiContainerException,
                               IllegalPluginStateException

Description copied from class: AbstractPlugin

Perform any internal installation logic. Subclasses should only throw PluginException.

Overrides:

installInternal in class AbstractPlugin

Throws:

OsgiContainerException

IllegalPluginStateException

uninstallInternal

protected void uninstallInternal()

Description copied from class: AbstractPlugin

Perform any internal uninstallation logic. Subclasses should only throw PluginException.

Overrides:

uninstallInternal in class AbstractPlugin

enableInternal

protected PluginState enableInternal()

Description copied from class: AbstractPlugin

Perform any internal enabling logic. This method is called by enable to allow subclasses to customize enable behaviour. If a PluginState other than PluginState.PENDING is returned, it will be passed to AbstractPlugin.setPluginState(PluginState). If a subclass returns PluginState.PENDING, no state is set, and it is assumed the subclass has taken responsibility for transitioning state via direct calls to AbstractPlugin.setPluginState(PluginState). Subclasses should only throw PluginException.

Overrides:

enableInternal in class AbstractPlugin

Returns:

One of PluginState.ENABLED, PluginState.ENABLING, or PluginState.PENDING

disableInternal

protected void disableInternal()

Description copied from class: AbstractPlugin

Perform any internal disabling logic. Subclasses should only throw PluginException.

Overrides:

disableInternal in class AbstractPlugin

bundleChanged

public void bundleChanged(org.osgi.framework.BundleEvent event)

Specified by:

bundleChanged in interface org.osgi.framework.BundleListener

getContainerAccessor

public ContainerAccessor getContainerAccessor()

Specified by:

getContainerAccessor in interface ContainerManagedPlugin

Returns:

The object to use to access the plugin's container

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: Plugin

Get the classloader for the plugin.

Specified by:

getClassLoader in interface Plugin

Returns:

The classloader used to load classes for this plugin