com.atlassian.jira.config

Class DefaultConstantsManager

java.lang.Object

com.atlassian.jira.config.DefaultConstantsManager

All Implemented Interfaces:

ConstantsManager

public class DefaultConstantsManager
extends Object
implements ConstantsManager

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.config.ConstantsManager

ConstantsManager.CONSTANT_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_NAME_LENGTH

Fields inherited from interface com.atlassian.jira.config.ConstantsManager

ALL_ISSUE_TYPES, ALL_STANDARD_ISSUE_TYPES, ALL_SUB_TASK_ISSUE_TYPES, ISSUE_CONSTANT_NAME_SEARCH_PATTERN, ISSUE_TYPE_CONSTANT_TYPE, PRIORITY_CONSTANT_TYPE, RESOLUTION_CONSTANT_TYPE, STATUS_CONSTANT_TYPE

Constructor Summary

Constructors

Constructor and Description
DefaultConstantsManager(JiraAuthenticationContext authenticationContext, OfBizDelegator ofBizDelegator, DbConnectionManager dbConnectionManager, IssueConstantFactory issueConstantFactory, com.atlassian.cache.CacheManager cacheManager, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
boolean	constantExists(String constantType, String name) Checks if a constant exists.
List<String>	expandIssueTypeIds(Collection<String> issueTypeIds) Converts the 'special' ids of issue types to a list of issue type ids For example, converts a special id to a list of all sub-task issue types Also see ConstantsManager.ALL_STANDARD_ISSUE_TYPES, ConstantsManager.ALL_SUB_TASK_ISSUE_TYPES and ConstantsManager.ALL_ISSUE_TYPES.
List<String>	getAllIssueTypeIds() Returns all issueType Ids.
Collection<IssueType>	getAllIssueTypeObjects() Returns a list of IssueTypes.
IssueConstant	getConstantByNameIgnoreCase(String constantType, String name) Returns a constant by name ignoring the case of the name passed in.
IssueConstant	getConstantObject(String constantType, String id) Returns an IssueConstant object for the given type & id.
Collection<? extends IssueConstant>	getConstantObjects(String constantType) Returns all IssueConstant objects for the given type.
List<IssueConstant>	getConstantsByIds(ConstantsManager.CONSTANT_TYPE constantType, Collection<String> ids) Converts the list of ids to the objects of appropriate types
Priority	getDefaultPriority() Returns the default priority configured in JIRA.
List<IssueType>	getEditableSubTaskIssueTypes() Retrieves an mutable list of sub-task issues.
IssueConstant	getIssueConstant(org.ofbiz.core.entity.GenericValue issueConstantGV) Converts a constant GenericValue to an IssueConstant object.
IssueConstant	getIssueConstantByName(String constantType, String name) Returns a constant by name.
IssueType	getIssueType(String id) Given an IssueType ID this method retrieves that IssueType.
Collection<Priority>	getPriorities() Retrieve all Priorities in JIRA.
String	getPriorityName(String id) Returns the priority Name for a given priority ID.
Priority	getPriorityObject(String id) Given a priority ID, this method retrieves that priority.
Collection<IssueType>	getRegularIssueTypeObjects() Retrieve regular (non-subtask) issue types.
Resolution	getResolution(String id) Given a resolution ID, this method retrieves that resolution.
Collection<Resolution>	getResolutions() Retrieve all Resolutions in JIRA.
Status	getStatus(String id) Returns a Status given an id.
Status	getStatusByName(String name) Searches for a given status by name.
Status	getStatusByNameIgnoreCase(String name) Searches for a given status by name ignoring case.
Status	getStatusByTranslatedName(String name) Searches for a given status by its translated name.
Collection<Status>	getStatuses() Returns all statuses
Collection<IssueType>	getSubTaskIssueTypeObjects() Retrieves all the sub-task issue types
IssueType	insertIssueType(String name, Long sequence, String style, String description, Long avatarId) Creates a new IssueType.
IssueType	insertIssueType(String name, Long sequence, String style, String description, String iconurl) Creates a new IssueType.
void	invalidate(IssueConstant constant) Clear the cache for this Issue Constant.
void	invalidateAll() Sets all cached copies of constants to null.
void	onClearCache(ClearCacheEvent ignored)
void	onIssueTypeDeleted(IssueTypeDeletedEvent event)
void	recalculateIssueTypeSequencesAndStore(List<IssueType> issueTypes) Resequences the supplied issuetypes into sequential order.
void	recalculatePrioritySequencesAndStore(List<Priority> priorities) Resequences the supplied priorities into sequential order.
void	recalculateResolutionSequencesAndStore(List<Resolution> resolutions) Resequences the supplied resolutions into sequential order.
void	recalculateStatusSequencesAndStore(List<Status> statuses) Resequences the supplied statuses into sequential order.
void	refreshIssueTypes() Reloads all IssueTypes from the DB.
void	refreshPriorities() Reloads all priorities from the DB.
void	refreshResolutions() Reloads all resolutions from the DB.
void	refreshStatuses() Reloads all statuses from DB.
void	removeIssueType(String id) Removes an existing issueType.
void	storeIssueTypes(List<org.ofbiz.core.entity.GenericValue> issueTypes) Bulk operation to store a list of issueTypes.
void	updateIssueType(String id, String name, Long sequence, String style, String description, Long avatarId) Updates an existing issueType.
void	updateIssueType(String id, String name, Long sequence, String style, String description, String iconurl) Updates an existing issueType.
void	validateCreateIssueType(String name, String style, String description, String iconurl, ErrorCollection errors, String nameFieldName) Validates creation of a new issuetype.
void	validateCreateIssueTypeWithAvatar(String name, String style, String description, String avatarId, ErrorCollection errors, String nameFieldName) Validates creation of a new issuetype.
io.atlassian.fugue.Option<Pair<String,ErrorCollection.Reason>>	validateName(String name, io.atlassian.fugue.Option<IssueType> issueTypeToUpdate) Validates the name of issue type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.config.ConstantsManager

createIssueConstantNameSearchPattern, getStatusObject

Field Detail

MAX_NAME_LENGTH

public static final int MAX_NAME_LENGTH

See Also:

Constant Field Values

Constructor Detail

DefaultConstantsManager

public DefaultConstantsManager(JiraAuthenticationContext authenticationContext,
                               OfBizDelegator ofBizDelegator,
                               DbConnectionManager dbConnectionManager,
                               IssueConstantFactory issueConstantFactory,
                               com.atlassian.cache.CacheManager cacheManager,
                               com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent ignored)

onIssueTypeDeleted

@EventListener
public void onIssueTypeDeleted(IssueTypeDeletedEvent event)

getStatuses

public Collection<Status> getStatuses()

Description copied from interface: ConstantsManager

Returns all statuses

Specified by:

getStatuses in interface ConstantsManager

Returns:

Returns a Collection of status Statuss.

getStatus

public Status getStatus(String id)

Description copied from interface: ConstantsManager

Returns a Status given an id.

Specified by:

getStatus in interface ConstantsManager

Parameters:

id - The id of a status

Returns:

Returns a status

refreshStatuses

public void refreshStatuses()

Description copied from interface: ConstantsManager

Reloads all statuses from DB.

Specified by:

refreshStatuses in interface ConstantsManager

getConstantObject

@Nullable
public IssueConstant getConstantObject(String constantType,
                                                 String id)

Description copied from interface: ConstantsManager

Returns an IssueConstant object for the given type & id.

Specified by:

getConstantObject in interface ConstantsManager

Parameters:

constantType - See ConstantsManager.CONSTANT_TYPE

id - The id of the constant.

Returns:

A IssueConstant object. Null if it doesn't exist.

getConstantObjects

@Nullable
public Collection<? extends IssueConstant> getConstantObjects(String constantType)

Description copied from interface: ConstantsManager

Returns all IssueConstant objects for the given type.

Specified by:

getConstantObjects in interface ConstantsManager

Parameters:

constantType - See ConstantsManager.CONSTANT_TYPE

Returns:

A collection of IssueConstant object; will be null if and only if constantType is invalid

getConstantsByIds

@Nonnull
public List<IssueConstant> getConstantsByIds(@Nonnull
                                                      ConstantsManager.CONSTANT_TYPE constantType,
                                                      @Nonnull
                                                      Collection<String> ids)

Description copied from interface: ConstantsManager

Converts the list of ids to the objects of appropriate types

Specified by:

getConstantsByIds in interface ConstantsManager

Parameters:

constantType - Type of constant

ids - list of constant ids

Returns:

List of IssueConstant subclasses.

constantExists

public boolean constantExists(String constantType,
                              String name)

Description copied from interface: ConstantsManager

Checks if a constant exists.

Specified by:

constantExists in interface ConstantsManager

Parameters:

constantType - See ConstantsManager.PRIORITY_CONSTANT_TYPE, ConstantsManager.STATUS_CONSTANT_TYPE, ConstantsManager.RESOLUTION_CONSTANT_TYPE, ConstantsManager.ISSUE_TYPE_CONSTANT_TYPE

name - The name of the constant.

Returns:

True if the constant exists. False otherwise

getIssueConstantByName

public IssueConstant getIssueConstantByName(String constantType,
                                            String name)

Description copied from interface: ConstantsManager

Returns a constant by name.

Specified by:

getIssueConstantByName in interface ConstantsManager

Parameters:

constantType - See ConstantsManager.PRIORITY_CONSTANT_TYPE, ConstantsManager.STATUS_CONSTANT_TYPE, ConstantsManager.RESOLUTION_CONSTANT_TYPE, ConstantsManager.ISSUE_TYPE_CONSTANT_TYPE

name - The Name of the constant.

Returns:

The IssueConstant

getConstantByNameIgnoreCase

public IssueConstant getConstantByNameIgnoreCase(String constantType,
                                                 String name)

Description copied from interface: ConstantsManager

Returns a constant by name ignoring the case of the name passed in.

Specified by:

getConstantByNameIgnoreCase in interface ConstantsManager

Parameters:

constantType - See ConstantsManager.PRIORITY_CONSTANT_TYPE, ConstantsManager.STATUS_CONSTANT_TYPE, ConstantsManager.RESOLUTION_CONSTANT_TYPE, ConstantsManager.ISSUE_TYPE_CONSTANT_TYPE

name - The Name of the constant, case-insensitive.

Returns:

An IssueConstant (or null if not found)

insertIssueType

public IssueType insertIssueType(String name,
                                 Long sequence,
                                 String style,
                                 String description,
                                 String iconurl)
                          throws CreateException

Description copied from interface: ConstantsManager

Creates a new IssueType.

Note this method does not validate the input - i.e. It does not check for duplicate names etc. Use this method in conjunction with ConstantsManager.validateCreateIssueType(String, String, String, String, com.atlassian.jira.util.ErrorCollection, String)

Specified by:

insertIssueType in interface ConstantsManager

Parameters:

name - Name of the new IssueType

sequence - Sequence number used for ordering the issuetypes in the UI.

style - Used to record the type of issue, such as SUBTASK. Null for regular issues.

description - A short description of the new issue type.

iconurl - A URL to an icon to be used for the new issueType.

Returns:

The newly created IssueType

Throws:

CreateException - If there is an error creating this Issue Type.

insertIssueType

public IssueType insertIssueType(String name,
                                 Long sequence,
                                 String style,
                                 String description,
                                 Long avatarId)
                          throws CreateException

Description copied from interface: ConstantsManager

Creates a new IssueType.

Note this method does not validate the input - i.e. It does not check for duplicate names etc. Use this method in conjunction with ConstantsManager.validateCreateIssueType(String, String, String, String, com.atlassian.jira.util.ErrorCollection, String)

Specified by:

insertIssueType in interface ConstantsManager

Parameters:

name - Name of the new IssueType

sequence - Sequence number used for ordering the issuetypes in the UI.

style - Used to record the type of issue, such as SUBTASK. Null for regular issues.

description - A short description of the new issue type.

avatarId - Avatar id,

Returns:

The newly created IssueType

Throws:

CreateException - If there is an error creating this Issue Type.

validateCreateIssueType

public void validateCreateIssueType(String name,
                                    String style,
                                    String description,
                                    String iconurl,
                                    ErrorCollection errors,
                                    String nameFieldName)

Description copied from interface: ConstantsManager

Validates creation of a new issuetype. In particular, this function checks that a name has been submitted, no other issueTypes with the same name exist, and that the icon URL exists.

Specified by:

validateCreateIssueType in interface ConstantsManager

Parameters:

name - Name of the new IssueType

style - Used to record the type of issue, such as SUBTASK. Null for regular issues.

description - A short description of the new issue type.

iconurl - A URL to an icon to be used for the new issueType.

errors - A collection of errors used to pass back any problems.

nameFieldName - The field to which the errors should be added.

validateName

public io.atlassian.fugue.Option<Pair<String,ErrorCollection.Reason>> validateName(String name,
                                                                                   io.atlassian.fugue.Option<IssueType> issueTypeToUpdate)

Description copied from interface: ConstantsManager

Validates the name of issue type. If the validation passes returns Option.none, else returns na Option with a pair of error message and reason.

Specified by:

validateName in interface ConstantsManager

validateCreateIssueTypeWithAvatar

public void validateCreateIssueTypeWithAvatar(String name,
                                              String style,
                                              String description,
                                              String avatarId,
                                              ErrorCollection errors,
                                              String nameFieldName)

Description copied from interface: ConstantsManager

Validates creation of a new issuetype. In particular, this function checks that a name has been submitted, no other issueTypes with the same name exist and correct avatarId is passed.

Specified by:

validateCreateIssueTypeWithAvatar in interface ConstantsManager

Parameters:

name - Name of the new IssueType

style - Used to record the type of issue, such as SUBTASK. Null for regular issues.

description - A short description of the new issue type.

avatarId - An avatar id.

errors - A collection of errors used to pass back any problems.

nameFieldName - The field to which the errors should be added.

updateIssueType

public void updateIssueType(String id,
                            String name,
                            Long sequence,
                            String style,
                            String description,
                            String iconurl)
                     throws DataAccessException

Description copied from interface: ConstantsManager

Updates an existing issueType. This will cause a invalidate of all issue types (i.e. reload from the DB).

Specified by:

updateIssueType in interface ConstantsManager

Parameters:

id - ID of the existing issuetype.

name - Name of the new IssueType

sequence - Sequence number used for ordering the issuetypes in the UI.

style - Used to record the type of issue, such as SUBTASK. Null for regular issues.

description - A short description of the new issue type.

iconurl - A URL to an icon to be used for the new issueType.

Throws:

DataAccessException - indicates an error in the Data Access Layer

updateIssueType

public void updateIssueType(String id,
                            String name,
                            Long sequence,
                            String style,
                            String description,
                            Long avatarId)
                     throws DataAccessException

Description copied from interface: ConstantsManager

Updates an existing issueType. This will cause a invalidate of all issue types (i.e. reload from the DB).

Specified by:

updateIssueType in interface ConstantsManager

Parameters:

id - ID of the existing issuetype.

name - Name of the new IssueType

sequence - Sequence number used for ordering the issuetypes in the UI.

style - Used to record the type of issue, such as SUBTASK. Null for regular issues.

description - A short description of the new issue type.

avatarId - avatarid of new issueType.

Throws:

DataAccessException - indicates an error in the Data Access Layer

removeIssueType

public void removeIssueType(String id)
                     throws RemoveException

Description copied from interface: ConstantsManager

Removes an existing issueType. This will cause a invalidate of all issue types (i.e. reload from the DB).

THIS METHOD IS BROKEN AND SHOULD NEVER BE USED SINCE v5.0.

Specified by:

removeIssueType in interface ConstantsManager

Parameters:

id - ID of an existing issueType

Throws:

RemoveException - if the issueType with id doesn't exist, or an error occurred removing the issue.

recalculateIssueTypeSequencesAndStore

public void recalculateIssueTypeSequencesAndStore(List<IssueType> issueTypes)

Description copied from interface: ConstantsManager

Resequences the supplied issuetypes into sequential order.

Specified by:

recalculateIssueTypeSequencesAndStore in interface ConstantsManager

recalculatePrioritySequencesAndStore

public void recalculatePrioritySequencesAndStore(List<Priority> priorities)

Description copied from interface: ConstantsManager

Resequences the supplied priorities into sequential order.

Specified by:

recalculatePrioritySequencesAndStore in interface ConstantsManager

recalculateStatusSequencesAndStore

public void recalculateStatusSequencesAndStore(List<Status> statuses)

Description copied from interface: ConstantsManager

Resequences the supplied statuses into sequential order.

Specified by:

recalculateStatusSequencesAndStore in interface ConstantsManager

recalculateResolutionSequencesAndStore

public void recalculateResolutionSequencesAndStore(List<Resolution> resolutions)

Description copied from interface: ConstantsManager

Resequences the supplied resolutions into sequential order.

Specified by:

recalculateResolutionSequencesAndStore in interface ConstantsManager

storeIssueTypes

public void storeIssueTypes(List<org.ofbiz.core.entity.GenericValue> issueTypes)
                     throws DataAccessException

Description copied from interface: ConstantsManager

Bulk operation to store a list of issueTypes.

Specified by:

storeIssueTypes in interface ConstantsManager

Parameters:

issueTypes - A list of IssueType GenericValues

Throws:

DataAccessException - indicates an error in the Data Access Layer

invalidateAll

public void invalidateAll()

Description copied from interface: ConstantsManager

Sets all cached copies of constants to null. This will cause them to be re-loaded from the DB the next time they are accessed.

Specified by:

invalidateAll in interface ConstantsManager

invalidate

public void invalidate(IssueConstant constant)

Description copied from interface: ConstantsManager

Clear the cache for this Issue Constant. Implementations may clear additional IssueConstants at their discretion.

Specified by:

invalidate in interface ConstantsManager

expandIssueTypeIds

public List<String> expandIssueTypeIds(Collection<String> issueTypeIds)

Description copied from interface: ConstantsManager

Converts the 'special' ids of issue types to a list of issue type ids For example, converts a special id to a list of all sub-task issue types Also see ConstantsManager.ALL_STANDARD_ISSUE_TYPES, ConstantsManager.ALL_SUB_TASK_ISSUE_TYPES and ConstantsManager.ALL_ISSUE_TYPES.

Specified by:

expandIssueTypeIds in interface ConstantsManager

Parameters:

issueTypeIds - A collection of the issuetype Ids to retrieve.

Returns:

A list of "actual" IssueType ID's expanded from the macro constants (or a new copy of the original list if it doesn't contain macros).

