com.atlassian.jira.project

Class CachingProjectManager

java.lang.Object

com.atlassian.jira.project.AbstractProjectManager

com.atlassian.jira.project.CachingProjectManager

All Implemented Interfaces:

ProjectManager

public class CachingProjectManager
extends AbstractProjectManager

Constructor Summary

Constructors

Constructor and Description
CachingProjectManager(ProjectManager delegateProjectManager, ProjectComponentManager projectComponentManager, ProjectFactory projectFactory, UserManager userManager, ApplicationProperties applicationProperties, ProjectKeyStore projectKeyStore, com.atlassian.cache.CacheManager cacheManager, NodeAssociationStore nodeAssociationStore)

Method Summary

Modifier and Type	Method and Description
Project	createProject(ApplicationUser user, ProjectCreationData projectCreationData) Creates the project in the database, and adds default project roles for this project.
ProjectCategory	createProjectCategory(String name, String description) Creates a new ProjectCategory with the given name and description.
Collection<ProjectCategory>	getAllProjectCategories() Returns all ProjectCategories, ordered by name.
Set<String>	getAllProjectKeys(Long projectId) Returns all project keys that are associated with Project.
List<Project>	getArchivedProjects() Return archived Projects ordered by name.
long	getCurrentCounterForProject(Long id) Returns the curremt issue counter for the given project.
long	getNextId(Project project) Get the next issue ID from this project (transactional).
Project	getProjectByCurrentKey(String projectKey) Returns the Project with the given project key.
Project	getProjectByCurrentKeyIgnoreCase(String projectKey) Returns a Project object based on the passed in project key, not taking into account the case of the project key.
ProjectCategory	getProjectCategory(Long id) Returns a single project category by id.
ProjectCategory	getProjectCategoryForProject(Project project) Returns a project's category.
ProjectCategory	getProjectCategoryObject(Long id) Returns a single project category by id.
long	getProjectCount() Return the total number of Projects.
Project	getProjectObj(Long id) Retrieves a single Project by its id.
Project	getProjectObjByKey(String projectKey) Returns a Project object based on the passed in project key.
Project	getProjectObjByKeyIgnoreCase(String projectKey) Returns a Project object based on the passed in project key, not taking into account the case of the project key.
Project	getProjectObjByName(String projectName) Returns a Project object based on the passed in project name.
List<Project>	getProjectObjects() Return all open Projects ordered by name.
Collection<Project>	getProjectObjectsFromProjectCategory(Long projectCategoryId) Returns a list of projects in a particular category.
Collection<Project>	getProjectObjectsWithNoCategory() Returns a list of projects without project category, sorted by project name
List<Project>	getProjects() Return all Projects ordered by name.
Collection<Project>	getProjectsFromProjectCategory(ProjectCategory projectCategory) Returns a list of projects in a particular category.
List<Project>	getProjectsLeadBy(ApplicationUser leadUser) Returns all the projects that leadUser is the project lead for ordered by the name of the Project.
boolean	isProjectCategoryUnique(String projectCategory) Checks if a project category with a given name exists.
protected static <T> Collection<T>	noNull(Collection<T> col)
void	onClearCache(ClearCacheEvent event)
void	refresh() Causes a full refresh of the project cache.
void	removeProject(Project project) Deletes the provided project from the database.
void	removeProjectCategory(Long id) Removes the given ProjectCategory.
void	removeProjectIssues(Project project) Removes all issues for a particular project.
void	removeProjectIssues(Project project, Context taskContext) Removes all issues for a particular project.
void	setCurrentCounterForProject(Project project, long counter) Set the project counter.
void	setProjectCategory(Project project, ProjectCategory category) Sets a project's category.
void	updateCache()
Project	updateProject(Project updatedProject, String name, String description, String leadKey, String url, Long assigneeType, Long avatarId, String projectKey) Updates the project provided with the new attributes passed in.
Project	updateProject(UpdateProjectParameters parameters) Updates the project with the given changes.
void	updateProjectCategory(ProjectCategory projectCategory) Persist an updated project category.
Project	updateProjectType(ApplicationUser user, Project project, ProjectTypeKey newProjectType) Updates the type of a project.

