Package com.atlassian.jira.project

Class CachingProjectManager

java.lang.Object
com.atlassian.jira.project.AbstractProjectManager
com.atlassian.jira.project.CachingProjectManager
All Implemented Interfaces:
InitializingComponent, ProjectManager
public class CachingProjectManager extends AbstractProjectManager implements ProjectManager, InitializingComponent

  • Constructor Details

  • Method Details

    • afterInstantiation

      public void afterInstantiation() throws Exception
      Description copied from interface: InitializingComponent
      Called after all the beans are constructed and the ApplicationContext is fully populated. Order of execution is order of bean creation, driven by InitializingComponentProcessor.
      Specified by:
      afterInstantiation in interface InitializingComponent
      Throws:
      Exception

    • onClearCache

      @EventListener public void onClearCache(ClearCacheEvent event)

    • onProjectFKChangedEvent

      @EventListener public void onProjectFKChangedEvent(ProjectFKChangedEvent 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.
      Specified by:
      getNextId in interface ProjectManager
      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.
      Specified by:
      refresh in interface ProjectManager

    • getProjectObj

      public Project getProjectObj(Long id)
      Description copied from interface: ProjectManager
      Retrieves a single Project by its id.
      Specified by:
      getProjectObj in interface ProjectManager
      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.
      Specified by:
      getProjectObjByKey in interface ProjectManager
      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:

    • 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.
      Specified by:
      getProjectByCurrentKeyIgnoreCase in interface ProjectManager
      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.
      Specified by:
      getProjectObjByKeyIgnoreCase in interface ProjectManager
      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.
      Specified by:
      getAllProjectKeys in interface ProjectManager
      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.
      Specified by:
      getProjectObjByName in interface ProjectManager
      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 active Projects ordered by name. A project is considered active if it is not archived.
      Specified by:
      getProjects in interface ProjectManager
      Returns:
      all active projects ordered by name.

    • getArchivedProjects

      @Nonnull public List<Project> getArchivedProjects()
      Description copied from interface: ProjectManager
      Return archived Projects ordered by name.
      Specified by:
      getArchivedProjects in interface ProjectManager
      Returns:
      all projects ordered by name.

    • getProjectObjects

      @Nonnull public List<Project> getProjectObjects()
      Description copied from interface: ProjectManager
      Return all active Projects ordered by name. A project is considered active if it is not archived.

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

      Specified by:
      getProjectObjects in interface ProjectManager
      Returns:
      all projects ordered by name.
      See Also:

    • getProjectCount

      public long getProjectCount() throws DataAccessException
      Description copied from interface: ProjectManager
      Return the total number of Projects.
      Specified by:
      getProjectCount in interface ProjectManager
      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.

      Specified by:
      createProject in interface ProjectManager
      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:

    • updateProject

      public Project updateProject(UpdateProjectParameters parameters)
      Description copied from interface: ProjectManager
      Updates the project with the given changes.
      Specified by:
      updateProject in interface ProjectManager
      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.
      Specified by:
      updateProject in interface ProjectManager
      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.
      Specified by:
      updateProjectType in interface ProjectManager
      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.
      Specified by:
      removeProjectIssues in interface ProjectManager
      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.
      Specified by:
      removeProjectIssues in interface ProjectManager
      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.
      Specified by:
      removeProject in interface ProjectManager
      Parameters:
      project - The project to be deleted.

    • getAllProjectCategories

      public Collection<ProjectCategory> getAllProjectCategories()
      Description copied from interface: ProjectManager
      Returns all ProjectCategories, ordered by name.
      Specified by:
      getAllProjectCategories in interface ProjectManager
      Returns:
      all ProjectCategories, ordered by name.

    • getProjectCategory

      public ProjectCategory getProjectCategory(Long id)
      Description copied from interface: ProjectManager
      Returns a single project category by id.
      Specified by:
      getProjectCategory in interface ProjectManager
      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)

      Specified by:
      getProjectCategoryObject in interface ProjectManager
      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.
      Specified by:
      updateProjectCategory in interface ProjectManager
      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.
      Specified by:
      getProjectsFromProjectCategory in interface ProjectManager
      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.
      Specified by:
      getProjectObjectsFromProjectCategory in interface ProjectManager
      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.
      Specified by:
      getProjectCategoryForProject in interface ProjectManager
      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
      Specified by:
      getProjectObjectsWithNoCategory in interface ProjectManager
      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.
      Specified by:
      setProjectCategory in interface ProjectManager
      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.
      Specified by:
      getProjectsLeadBy in interface ProjectManager
      Parameters:
      leadUser - Project Lead
      Returns:
      A collection of projects

    • getProjectsCreatedBy

      public List<Project> getProjectsCreatedBy(ApplicationUser projectCreator)
      Description copied from interface: ProjectManager
      Retrieves all projects created by a specified user, sorted by the project's name.
      Specified by:
      getProjectsCreatedBy in interface ProjectManager
      Parameters:
      projectCreator - The user who created the projects.
      Returns:
      A list of projects created by the specified user, ordered by project name.

    • removeProjectsCreator

      public void removeProjectsCreator(Collection<Project> projects)
      Description copied from interface: ProjectManager
      Removes the creator id from a collection of projects, used when a user is deleted.
      Specified by:
      removeProjectsCreator in interface ProjectManager
      Parameters:
      projects - A collection of projects from which the creator information should be removed.

    • getProjectsLastUpdatedBy

      public List<Project> getProjectsLastUpdatedBy(ApplicationUser projectUpdater)
      Description copied from interface: ProjectManager
      Retrieves all projects last updated by a specified user, sorted by the project's name.
      Specified by:
      getProjectsLastUpdatedBy in interface ProjectManager
      Parameters:
      projectUpdater - The user who last updated the projects.
      Returns:
      A list of projects last updated by the specified user, ordered by project name.

    • removeProjectsUpdater

      public void removeProjectsUpdater(Collection<Project> projects)
      Description copied from interface: ProjectManager
      Removes the last updater id from a collection of projects, used when a user is deleted.
      Specified by:
      removeProjectsUpdater in interface ProjectManager
      Parameters:
      projects - A collection of projects from which the updater information should be removed.

    • clearCreatedByForUserInProjects

      public void clearCreatedByForUserInProjects(@Nonnull ApplicationUser user)
      Description copied from interface: ProjectManager
      Clears the 'createdby' field from all projects that were created by the specified user. This method is typically used when a user is deleted from the system, ensuring that their identifier is removed from the projects they created.
      Specified by:
      clearCreatedByForUserInProjects in interface ProjectManager
      Parameters:
      user - The user whose identifier should be cleared from the 'createdby' field in projects.

    • clearLastUpdatedByForUserInProjects

      public void clearLastUpdatedByForUserInProjects(@Nonnull ApplicationUser user)
      Description copied from interface: ProjectManager
      Clears the 'updatedby' field from all projects that were last updated by the specified user. This method is typically used when a user is deleted from the system, ensuring that their identifier is removed from the projects they updated.
      Specified by:
      clearLastUpdatedByForUserInProjects in interface ProjectManager
      Parameters:
      user - The user whose identifier should be cleared from the 'updatedby' field in projects.

    • createProjectCategory

      public ProjectCategory createProjectCategory(String name, String description)
      Description copied from interface: ProjectManager
      Creates a new ProjectCategory with the given name and description.
      Specified by:
      createProjectCategory in interface ProjectManager
      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.
      Specified by:
      removeProjectCategory in interface ProjectManager
      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.
      Specified by:
      isProjectCategoryUnique in interface ProjectManager
      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.
      Specified by:
      getCurrentCounterForProject in interface ProjectManager
      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.
      Specified by:
      setCurrentCounterForProject in interface ProjectManager
      Parameters:
      project - the project for which to set the counter (required)
      counter - the counter value to set