getAllIssueTypeIds

public List<String> getAllIssueTypeIds()

Description copied from interface: ConstantsManager

Returns all issueType Ids.

Specified by:

getAllIssueTypeIds in interface ConstantsManager

Returns:

A list of all the IssueType Ids.

getIssueConstant

public IssueConstant getIssueConstant(org.ofbiz.core.entity.GenericValue issueConstantGV)

Description copied from interface: ConstantsManager

Converts a constant GenericValue to an IssueConstant object.

Specified by:

getIssueConstant in interface ConstantsManager

Parameters:

issueConstantGV - the constant GenericValue.

Returns:

An IssueConstant object.

getPriorities

@Nonnull
public Collection<Priority> getPriorities()

Description copied from interface: ConstantsManager

Retrieve all Priorities in JIRA.

Specified by:

getPriorities in interface ConstantsManager

Returns:

A list of Priority Prioritys.

getPriorityObject

public Priority getPriorityObject(String id)

Description copied from interface: ConstantsManager

Given a priority ID, this method retrieves that priority.

Specified by:

getPriorityObject in interface ConstantsManager

Parameters:

id - The id of the priority

Returns:

A Priority object.

getDefaultPriority

public Priority getDefaultPriority()

Description copied from interface: ConstantsManager

Returns the default priority configured in JIRA.