Methods inherited from class com.atlassian.jira.project.AbstractProjectManager

convertToProjectObjects, getDefaultAssignee, getDefaultAssignee, getProjectCategoryObjectByName, getProjectCategoryObjectByNameIgnoreCase, getProjectsByArgs, updateProject, updateProject

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingProjectManager

public CachingProjectManager(ProjectManager delegateProjectManager,
                             ProjectComponentManager projectComponentManager,
                             ProjectFactory projectFactory,
                             UserManager userManager,
                             ApplicationProperties applicationProperties,
                             ProjectKeyStore projectKeyStore,
                             com.atlassian.cache.CacheManager cacheManager,
                             NodeAssociationStore nodeAssociationStore)

Method Detail

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

updateCache

public void updateCache()

getNextId

public long getNextId(Project project)

Description copied from interface: ProjectManager

Get the next issue ID from this project (transactional). Each project maintains an internal counter for the number of issues. This method may be used to construct a new issue key.

Parameters:

project - The Project

Returns:

A long value representing a new issue id for the project.

refresh

public void refresh()

Description copied from interface: ProjectManager

Causes a full refresh of the project cache.

getProjectObj

public Project getProjectObj(Long id)

Description copied from interface: ProjectManager

Retrieves a single Project by its id.

Parameters:

id - ID of the Project.

Returns:

Project object or null if project with that id doesn't exist.

getProjectObjByKey

public Project getProjectObjByKey(String projectKey)

Description copied from interface: ProjectManager

Returns a Project object based on the passed in project key.

Parameters:

projectKey - the Project key.

Returns:

the Project object specified by the key or null

getProjectByCurrentKey

public Project getProjectByCurrentKey(String projectKey)

Description copied from interface: ProjectManager

Returns the Project with the given project key.

This method will strictly only return the project whose current project key is the one given.

This method is added to the API in anticipation of being able to edit the project key, but this feature has not actually been added in 6.0.

Specified by:

getProjectByCurrentKey in interface ProjectManager

Overrides:

getProjectByCurrentKey in class AbstractProjectManager

Parameters:

projectKey - the Project key.

Returns:

the Project with the given project key.

See Also:

ProjectManager.getProjectObjByKey(String)

getProjectByCurrentKeyIgnoreCase

public Project getProjectByCurrentKeyIgnoreCase(String projectKey)

Description copied from interface: ProjectManager

Returns a Project object based on the passed in project key, not taking into account the case of the project key.

Parameters:

projectKey - the project key, case does not matter.

Returns:

the project object specified by the key or null if no such project exists.

getProjectObjByKeyIgnoreCase

public Project getProjectObjByKeyIgnoreCase(String projectKey)

Description copied from interface: ProjectManager

Returns a Project object based on the passed in project key, not taking into account the case of the project key. Matches also by previous keys that were associated with a project.

Parameters:

projectKey - the project key, case does not matter.

Returns:

the project object specified by the key or null if no such project exists.

getAllProjectKeys

public Set<String> getAllProjectKeys(Long projectId)

Description copied from interface: ProjectManager

Returns all project keys that are associated with Project.

Returns:

all project keys (including the current one) associated with the project

getProjectObjByName

public Project getProjectObjByName(String projectName)

Description copied from interface: ProjectManager

Returns a Project object based on the passed in project name.

Parameters:

projectName - the name of the project

Returns:

the Project object specified by the supplied name or null

getProjects

@Nonnull
public List<Project> getProjects()

Description copied from interface: ProjectManager

Return all Projects ordered by name.

Returns:

all projects ordered by name.

getArchivedProjects

@Nonnull
public List<Project> getArchivedProjects()

