com.atlassian.jira.component
Class ComponentAccessor

java.lang.Object
  com.atlassian.jira.component.ComponentAccessor

public class ComponentAccessor
extends Object

Provides static methods for accessing JIRA's managed components (ie the components in the PicoContainer).

Normally developers should get the dependencies injected into the constructor of the calling class via Pico, however this utility provides access for when that is impossible (eg to escape from a circular dependency).

Since:

v4.3

Nested Class Summary

static interface

ComponentAccessor.Worker

Constructor Summary

ComponentAccessor()

Method Summary

static ApplicationProperties	getApplicationProperties()
static AttachmentManager	getAttachmentManager()
static AttachmentPathManager	getAttachmentPathManager() Retrieves and returns the attachment path instance
static AvatarManager	getAvatarManager()
static BulkOperationManager	getBulkOperationManager() Retrieves and return the bulk operation manager instance
static ChangeHistoryManager	getChangeHistoryManager() Retrieves and returns the ChangeHistoryManager manager instance
static ColumnLayoutManager	getColumnLayoutManager() Retrieves and returns the column layout manager instance
static CommentManager	getCommentManager()
static <T> T	getComponent(Class<T> componentClass) Returns the core component which is stored in JIRA's Dependency Injection container under the key that is the given class.
static <T> T	getComponentOfType(Class<T> componentClass) Returns the core component which is stored in JIRA's Dependency Injection container of the given Type (Class or Interface).
static ConstantsManager	getConstantsManager()
static com.atlassian.crowd.embedded.api.CrowdService	getCrowdService()
static CustomFieldManager	getCustomFieldManager()
static EventTypeManager	getEventTypeManager()
static FieldAccessor	getFieldAccessor()
static FieldLayoutManager	getFieldLayoutManager() Retrieves and returns the field layout manager
static FieldScreenManager	getFieldScreenManager() Retrieves and returns the field screen manager instance
static FieldScreenRendererFactory	getFieldScreenRendererFactory() Retrieves and returns the field screen renderer factory instance
static GroupManager	getGroupManager()
static I18nHelper.BeanFactory	getI18nHelperFactory()
static IndexPathManager	getIndexPathManager() Retrieves and returns the index path manager instance
static IssueFactory	getIssueFactory()
static IssueManager	getIssueManager()
static IssueSecurityLevelManager	getIssueSecurityLevelManager()
static IssueService	getIssueService() Retrieves and returns the issue service instance
static IssueTypeSchemeManager	getIssueTypeSchemeManager() Retrieves and returns the issue type scheme manager instance
static JiraAuthenticationContext	getJiraAuthenticationContext()
static LocaleManager	getLocaleManager()
static com.atlassian.mail.queue.MailQueue	getMailQueue()
static com.atlassian.mail.server.MailServerManager	getMailServerManager() Retrieves and returns the mail server manager instance
static MailThreadManager	getMailThreadManager()
static MoveSubTaskOperationManager	getMoveSubTaskOperationManager() Retrieves and returns the move subtask operation manager instance
static NotificationSchemeManager	getNotificationSchemeManager()
static OptionsManager	getOptionsManager()
static PermissionContextFactory	getPermissionContextFactory()
static PermissionManager	getPermissionManager()
static PermissionSchemeManager	getPermissionSchemeManager()
static com.atlassian.plugin.PluginAccessor	getPluginAccessor()
static com.atlassian.plugin.PluginController	getPluginController()
static com.atlassian.plugin.event.PluginEventManager	getPluginEventManager()
static ProjectComponentManager	getProjectComponentManager() Retrieves and returns the project component manager instance
static ProjectFactory	getProjectFactory() Retrieves and returns the project factory instance
static ProjectManager	getProjectManager()
static org.quartz.Scheduler	getScheduler()
static ServiceManager	getServiceManager()
static SubscriptionManager	getSubscriptionManager()
static SubTaskManager	getSubTaskManager() Retrieves and returns the subtask manager instance
static TrackbackManager	getTrackbackManager() Retrieves and returns the trackback manager instance.
static TranslationManager	getTranslationManager() Retrieves and returns the translation manager instance
static UserManager	getUserManager()
static UserPreferencesManager	getUserPreferencesManager() Retrieves and returns the user preferences manager instance
static UserPropertyManager	getUserPropertyManager() Retrieves and returns the user preferences manager instance
static UserUtil	getUserUtil()
static VelocityManager	getVelocityManager()
static VersionManager	getVersionManager()
static VoteManager	getVoteManager() Retrieves and returns the vote manager instance
static WatcherManager	getWatcherManager() Retrieves and returns the watcher manager instance
static WorkflowManager	getWorkflowManager()
static WorkflowSchemeManager	getWorkflowSchemeManager() Retrieves and returns the workflow scheme manager instance
static WorklogManager	getWorklogManager() Retrieves and returns the worklog manager instance
static ComponentAccessor.Worker	initialiseWorker(ComponentAccessor.Worker componentAccessorWorker)

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentAccessor

public ComponentAccessor()

Method Detail

getComponent

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

Returns the core component which is stored in JIRA's Dependency Injection container under the key that is the given class.

In practise, this is the same as getComponentOfType(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.

Parameters:

componentClass - class to find a component instance by

Returns:

the dependency injection component

See Also:

getComponentOfType(Class)

getComponentOfType

public static <T> T getComponentOfType(Class<T> componentClass)

Returns the core component which is stored in JIRA's Dependency Injection container of the given Type (Class or Interface).

First it tries to find the component using the given Class as a key (like getComponent(Class)), however, if this fails then it will try to find a unique component that implements/extends the given Class. This seems unlikely to be useful, but is included for now, for completeness and backward compatibility.

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.

Parameters:

componentClass - class to find a component instance by

Returns:

the dependency injection component

See Also:

getComponent(Class)

getProjectManager

public static ProjectManager getProjectManager()

getApplicationProperties

public static ApplicationProperties getApplicationProperties()

getJiraAuthenticationContext

public static JiraAuthenticationContext getJiraAuthenticationContext()

getConstantsManager

public static ConstantsManager getConstantsManager()

getVelocityManager

public static VelocityManager getVelocityManager()

getI18nHelperFactory

public static I18nHelper.BeanFactory getI18nHelperFactory()

getFieldAccessor

public static FieldAccessor getFieldAccessor()

getIssueManager

public static IssueManager getIssueManager()

getAttachmentManager

public static AttachmentManager getAttachmentManager()

getUserManager

public static UserManager getUserManager()

getPermissionManager

public static PermissionManager getPermissionManager()

getPermissionContextFactory

public static PermissionContextFactory getPermissionContextFactory()

getCustomFieldManager

public static CustomFieldManager getCustomFieldManager()

getUserUtil

public static UserUtil getUserUtil()

getGroupManager

public static GroupManager getGroupManager()

getEventTypeManager

public static EventTypeManager getEventTypeManager()

getWorkflowManager

public static WorkflowManager getWorkflowManager()

getIssueFactory

public static IssueFactory getIssueFactory()

getVersionManager

public static VersionManager getVersionManager()

getCommentManager

public static CommentManager getCommentManager()

getMailThreadManager

public static MailThreadManager getMailThreadManager()

getBulkOperationManager

public static BulkOperationManager getBulkOperationManager()

Retrieves and return the bulk operation manager instance

Returns:

bulk operation manager

getMoveSubTaskOperationManager

public static MoveSubTaskOperationManager getMoveSubTaskOperationManager()

Retrieves and returns the move subtask operation manager instance

Returns:

move subtask operation manager

getWorklogManager

public static WorklogManager getWorklogManager()

Retrieves and returns the worklog manager instance

Returns:

worklog manager

getProjectFactory

public static ProjectFactory getProjectFactory()

Retrieves and returns the project factory instance

Returns:

project factory

getIssueTypeSchemeManager

public static IssueTypeSchemeManager getIssueTypeSchemeManager()

Retrieves and returns the issue type scheme manager instance

Returns:

issue type scheme manager

getSubTaskManager

public static SubTaskManager getSubTaskManager()

Retrieves and returns the subtask manager instance

Returns:

subtask manager

getTrackbackManager

public static TrackbackManager getTrackbackManager()

Retrieves and returns the trackback manager instance. Used in OfBizTrackbackStore, which is constructed from within the trackback module.

Returns:

trackback manager

getCrowdService

public static com.atlassian.crowd.embedded.api.CrowdService getCrowdService()

getFieldLayoutManager

public static FieldLayoutManager getFieldLayoutManager()

Retrieves and returns the field layout manager

Returns:

field layout manager

getColumnLayoutManager

public static ColumnLayoutManager getColumnLayoutManager()

Retrieves and returns the column layout manager instance

Returns:

column layout manager

getVoteManager

public static VoteManager getVoteManager()

Retrieves and returns the vote manager instance

Returns:

vote manager

getPluginAccessor

public static com.atlassian.plugin.PluginAccessor getPluginAccessor()

getPluginEventManager

public static com.atlassian.plugin.event.PluginEventManager getPluginEventManager()

getPluginController

public static com.atlassian.plugin.PluginController getPluginController()

getFieldScreenRendererFactory

public static FieldScreenRendererFactory getFieldScreenRendererFactory()

Retrieves and returns the field screen renderer factory instance

Returns:

field screen renderer factory

getWorkflowSchemeManager

public static WorkflowSchemeManager getWorkflowSchemeManager()

Retrieves and returns the workflow scheme manager instance

Returns:

workflow scheme manager

getIssueService

public static IssueService getIssueService()

Retrieves and returns the issue service instance

Returns:

issue service

getIndexPathManager

public static IndexPathManager getIndexPathManager()

Retrieves and returns the index path manager instance

Returns:

index path manager

getAttachmentPathManager

public static AttachmentPathManager getAttachmentPathManager()

Retrieves and returns the attachment path instance

Returns:

attachment path manager

getTranslationManager

public static TranslationManager getTranslationManager()

Retrieves and returns the translation manager instance

Returns:

translation manager

getWatcherManager

public static WatcherManager getWatcherManager()

Retrieves and returns the watcher manager instance

Returns:

watcher manager

getFieldScreenManager

public static FieldScreenManager getFieldScreenManager()

Retrieves and returns the field screen manager instance

Returns:

field screen manager

getMailServerManager

public static com.atlassian.mail.server.MailServerManager getMailServerManager()

Retrieves and returns the mail server manager instance

Returns:

mail server manager

getProjectComponentManager

public static ProjectComponentManager getProjectComponentManager()

Retrieves and returns the project component manager instance

Returns:

project component manager

getChangeHistoryManager

public static ChangeHistoryManager getChangeHistoryManager()

Retrieves and returns the ChangeHistoryManager manager instance

Returns:

ChangeHistoryManager

getUserPreferencesManager

public static UserPreferencesManager getUserPreferencesManager()

Retrieves and returns the user preferences manager instance

Returns:

user preferences manager

getUserPropertyManager

public static UserPropertyManager getUserPropertyManager()

Retrieves and returns the user preferences manager instance

Returns:

user preferences manager

getAvatarManager

public static AvatarManager getAvatarManager()

getMailQueue

public static com.atlassian.mail.queue.MailQueue getMailQueue()

getNotificationSchemeManager

public static NotificationSchemeManager getNotificationSchemeManager()

getPermissionSchemeManager

public static PermissionSchemeManager getPermissionSchemeManager()

getScheduler

public static org.quartz.Scheduler getScheduler()

getIssueSecurityLevelManager

public static IssueSecurityLevelManager getIssueSecurityLevelManager()

getServiceManager

public static ServiceManager getServiceManager()

getSubscriptionManager

public static SubscriptionManager getSubscriptionManager()

getLocaleManager

public static LocaleManager getLocaleManager()

getOptionsManager

public static OptionsManager getOptionsManager()

initialiseWorker

public static ComponentAccessor.Worker initialiseWorker(ComponentAccessor.Worker componentAccessorWorker)