Specified by:

getDefaultPriority in interface ConstantsManager

Returns:

The default priority

getPriorityName

public String getPriorityName(String id)

Description copied from interface: ConstantsManager

Returns the priority Name for a given priority ID.

Specified by:

getPriorityName in interface ConstantsManager

Parameters:

id - the id of a priority

Returns:

the name of the priority with the given id, or an i18n'd String indicating that no priority is set (e.g. "None") if the id is null.

refreshPriorities

public void refreshPriorities()

Description copied from interface: ConstantsManager

Reloads all priorities from the DB.

Specified by:

refreshPriorities in interface ConstantsManager

getResolutions

@Nonnull
public Collection<Resolution> getResolutions()

Description copied from interface: ConstantsManager

Retrieve all Resolutions in JIRA.

Specified by:

getResolutions in interface ConstantsManager

Returns:

A List of Resolution Resolutions.

getResolution

public Resolution getResolution(String id)

Description copied from interface: ConstantsManager

Given a resolution ID, this method retrieves that resolution.

Specified by:

getResolution in interface ConstantsManager

Parameters:

id - The id of the resolution

Returns:

A resolution

refreshResolutions

public void refreshResolutions()

Description copied from interface: ConstantsManager

Reloads all resolutions from the DB.

Specified by:

refreshResolutions in interface ConstantsManager

