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, Plugin.EnabledMetricsSource, 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 underlaying OSGi Bundle natural states

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.plugin.Plugin

Plugin.EnabledMetricsSource, Plugin.Resolvable

Nested classes/interfaces inherited from interface com.atlassian.plugin.Plugin.EnabledMetricsSource

Plugin.EnabledMetricsSource.Default

Field Summary

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

pluginArtifact

Fields inherited from interface com.atlassian.plugin.Plugin

NAME_COMPARATOR, VERSION_1, VERSION_2, VERSION_3

Constructor Summary

Constructors

Constructor and Description
OsgiBundlePlugin(org.osgi.framework.Bundle bundle, String pluginKey, PluginArtifact pluginArtifact) Deprecated. since 3.0.23, use OsgiBundlePlugin(OsgiContainerManager, String, PluginArtifact)
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()
protected PluginState	enableInternal()
org.osgi.framework.Bundle	getBundle() Returns OSGi Bundle that corresponds to the current plugin
ClassLoader	getClassLoader()
ContainerAccessor	getContainerAccessor()
Date	getDateInstalled()
Date	getDateLoaded()
PluginDependencies	getDependencies()
URL	getResource(String name)
InputStream	getResourceAsStream(String name)
protected void	installInternal()
boolean	isDeleteable()
boolean	isDynamicallyLoaded()
boolean	isUninstallable()
<T> Class<T>	loadClass(String clazz, Class<?> callingClass)
void	resolve()
protected void	uninstallInternal()

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, getResourceDescriptors, getResourceLocation, getScopeKey, hasAllPermissions, install, isBundledPlugin, isEnabled, isEnabledByDefault, isSystemPlugin, removeDynamicModuleDescriptor, removeModuleDescriptor, setBundledPlugin, setEnabled, 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, close, containsSystemModule, disable, enable, getActivePermissions, getDateEnabled, getDateEnabling, getI18nNameKey, getInstallationMode, getKey, getModuleDescriptor, getModuleDescriptors, getModuleDescriptorsByModuleClass, getName, getPluginArtifact, getPluginInformation, getPluginState, getPluginsVersion, getRequiredPlugins, hasAllPermissions, install, isBundledPlugin, isEnabled, isEnabledByDefault, isSystemPlugin, setEnabled, 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, getResourceDescriptors, getResourceLocation

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

OsgiBundlePlugin

@Deprecated
public OsgiBundlePlugin(org.osgi.framework.Bundle bundle,
                                    String pluginKey,
                                    PluginArtifact pluginArtifact)

Deprecated. since 3.0.23, use OsgiBundlePlugin(OsgiContainerManager, String, PluginArtifact)

Create a plugin wrapper for an already installed Bundle.

Parameters:

bundle - The installed Bundle.

pluginKey - The plugin key.

pluginArtifact - The plugin artifact that was installed.

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()

Specified by:

getDateLoaded in interface Plugin

Overrides:

getDateLoaded in class AbstractPlugin

getDateInstalled

public Date getDateInstalled()

Specified by:

getDateInstalled in interface Plugin

Overrides:

getDateInstalled in class AbstractPlugin

isUninstallable

public boolean isUninstallable()

Specified by:

isUninstallable in interface Plugin

isDeleteable

public boolean isDeleteable()

Specified by:

isDeleteable in interface Plugin

isDynamicallyLoaded

public boolean isDynamicallyLoaded()

Specified by:

isDynamicallyLoaded in interface Plugin

loadClass

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

Specified by:

loadClass in interface Plugin

Throws:

ClassNotFoundException

getResource

public URL getResource(String name)

Specified by:

getResource in interface Plugin

getResourceAsStream

public InputStream getResourceAsStream(String name)

Specified by:

getResourceAsStream in interface Plugin

resolve

public void resolve()

Specified by:

resolve in interface Plugin

Overrides:

resolve in class AbstractPlugin

getDependencies

@Nonnull
public PluginDependencies getDependencies()

Specified by:

getDependencies in interface Plugin

Overrides:

getDependencies in class AbstractPlugin

See Also:

Plugin.getDependencies()

installInternal

protected void installInternal()
                        throws OsgiContainerException,
                               IllegalPluginStateException

Overrides:

installInternal in class AbstractPlugin

Throws:

OsgiContainerException

IllegalPluginStateException

uninstallInternal

protected void uninstallInternal()

Overrides:

uninstallInternal in class AbstractPlugin

enableInternal

protected PluginState enableInternal()

Overrides:

enableInternal in class AbstractPlugin

disableInternal

protected void disableInternal()

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

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface Plugin