com.atlassian.jira

Class ComponentManager

java.lang.Object

com.atlassian.jira.ComponentManager

All Implemented Interfaces:

Shutdown

@Internal
public class ComponentManager
extends Object
implements Shutdown

This component manager uses PicoContainer to resolve all the dependencies between components.

It is responsible for initialising a large number of components in JIRA. Any components defined here may be injected via a constructor.

The ComponentManager also has static accessor methods for accessing components, such as getComponent(Class). Plugins developers should use ComponentAccessor for this, instead.

The ComponentManager also has various static accessor methods for non-Pico-managed objects, eg. ComponentManager.getInstance().getProjectManager(). Plugins developers should no longer use these - please use ComponentAccessor instead.

More information can be found at the picocontainer website.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComponentManager.PluginSystemState
static interface	ComponentManager.State The state of the ComponentManager.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_PROVIDER_PROPERTY

Method Summary

Modifier and Type	Method and Description
void	bootstrapInitialise() Initialization registers components for the bootstrap loading of JIRA.
boolean	componentsAvailable() Determines whether components have already been instantiated regardless of which container is in play.
void	dispose()
void	extendBootstrapContainerForFailedStartup()
static <T> T	getComponent(Class<T> clazz) Retrieves and returns a component which is an instance of given class.
static <T> T	getComponentInstanceOfType(Class<T> clazz) Retrieves and returns a component which is an instance of given class.
static <T> List<T>	getComponentsOfType(Class<T> clazz) Returns all the components currently inside of Pico which are instances of the given class.
static <T> Map<String,T>	getComponentsOfTypeMap(Class<T> iface) Returns all the components currently inside Pico which are instances of the given class, mapping them to their component key.
org.picocontainer.PicoContainer	getContainer() Returns container
static ComponentManager	getInstance() Retuns a singleton instance of this class.
org.picocontainer.MutablePicoContainer	getMutablePicoContainer() Returns container
static <T> T	getOSGiComponentInstanceOfType(Class<T> clazz) Deprecated. since 6.0 - please use the jira-api ComponentAccessor.getOSGiComponentInstanceOfType(Class) instead
ComponentManager.PluginSystemState	getPluginSystemState() What ComponentManager.PluginSystemState is the plugin system in? This can be used to discover whether delayed plugins were started.
ComponentManager.State	getState() What ComponentManager.State is the ComponentManager in.
void	initialise() Initialization registers components and then registers extensions.
void	lateStart() Start delayed plugins (if any)
void	setupInitialise() If JIRA needs to be setup, then add the extra components needed to the bootstrap container.
void	shutdown() Shutdown.
void	start() Starts the plugin system and registers plugin components with pico.
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_PROVIDER_PROPERTY

public static final String EXTENSION_PROVIDER_PROPERTY

See Also:

Constant Field Values

Method Detail

bootstrapInitialise

public void bootstrapInitialise()

Initialization registers components for the bootstrap loading of JIRA.

setupInitialise

public void setupInitialise()

If JIRA needs to be setup, then add the extra components needed to the bootstrap container.

extendBootstrapContainerForFailedStartup

public void extendBootstrapContainerForFailedStartup()

initialise

public void initialise()

Initialization registers components and then registers extensions.

start

public void start()

Starts the plugin system and registers plugin components with pico. If there is no tenant, delayed (phase 2) plugins will not be started.

lateStart

public void lateStart()

Start delayed plugins (if any)

componentsAvailable

public boolean componentsAvailable()

Determines whether components have already been instantiated regardless of which container is in play. The container in play can either be the full container, the setup container or the failed startup container.

Returns:

true, if components have already been instantiated by the container in play; otherwise, false.

See Also:

ContainerLevel#FULL_CONTAINER, ContainerLevel#EXTENDED_BOOTSTRAP

stop

public void stop()

dispose

public void dispose()

shutdown

public void shutdown()

Description copied from interface: Shutdown

Shutdown. Should not throw any exceptions.

Specified by:

shutdown in interface Shutdown

getState

public ComponentManager.State getState()

What ComponentManager.State is the ComponentManager in.

Returns:

the current state.

getPluginSystemState

public ComponentManager.PluginSystemState getPluginSystemState()

What ComponentManager.PluginSystemState is the plugin system in? This can be used to discover whether delayed plugins were started.

Returns:

the current plugins system state

getContainer

public org.picocontainer.PicoContainer getContainer()

Returns container

Returns:

container

getMutablePicoContainer

public org.picocontainer.MutablePicoContainer getMutablePicoContainer()

Returns container

Returns:

container

getInstance

public static ComponentManager getInstance()

Retuns a singleton instance of this class.

Returns:

a singleton instance of this class

getComponentInstanceOfType

public static <T> T getComponentInstanceOfType(Class<T> clazz)

Retrieves and returns a component which is an instance of given class.

In practise, this is the same as getComponent(Class) except it will try to find a unique component that implements/extends the given Class even if the Class is not an actual component key.

Please note that this method only gets components from JIRA's core Pico Containter. That is, it retrieves core components and components declared in Plugins1 plugins, but not components declared in Plugins2 plugins. Plugins2 components can be retrieved via the getOSGiComponentInstanceOfType(Class) method, but only if they are public.

Parameters:

clazz - class to find a component instance by

Returns:

found component

See Also:

getOSGiComponentInstanceOfType(Class), PicoContainer#getComponent(Class))

getComponent

@Nullable
public static <T> T getComponent(Class<T> clazz)

Retrieves and returns a component which is an instance of given class.

In practise, this is the same as getComponentInstanceOfType(Class) except it will fail faster if the given Class is not a known component key (it also has a shorter and more meaningful name).

Please note that this method only gets components from JIRA's core Pico Containter. That is, it retrieves core components and components declared in Plugins1 plugins, but not components declared in Plugins2 plugins. Plugins2 components can be retrieved via the getOSGiComponentInstanceOfType(Class) method, but only if they are public.

Parameters:

clazz - class to find a component instance by

Returns:

found component, or null if not found

See Also:

getOSGiComponentInstanceOfType(Class), PicoContainer.getComponent(Object)

getOSGiComponentInstanceOfType

@Nullable
public static <T> T getOSGiComponentInstanceOfType(Class<T> clazz)

Deprecated. since 6.0 - please use the jira-api ComponentAccessor.getOSGiComponentInstanceOfType(Class) instead

Retrieves and returns a public component from OSGi land via its class name. This method can be used to retrieve a component provided via a plugins2 OSGi bundle. Please note that components returned via this method should *NEVER* be cached (e.g. in a static field) as they may be refreshed at any time as a plugin is enabled/disabled or the componentManager is reinitialised (after an XML import).

Plugin developers should prefer the API method ComponentAccessor.getOSGiComponentInstanceOfType(Class).

It is important to note that this only works for public components. That is components with public="true" declared in their XML configuration. This means that they are available for other plugins to import.

A use case for this is when for example for the dashboards plugin. In several areas in JIRA we may want to render gadgets via the GadgetViewFactory. Whilst the interface for this component is available in JIRA core, the implementation is provided by the dashboards OSGi bundle. This method will allow us to access it.

Parameters:

clazz - class to find an OSGi component instance for

Returns:

found component

See Also:

getComponentInstanceOfType(Class)

getComponentsOfType

public static <T> List<T> getComponentsOfType(Class<T> clazz)

Returns all the components currently inside of Pico which are instances of the given class.

Parameters:

clazz - the class to search for.

Returns:

a list containing all the instances of the passed class registered in JIRA's pico container.

getComponentsOfTypeMap

public static <T> Map<String,T> getComponentsOfTypeMap(Class<T> iface)

Returns all the components currently inside Pico which are instances of the given class, mapping them to their component key.

Parameters:

iface - The class to search for

Returns:

a map, mapping the component key, to the instances of the clas registered in JIRA's pico container.