getAllIssueTypeObjects

public Collection<IssueType> getAllIssueTypeObjects()

Description copied from interface: ConstantsManager

Returns a list of IssueTypes.

Specified by:

getAllIssueTypeObjects in interface ConstantsManager

Returns:

A Collection of IssueType objects.

getRegularIssueTypeObjects

public Collection<IssueType> getRegularIssueTypeObjects()

Description copied from interface: ConstantsManager

Retrieve regular (non-subtask) issue types.

Specified by:

getRegularIssueTypeObjects in interface ConstantsManager

Returns:

A collection of IssueTypes

getSubTaskIssueTypeObjects

@Nonnull
public Collection<IssueType> getSubTaskIssueTypeObjects()

Description copied from interface: ConstantsManager

Retrieves all the sub-task issue types

Specified by:

getSubTaskIssueTypeObjects in interface ConstantsManager

Returns:

A Collection of all sub-task IssueTypes.

getStatusByName

public Status getStatusByName(String name)

Description copied from interface: ConstantsManager

Searches for a given status by name. This is not the most efficient implementation. If the name is not found, or the given name is null, then it returns null.

Specified by:

getStatusByName in interface ConstantsManager

Parameters:

name - The name of the status.

Returns:

A Status object with the given name, or null if none found.

getStatusByNameIgnoreCase

