com.atlassian.jira

Class ComponentManager

java.lang.Object

com.atlassian.jira.ComponentManager

Deprecated.

since 7.11 use ComponentAccessor instead (or inject dependencies where possible)

@Deprecated
 @Internal
public class ComponentManager
extends Object

This is a temporary, partial facade to ComponentManager, which has been moved. It exists simply to avoid breaking any plugins that still refer to this class in its old location (i.e. here). This class will be removed in Jira 8.0; plugins should be using ComponentAccessor anyway.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_PROVIDER_PROPERTY Deprecated. since 4.3; this extension point is being removed in Jira 8.0

Constructor Summary

Constructors

Constructor and Description
ComponentManager() Deprecated.

Method Summary

Modifier and Type	Method and Description
static <T> T	getComponent(Class<T> componentClass) Deprecated. Retrieves and returns a component which is an instance of given class.
static <T> T	getComponentInstanceOfType(Class<T> type) Deprecated. Retrieves and returns a component which is an instance of given class.
static <T> List<T>	getComponentsOfType(Class<T> type) Deprecated. Returns all the components inside Pico that are instances of the given class.
static <T> Map<String,T>	getComponentsOfTypeMap(Class<T> type) Deprecated. Returns all the components currently inside Pico which are instances of the given class, mapping them to their component key.
static ComponentManager	getInstance() Deprecated. Retuns the component manager.
static <T> T	getOSGiComponentInstanceOfType(Class<T> type) Deprecated. Retrieves and returns a public component from OSGi land via its class name.

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

Deprecated. since 4.3; this extension point is being removed in Jira 8.0

See Also:

ComponentManager.EXTENSION_PROVIDER_PROPERTY, Constant Field Values

Constructor Detail

ComponentManager

public ComponentManager()

Deprecated.

Method Detail

getComponent

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

Deprecated.

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 Container. 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:

componentClass - class to find a component instance by

Returns:

found component, or null if not found

See Also:

getOSGiComponentInstanceOfType(Class)

getComponentInstanceOfType

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

Deprecated.

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:

type - class to find a component instance by

Returns:

found component

See Also:

getOSGiComponentInstanceOfType(Class)

getComponentsOfType

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

Deprecated.

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

Parameters:

type - the class for which to search

Returns:

see above

getComponentsOfTypeMap

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

Deprecated.

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

Parameters:

type - the type for which to search

Returns:

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

getInstance

@Nonnull
public static ComponentManager getInstance()

Deprecated.

Retuns the component manager.

Returns:

a singleton

getOSGiComponentInstanceOfType

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

Deprecated.

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:

type - class to find an OSGi component instance for

Returns:

found component

See Also:

getComponentInstanceOfType(Class)