Description copied from interface: ProjectManager

Return archived Projects ordered by name.

Returns:

all projects ordered by name.

getProjectObjects

@Nonnull
public List<Project> getProjectObjects()

Description copied from interface: ProjectManager

Return all open Projects ordered by name.

This method does the same thing as getProjects() and exists for legacy reasons.

Returns:

all projects ordered by name.

See Also:

ProjectManager.getProjects()

getProjectCount

public long getProjectCount()
                     throws DataAccessException

Description copied from interface: ProjectManager

Return the total number of Projects.

Returns:

A long value representing tht total number of projects.

Throws:

DataAccessException - if any errors occur accessing the DB.

noNull

protected static <T> Collection<T> noNull(Collection<T> col)

createProject

public Project createProject(@Nonnull
                             ApplicationUser user,
                             @Nonnull
                             ProjectCreationData projectCreationData)

Description copied from interface: ProjectManager

Creates the project in the database, and adds default project roles for this project.

If no name, key, lead or project type are provided an exception will be thrown.

Parameters:

user - The user creating the project

projectCreationData - An object encapsulating all the data for the project that will get created

Returns:

The newly created project.

See Also:

ProjectCreationData

updateProject

public Project updateProject(UpdateProjectParameters parameters)

Description copied from interface: ProjectManager

Updates the project with the given changes.

Parameters:

parameters - containing the changes to the project that needs to be made.

Returns:

The updated project

updateProject

public Project updateProject(Project updatedProject,
                             String name,
                             String description,
                             String leadKey,
                             String url,
                             Long assigneeType,
                             Long avatarId,
                             String projectKey)

Description copied from interface: ProjectManager

Updates the project provided with the new attributes passed in. This method is responsible for persisting any changes to the database.

Parameters:

updatedProject - The project to be updated.

name - The name for the updated project

description - An optional description for the project

leadKey - The userkey of the lead developer for the project

url - An optional URL for the updated project

assigneeType - The default assignee for issues created in this project. May be either project lead, or unassigned if unassigned issues are enabled.

projectKey - The new project key (not updated if null)

Returns:

The updated project

updateProjectType

public Project updateProjectType(ApplicationUser user,
                                 Project project,
                                 ProjectTypeKey newProjectType)

Description copied from interface: ProjectManager

Updates the type of a project.

Parameters:

user - The user performing the action

project - The project which type needs to be updated

newProjectType - The new project type

Returns:

The updated project

removeProjectIssues

public void removeProjectIssues(Project project)
                         throws RemoveException

Description copied from interface: ProjectManager

Removes all issues for a particular project. A RemoveException will be thrown on any errors removing issues.

Parameters:

project - The project for which issues will be deleted.

Throws:

RemoveException - if there's any errors removing issues

removeProjectIssues

public void removeProjectIssues(Project project,
                                Context taskContext)
                         throws RemoveException

Description copied from interface: ProjectManager

Removes all issues for a particular project. A RemoveException will be thrown on any errors removing issues.

Parameters:

project - The project for which issues will be deleted.

taskContext - A task context for providing progress.

Throws:

RemoveException - if there's any errors removing issues

removeProject

public void removeProject(Project project)

Description copied from interface: ProjectManager

Deletes the provided project from the database. Please note that this method only deletes the project itself and not any related entities. Use ProjectService.deleteProject(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.bc.project.ProjectService.DeleteProjectValidationResult) to properly delete a project.

Parameters:

project - The project to be deleted.

getAllProjectCategories

public Collection<ProjectCategory> getAllProjectCategories()

Description copied from interface: ProjectManager

Returns all ProjectCategories, ordered by name.

Returns:

all ProjectCategories, ordered by name.

getProjectCategory

public ProjectCategory getProjectCategory(Long id)

Description copied from interface: ProjectManager

Returns a single project category by id.

Parameters:

id - ProjectCategory id.

Returns:

the ProjectCategory for the provided id if it was found or else null

getProjectCategoryObject

@Nullable
public ProjectCategory getProjectCategoryObject(Long id)

Description copied from interface: ProjectManager

Returns a single project category by id.

Legacy synonym for ProjectManager.getProjectCategory(Long)

Parameters:

id - Project Category ID.

Returns:

The project category

updateProjectCategory

public void updateProjectCategory(ProjectCategory projectCategory)
                           throws DataAccessException

Description copied from interface: ProjectManager

Persist an updated project category.

Parameters:

projectCategory - project category.

Throws:

DataAccessException - If any errors occur accessing the DB.

getProjectsFromProjectCategory

public Collection<Project> getProjectsFromProjectCategory(ProjectCategory projectCategory)
                                                   throws DataAccessException

Description copied from interface: ProjectManager

Returns a list of projects in a particular category.

Parameters:

projectCategory - project category.

Returns:

A collection of projects sorted by name.

Throws:

DataAccessException - If any errors occur accessing the DB.

getProjectObjectsFromProjectCategory

public Collection<Project> getProjectObjectsFromProjectCategory(Long projectCategoryId)

Description copied from interface: ProjectManager

Returns a list of projects in a particular category.

Parameters:

projectCategoryId - project category id.

Returns:

A collection of project Projects sorted by name.

getProjectCategoryForProject

@Nullable
public ProjectCategory getProjectCategoryForProject(Project project)

Description copied from interface: ProjectManager

Returns a project's category.

Parameters:

project - project

Returns:

A ProjectCategory or null if this project has no category.

getProjectObjectsWithNoCategory

public Collection<Project> getProjectObjectsWithNoCategory()
                                                    throws DataAccessException

Description copied from interface: ProjectManager

Returns a list of projects without project category, sorted by project name

Returns:

A collection of Projects sorted by name

Throws:

DataAccessException - If any errors occur accessing the DB.

setProjectCategory

public void setProjectCategory(Project project,
                               ProjectCategory category)
                        throws DataAccessException

Description copied from interface: ProjectManager

Sets a project's category.

Parameters:

project - project

category - category

Throws:

DataAccessException - If any errors occur accessing the DB.

getProjectsLeadBy

public List<Project> getProjectsLeadBy(ApplicationUser leadUser)

Description copied from interface: ProjectManager

Returns all the projects that leadUser is the project lead for ordered by the name of the Project.

Parameters:

leadUser - Project Lead

Returns:

A collection of projects

createProjectCategory

public ProjectCategory createProjectCategory(String name,
                                             String description)

Description copied from interface: ProjectManager

Creates a new ProjectCategory with the given name and description.

Parameters:

name - the Name

description - the Description.

Returns:

the new ProjectCategory.

removeProjectCategory

public void removeProjectCategory(Long id)

Description copied from interface: ProjectManager

Removes the given ProjectCategory.

Parameters:

id - the ProjectCategory to remove.

isProjectCategoryUnique

public boolean isProjectCategoryUnique(String projectCategory)

Description copied from interface: ProjectManager

Checks if a project category with a given name exists.

Parameters:

projectCategory - the name of the project category

Returns:

if a category with given name exists

getCurrentCounterForProject

public long getCurrentCounterForProject(Long id)

Description copied from interface: ProjectManager

Returns the curremt issue counter for the given project. This value is for information only; you should not use it to predict or create issue ids, because it may change concurrently as new issues are created.

Parameters:

id - the ID of the project for which to retrieve the counter

Returns:

the current project counter (the id of the next issue to be created).

setCurrentCounterForProject

public void setCurrentCounterForProject(Project project,
                                        long counter)

Description copied from interface: ProjectManager

Set the project counter. Warning Setting the project counter is not needed in the normal operations of JIRA, this method exist for functionality like project-import etc.

Parameters:

project - the project for which to set the counter (required)

counter - the counter value to set