public Status getStatusByNameIgnoreCase(String name)

Description copied from interface: ConstantsManager

Searches for a given status by name ignoring case. This is not the most efficient implementation. If the name is not found, or the given name is null, then it returns null.

Specified by:

getStatusByNameIgnoreCase in interface ConstantsManager

Parameters:

name - The name of the status.

Returns:

A Status object with the given name, or null if none found.

getStatusByTranslatedName

public Status getStatusByTranslatedName(String name)

Description copied from interface: ConstantsManager

Searches for a given status by its translated name. If no matching translated name is found the true (untranslated) name will be tried. If the name is not found, or the given name is null, then it returns null.

Specified by:

getStatusByTranslatedName in interface ConstantsManager

Parameters:

name - The name of the status.

Returns:

A Status object with the given name, or null if none found.

getEditableSubTaskIssueTypes

public List<IssueType> getEditableSubTaskIssueTypes()

Description copied from interface: ConstantsManager

Retrieves an mutable list of sub-task issues. The list is mutable, that is its elements can be reordered added to or removed. The elements of the list, that is the issue types themselves, are not mutable.

Specified by:

getEditableSubTaskIssueTypes in interface ConstantsManager

Returns:

A List of editable sub-task

getIssueType

public IssueType getIssueType(String id)

Description copied from interface: ConstantsManager

Given an IssueType ID this method retrieves that IssueType.

Specified by:

getIssueType in interface ConstantsManager

Parameters:

id - The ID of the IssueType.

Returns:

An IssueType

refreshIssueTypes

public void refreshIssueTypes()

Description copied from interface: ConstantsManager

Reloads all IssueTypes from the DB.

Specified by:

refreshIssueTypes in interface ConstantsManager