Package jetbrains.buildServer.serverSide.impl.auth

Class SecuredProjectManager

java.lang.Object

jetbrains.buildServer.serverSide.impl.auth.SecuredProjectManager

All Implemented Interfaces:

ProjectManager, ProjectManagerEx, ProjectVcsRoots, ProjectVcsRootsEx

public class SecuredProjectManager
extends Object
implements ProjectManagerEx

Author:

Sergey.Anchipolevsky Date: 22.08.2007

Nested Class Summary

Nested classes/interfaces inherited from interface jetbrains.buildServer.serverSide.ProjectManagerEx

ProjectManagerEx.IdsMaps

Field Summary

Fields inherited from interface jetbrains.buildServer.serverSide.ProjectManager

PROJECT_ID_NAME

Fields inherited from interface jetbrains.buildServer.serverSide.ProjectManagerEx

ROOT_PROJECT_DESCRIPTION, ROOT_PROJECT_NAME

Constructor Summary

Constructors

Constructor	Description
SecuredProjectManager(SecurityContextEx securityContext)

Method Summary

Modifier and Type	Method	Description
void	checkCanCreateBuildTypes(SProject targetProject, int numOfBuildTypes)	Checks whether numOfBuildTypes build configurations can be created and throws exception if can't
SProject	copyProject(SProject originalProject, SProject parentOfCopy, CopyOptions options)	Copies the given project with all subprojects into another project.
ProjectEx	createProject(String projectName)	Creates new project with specified name (name is case insensitive).
SProject	createProject(SProject originalProject, String newProjectName, CopyOptions options)	Creates new project by copying all settings from original project.
ProjectEx	createProjectInternal(EntityId<String> parentId, String externalId, String projectName)
File	ensureProjectsDirectoryExists()
void	executeFSOperation(String description, Runnable persistAction)
static List<SProject>	filterProjects(List<SProject> list, Filter<BuildProject> projectFilter)
SBuildType	findBuildTypeByConfigId(String configId)	Searches for a build configuration with specified config id.
BuildTypeEx	findBuildTypeByExternalId(String externalId)	Looks for a build type with the given external id.
BuildTypeEx	findBuildTypeById(String internalId)	Searches for a build configuration with the specified internal id.
BuildTypeIdentity	findBuildTypeIdentityByExternalId(String extId)
BuildTypeIdentity	findBuildTypeIdentityByInternalId(String intId)
Collection<SBuildType>	findBuildTypes(Collection<String> buildTypeIds)	Filters collection of build types by preserving only accessible ones by current user.
Collection<SBuildType>	findBuildTypesByExternalIds(Collection<String> externalIds)	Returns collection of build types corresponding to the specified external ids.
BuildTypeTemplate	findBuildTypeTemplateByConfigId(String configId)	Searches for build type template by given config id.
BuildTypeTemplateEx	findBuildTypeTemplateByExternalId(String externalId)	Searches for build type template by given external id.
BuildTypeTemplateEx	findBuildTypeTemplateById(String id)	Searches for build type template by given internal id
SProject	findProjectByConfigId(String configId)	Looks for a project with the given config id.
ProjectEx	findProjectByExternalId(String externalId)	Looks for a project with the given external id.
ProjectEx	findProjectById(String projectId)	Looks for a project with the given internal id.
SProject	findProjectByName(String projectName)	Searches for a project with the specified name (case insensitive) among direct subprojects of the root project.
String	findProjectExternalId(String buildTypeId)	Searches for a project which contains a build type with the specified build type id.
String	findProjectId(String buildTypeId)	Searches for a project which contains a build type with the specified build type id.
String	findProjectIdForTemplate(String buildTypeTemplateId)	Searches for a project which contains a build type template with the specified id.
Collection<SProject>	findProjects(Collection<String> internalIds)	Filters collection of projects by preserving only accessible ones by current user.
Collection<SProject>	findProjectsByExternalIds(Collection<String> externalIds)	Returns collection of projects corresponding to the specified external ids.
Set<String>	findProjectsIds(Collection<String> buildTypeIds)	Accepts a collection of build type ids, returns ids of projects where these build types belong.
SVcsRoot	findVcsRootByConfigId(String configId)	Finds VCS root by config id
SVcsRootEx	findVcsRootByExternalId(String externalId)	Finds VCS root by external id
SVcsRootEx	findVcsRootById(long id)	Finds VCS root by id
SVcsRootEx	findVcsRootByName(String name)
Collection<SVcsRoot>	findVcsRootsByIds(Collection<Long> ids)	Finds all VCS roots having the specified ids.
ProjectManagerEx.IdsMaps	generateDefaultExternalIds(SProject project, String changedExtId, boolean useCurrentIds, boolean generateForCopy)	Generates identifiers for all nested entities (subprojects, VCS roots, build types and templates) of the given project.
List<SBuildType>	getActiveBuildTypes()	Returns the list of build types that belong to non-archived projects only.
List<SProject>	getActiveProjects()	Returns the list of active (non-archived) projects.
List<SBuildType>	getAllBuildTypes()	Returns the list of all build configurations, including ones from archived projects.
List<SBuildType>	getAllBuildTypes(User user)	Returns list of all build configurations sorted by project according to the order specified by user and then by build configuration name.
List<BuildTypeTemplate>	getAllTemplates()	Returns list of all of the templates, including ones from archived projects.
List<SVcsRoot>	getAllVcsRoots()
List<SBuildType>	getArchivedBuildTypes()	Returns list of build configurations from archived projects, sorted by project and build configuration name.
List<SProject>	getArchivedProjects()	Returns the list of archived projects.
Comparator<SBuildType>	getBuildTypesComparator()
Map<SBuildType,List<SArtifactDependency>>	getBuildTypesDependingOn(Collection<SBuildType> types)
SProject	getCommonParentProject(Collection<SProject> projects)	Returns nearest common parent project for all projects in provided collection.
Map<String,List<ProjectEx>>	getDirectSubProjectsMap()	Map where key is parent project internal id and value - all direct subprojects of this parent
Set<String>	getExistingProjectsIds(Collection<String> projectIds)	Accepts a collection of project ids and and checks each of them for existence.
SortedMap<SProject,List<SBuildType>>	getFilteredBuildTypes(User user, BuildTypeFilter filter)	Returns sorted map of build configurations per project.
int	getNumberOfBuildTypes()	Returns the total number of build configurations including ones from archived projects.
int	getNumberOfProjects()	Returns total number of projects currently loaded in the server.
int	getNumberOfVcsRoots()	Returns the total number of VCS roots, including ones from archived projects
int	getNumberOfVirtualBuildTypes()
ProjectDataModel	getProjectDataModel()
ProjectIdentifiersManager	getProjectIdentifiersManager()
List<String>	getProjectIds()	A helper method which returns the list of all projectID configured on the server.
Collection<ProjectFilePersister>	getProjectPersisters()
List<SProject>	getProjects()	Returns the list of all projects, including archived.
List<SProject>	getProjects(User user)	Returns list of all projects sorted according to the order specified by user
Comparator<SProject>	getProjectsComparator()
File	getProjectsDirectory()
ProjectEx	getRootProject()	Returns the root project.
String	internalBuildTypeIdToExternal(String buildTypeId)
boolean	isProjectExists(String projectId)	Returns true if project with the specified id exists.
boolean	isProjectsModelInitialized()
void	lockProject(String internalId)
void	persistAllProjects()	Persists configuration of all projects (including archived).
void	removeProject(String internalProjectId)	Removes project from the current list of projects.
BackgroundPersistTask	removeProjectLater(ConfigAction cause, SProject project)	Removes the specified project in background
<T> T	runWithExclusiveProjectModelLock(Supplier<T> supplier)	Runs the specified supplier with the exclusive project model lock and returns its result.
void	setDelegate(ProjectManagerEx delegate)
void	unlockProject(String internalId)
void	updateEntitiesRemovedMark()	Finds all removed project ids and marks them as removed in database.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecuredProjectManager

public SecuredProjectManager(@NotNull
                             SecurityContextEx securityContext)

Method Detail

setDelegate

public void setDelegate(@NotNull
                        ProjectManagerEx delegate)

getRootProject

@NotNull
public ProjectEx getRootProject()

Description copied from interface: ProjectManagerEx

Returns the root project.

Specified by:

getRootProject in interface ProjectManager

Specified by:

getRootProject in interface ProjectManagerEx

Returns:

root project.

getProjects

@NotNull
public List<SProject> getProjects()

Description copied from interface: ProjectManager

Returns the list of all projects, including archived. The order: visible projects come first (sorted by name), then archived projects (sorted by name).

Specified by:

getProjects in interface ProjectManager

Returns:

list of all projects

getActiveProjects

@NotNull
public List<SProject> getActiveProjects()

Description copied from interface: ProjectManager

Returns the list of active (non-archived) projects. List is sorted by project name.

Specified by:

getActiveProjects in interface ProjectManager

Returns:

list of non-archived projects

getArchivedProjects

@NotNull
public List<SProject> getArchivedProjects()

Description copied from interface: ProjectManager

Returns the list of archived projects. List is sorted by project name.

Specified by:

getArchivedProjects in interface ProjectManager

Returns:

list of archived projects

getNumberOfProjects

public int getNumberOfProjects()

Description copied from interface: ProjectManager

Returns total number of projects currently loaded in the server. The value always equals to getProjects().size().

Specified by:

getNumberOfProjects in interface ProjectManager

Returns:

total number of projects

getProjects

@NotNull
public List<SProject> getProjects(@NotNull
                                  User user)

Description copied from interface: ProjectManager

Returns list of all projects sorted according to the order specified by user

Specified by:

getProjects in interface ProjectManager

Parameters:

user - the user

Returns:

see above

createProject

@NotNull
public ProjectEx createProject(@NotNull
                               String projectName)
                        throws DuplicateProjectNameException

Description copied from interface: ProjectManagerEx

Creates new project with specified name (name is case insensitive). Project external id is generated based on project name. The new project is created in root project.

Specified by:

createProject in interface ProjectManager

Specified by:

createProject in interface ProjectManagerEx

Parameters:

projectName - name of the new project

Returns:

newly created project

Throws:

DuplicateProjectNameException - if project with specified name already exists

See Also:

#createProject(String, String, String)

copyProject

@NotNull
public SProject copyProject(@NotNull
                            SProject originalProject,
                            @NotNull
                            SProject parentOfCopy,
                            @NotNull
                            CopyOptions options)
                     throws MaxNumberOfBuildTypesReachedException,
                            InvalidIdentifierException,
                            InvalidNameException,
                            DuplicateExternalIdException

Description copied from interface: ProjectManager

Copies the given project with all subprojects into another project.

Also persists projects when they're copied.

Specified by:

copyProject in interface ProjectManager

Parameters:

originalProject - the project to copy.

parentOfCopy - the parent of the newly created project

options - copy option.

Returns:

the copy of the project

Throws:

MaxNumberOfBuildTypesReachedException

InvalidIdentifierException

InvalidNameException

DuplicateExternalIdException

See Also:

CopyOptions

createProject

@NotNull
public SProject createProject(@NotNull
                              SProject originalProject,
                              @NotNull
                              String newProjectName,
                              @NotNull
                              CopyOptions options)
                       throws MaxNumberOfBuildTypesReachedException

Description copied from interface: ProjectManager

Creates new project by copying all settings from original project. Warning - this function doesn't copy all nested subprojects. Use ProjectManager.copyProject(SProject, SProject, CopyOptions) instead.

Specified by:

createProject in interface ProjectManager

Parameters:

originalProject - original project

newProjectName - name for new project. If there exists project with same name then " (1)", " (2)", ... suffix will be added to the specified name.

options - additional options

Returns:

newly created project

Throws:

MaxNumberOfBuildTypesReachedException - if original project build configurations cannot be copied because maximum number of build configurations is reached or will be exceeded if project will be copied

findProjectByName

@Nullable
public SProject findProjectByName(@NotNull
                                  String projectName)

Description copied from interface: ProjectManager

Searches for a project with the specified name (case insensitive) among direct subprojects of the root project. The search includes archived projects.

Specified by:

findProjectByName in interface ProjectManager

Parameters:

projectName - name of the project to search for

Returns:

a project or null if such a project does not exist

findProjectById

@Nullable
public ProjectEx findProjectById(@Nullable
                                 String projectId)

Description copied from interface: ProjectManagerEx

Looks for a project with the given internal id.

Specified by:

findProjectById in interface ProjectManager

Specified by:

findProjectById in interface ProjectManagerEx

Parameters:

projectId - the internal id, case insensitive.

Returns:

the found project, or null if not found.

See Also:

BuildProject.getProjectId(), ProjectManagerEx.findProjectByExternalId(String)

findProjectByExternalId

@Nullable
public ProjectEx findProjectByExternalId(@Nullable
                                         String externalId)

Description copied from interface: ProjectManagerEx

Looks for a project with the given external id.

Specified by:

findProjectByExternalId in interface ProjectManager

Specified by:

findProjectByExternalId in interface ProjectManagerEx

Parameters:

externalId - the external id, case insensitive.

Returns:

the found project, or null if not found.

See Also:

BuildProject.getExternalId(), ProjectManagerEx.findProjectById(String)

findProjectByConfigId

@Nullable
public SProject findProjectByConfigId(@Nullable
                                      String configId)

Description copied from interface: ProjectManager

Looks for a project with the given config id.

The search includes archived projects.

Specified by:

findProjectByConfigId in interface ProjectManager

Parameters:

configId - the config id of the project to search for, case insensitive.

Returns:

a project or null if project with such id does not exist

See Also:

ProjectManager.findProjectById(String)

findProjects

@NotNull
public Collection<SProject> findProjects(@NotNull
                                         Collection<String> internalIds)

Filters collection of projects by preserving only accessible ones by current user.

Specified by:

findProjects in interface ProjectManager

Parameters:

internalIds -

Returns:

findProjectsByExternalIds

@NotNull
public Collection<SProject> findProjectsByExternalIds(@NotNull
                                                      Collection<String> externalIds)

Description copied from interface: ProjectManager

Returns collection of projects corresponding to the specified external ids. The collection is guaranteed to be a mutable one.

Specified by:

findProjectsByExternalIds in interface ProjectManager

Parameters:

externalIds - collection of external identifiers, case insensitive.

Returns:

see above

findBuildTypeIdentityByInternalId

@Nullable
public BuildTypeIdentity findBuildTypeIdentityByInternalId(@NotNull
                                                           String intId)

Specified by:

findBuildTypeIdentityByInternalId in interface ProjectManagerEx

findBuildTypeById

@Nullable
public BuildTypeEx findBuildTypeById(@Nullable
                                     String internalId)

Searches for a build configuration with the specified internal id.

Specified by:

findBuildTypeById in interface ProjectManager

Specified by:

findBuildTypeById in interface ProjectManagerEx

Parameters:

internalId - the internal id of the build configuration to search for.

Returns:

a build configuration or null if build configuration with given internal id does not exist.

Throws:

AccessDeniedException - if the current authority holder doesn't have an access to the build configuration with the given internal id.

See Also:

ProjectManagerEx.findBuildTypeById(String)

findBuildTypeByExternalId

public BuildTypeEx findBuildTypeByExternalId(@Nullable
                                             String externalId)
                                      throws AccessDeniedException

Description copied from interface: ProjectManagerEx

Looks for a build type with the given external id.

Specified by:

findBuildTypeByExternalId in interface ProjectManager

Specified by:

findBuildTypeByExternalId in interface ProjectManagerEx

Parameters:

externalId - the external id to look for a build type with, case insensitive.

Returns:

the found build type, or null if not found.

Throws:

AccessDeniedException - if current authority holder doesn't have access to build configuration with given external id.

findBuildTypeByConfigId

@Nullable
public SBuildType findBuildTypeByConfigId(@Nullable
                                          String configId)
                                   throws AccessDeniedException

Description copied from interface: ProjectManager

Searches for a build configuration with specified config id.

Specified by:

findBuildTypeByConfigId in interface ProjectManager

Parameters:

configId - the config id of the build configuration to search for.

Returns:

a build configuration or null if build configuration with given config id does not exist.

Throws:

AccessDeniedException - if current authority holder doesn't have access to build configuration with given config id.

persistAllProjects

public void persistAllProjects()

Description copied from interface: ProjectManagerEx

Persists configuration of all projects (including archived).

Specified by:

persistAllProjects in interface ProjectManagerEx

getAllBuildTypes

@NotNull
public List<SBuildType> getAllBuildTypes()

Description copied from interface: ProjectManager

Returns the list of all build configurations, including ones from archived projects. The order: build configurations from visible projects come first, then from archived projects.

Specified by:

getAllBuildTypes in interface ProjectManager

Returns:

list of all build configurations

getAllTemplates

@NotNull
public List<BuildTypeTemplate> getAllTemplates()

Description copied from interface: ProjectManager

Returns list of all of the templates, including ones from archived projects. Ordering is the same as for build configurations.

Specified by:

getAllTemplates in interface ProjectManager

Returns:

see above

getActiveBuildTypes

@NotNull
public List<SBuildType> getActiveBuildTypes()

Description copied from interface: ProjectManager

Returns the list of build types that belong to non-archived projects only.

Specified by:

getActiveBuildTypes in interface ProjectManager

Returns:

list of non-archived build types

getArchivedBuildTypes

@NotNull
public List<SBuildType> getArchivedBuildTypes()

Description copied from interface: ProjectManager

Returns list of build configurations from archived projects, sorted by project and build configuration name.

Specified by:

getArchivedBuildTypes in interface ProjectManager

Returns:

list of archived build configurations.

getNumberOfBuildTypes

public int getNumberOfBuildTypes()

Description copied from interface: ProjectManager

Returns the total number of build configurations including ones from archived projects.

Specified by:

getNumberOfBuildTypes in interface ProjectManager

Returns:

number of build configurations

getNumberOfVcsRoots

public int getNumberOfVcsRoots()

Description copied from interface: ProjectManager

Returns the total number of VCS roots, including ones from archived projects

Specified by:

getNumberOfVcsRoots in interface ProjectManager

Returns:

number of VCS roots

getAllBuildTypes

@NotNull
public List<SBuildType> getAllBuildTypes(@NotNull
                                         User user)

Description copied from interface: ProjectManager

Returns list of all build configurations sorted by project according to the order specified by user and then by build configuration name.

Specified by:

getAllBuildTypes in interface ProjectManager

Parameters:

user - user whose settings to use to sort build types

Returns:

list of all build configurations.

checkCanCreateBuildTypes

public void checkCanCreateBuildTypes(@NotNull
                                     SProject targetProject,
                                     int numOfBuildTypes)
                              throws MaxNumberOfBuildTypesReachedException

Description copied from interface: ProjectManagerEx

Checks whether numOfBuildTypes build configurations can be created and throws exception if can't

Specified by:

checkCanCreateBuildTypes in interface ProjectManagerEx

Parameters:

targetProject - a project where build configurations will be created

numOfBuildTypes - number of build types to create

Throws:

MaxNumberOfBuildTypesReachedException - if max number of build types reached

findProjectId

@Nullable
public String findProjectId(@NotNull
                            String buildTypeId)

Description copied from interface: ProjectManager

Searches for a project which contains a build type with the specified build type id. Returns internal id of this project or null if such project does not exist. The search includes archived projects.

Specified by:

findProjectId in interface ProjectManager

Parameters:

buildTypeId - id of a build type

Returns:

project internal id of a project containing specified build type

findProjectsIds

@NotNull
public Set<String> findProjectsIds(@NotNull
                                   Collection<String> buildTypeIds)

Description copied from interface: ProjectManagerEx

Accepts a collection of build type ids, returns ids of projects where these build types belong.

Specified by:

findProjectsIds in interface ProjectManagerEx

Returns:

see above

isProjectsModelInitialized

public boolean isProjectsModelInitialized()

Specified by:

isProjectsModelInitialized in interface ProjectManagerEx

Returns:

true if projects configuration files were loaded from disk at least once (during the server startup).

internalBuildTypeIdToExternal

@Nullable
public String internalBuildTypeIdToExternal(@NotNull
                                            String buildTypeId)

Specified by:

internalBuildTypeIdToExternal in interface ProjectManagerEx

Returns:

external identifier by the given internal one or null if external identifier was not found.

getProjectIdentifiersManager

@NotNull
public ProjectIdentifiersManager getProjectIdentifiersManager()

Specified by:

getProjectIdentifiersManager in interface ProjectManagerEx

findProjectExternalId

@Nullable
public String findProjectExternalId(@NotNull
                                    String buildTypeId)

Description copied from interface: ProjectManager

Searches for a project which contains a build type with the specified build type id. Returns external id of this project or null if such project does not exist. The search includes archived projects.

Specified by:

findProjectExternalId in interface ProjectManager

Parameters:

buildTypeId - id of a build type

Returns:

project external id of a project containing specified build type

findProjectIdForTemplate

@Nullable
public String findProjectIdForTemplate(@NotNull
                                       String buildTypeTemplateId)

Description copied from interface: ProjectManager

Searches for a project which contains a build type template with the specified id. Returns id of this project or null if such project does not exist. The search includes archived projects.

Specified by:

findProjectIdForTemplate in interface ProjectManager

Parameters:

buildTypeTemplateId - id of a build type template

Returns:

project id of a project containing specified build type template

isProjectExists

public boolean isProjectExists(@NotNull
                               String projectId)

Description copied from interface: ProjectManager

Returns true if project with the specified id exists. In contrast to ProjectManager.findProjectById(String) this method does not check permissions and will return true if project exists even if user does not have permissions to access this project.

Specified by:

isProjectExists in interface ProjectManager

Parameters:

projectId - the internal id of the project

Returns:

see above

getBuildTypesDependingOn

@NotNull
public Map<SBuildType,List<SArtifactDependency>> getBuildTypesDependingOn(@NotNull
                                                                                Collection<SBuildType> types)

Specified by:

getBuildTypesDependingOn in interface ProjectManagerEx

findBuildTypeTemplateById

public BuildTypeTemplateEx findBuildTypeTemplateById(@NotNull
                                                     String id)

Description copied from interface: ProjectManager

Searches for build type template by given internal id

Specified by:

findBuildTypeTemplateById in interface ProjectManager

Specified by:

findBuildTypeTemplateById in interface ProjectManagerEx

Parameters:

id - the internal id of template

Returns:

found template or null

findBuildTypeTemplateByExternalId

@Nullable
public BuildTypeTemplateEx findBuildTypeTemplateByExternalId(@NotNull
                                                             String externalId)

Description copied from interface: ProjectManager

Searches for build type template by given external id. Since 8.1 the method also looks up the template by the previous external ids. So the result project can have a different external id after a call. But the later is impossible if there is a template that currently has a externalId.

Specified by:

findBuildTypeTemplateByExternalId in interface ProjectManager

Specified by:

findBuildTypeTemplateByExternalId in interface ProjectManagerEx

Parameters:

externalId - the external id of template

Returns:

found template or null, if template can't be found or external id is null.

findBuildTypeTemplateByConfigId

@Nullable
public BuildTypeTemplate findBuildTypeTemplateByConfigId(@NotNull
                                                         String configId)

Description copied from interface: ProjectManager

Searches for build type template by given config id.

Specified by:

findBuildTypeTemplateByConfigId in interface ProjectManager

Parameters:

configId - the config id of template

Returns:

found template or null

getCommonParentProject

@NotNull
public SProject getCommonParentProject(@NotNull
                                       Collection<SProject> projects)

Description copied from interface: ProjectManager

Returns nearest common parent project for all projects in provided collection.

Specified by:

getCommonParentProject in interface ProjectManager

Parameters:

projects - projects to find common parent for

Returns:

common parent project

findBuildTypes

@NotNull
public Collection<SBuildType> findBuildTypes(@NotNull
                                             Collection<String> buildTypeIds)

Filters collection of build types by preserving only accessible ones by current user.

Specified by:

findBuildTypes in interface ProjectManager

Parameters:

buildTypeIds -

Returns:

findBuildTypesByExternalIds

@NotNull
public Collection<SBuildType> findBuildTypesByExternalIds(@NotNull
                                                          Collection<String> externalIds)

Description copied from interface: ProjectManager

Returns collection of build types corresponding to the specified external ids.

Specified by:

findBuildTypesByExternalIds in interface ProjectManager

Parameters:

externalIds - collection of external identifiers, case insensitive.

Returns:

see above

removeProject

public void removeProject(@NotNull
                          String internalProjectId)
                   throws ProjectRemoveFailedException

Description copied from interface: ProjectManager

Removes project from the current list of projects. Project directory will be placed into the '_trash' folder.

Specified by:

removeProject in interface ProjectManager

Parameters:

internalProjectId - internal id of project to remove

Throws:

ProjectRemoveFailedException - if remove failed

removeProjectLater

@NotNull
public BackgroundPersistTask removeProjectLater(@NotNull
                                                ConfigAction cause,
                                                @NotNull
                                                SProject project)
                                         throws ProjectRemoveFailedException

Description copied from interface: ProjectManagerEx

Removes the specified project in background

Specified by:

removeProjectLater in interface ProjectManagerEx

project - project to remove

Returns:

background remove task

Throws:

ProjectRemoveFailedException - when remove fails

getExistingProjectsIds

@NotNull
public Set<String> getExistingProjectsIds(@NotNull
                                          Collection<String> projectIds)

Description copied from interface: ProjectManagerEx

Accepts a collection of project ids and and checks each of them for existence. Returns subset of project ids corresponding to existing projects.

Specified by:

getExistingProjectsIds in interface ProjectManagerEx

Parameters:

projectIds - project ids to check

Returns:

subset of project ids corresponding to existing projects

getProjectIds

public List<String> getProjectIds()

Description copied from interface: ProjectManager

A helper method which returns the list of all projectID configured on the server.

Specified by:

getProjectIds in interface ProjectManager

Returns:

the list of all projectID configured on the server.

getFilteredBuildTypes

public SortedMap<SProject,List<SBuildType>> getFilteredBuildTypes(@NotNull
                                                                        User user,
                                                                        @Nullable
                                                                        BuildTypeFilter filter)

Description copied from interface: ProjectManager

Returns sorted map of build configurations per project. Build types can be filtered by specified BuildTypeFilter. Projects in the map are sorted according to the projects order specified by user.

Specified by:

getFilteredBuildTypes in interface ProjectManager

Parameters:

user - the user

filter - filter of build configurations, can be null

Returns:

sorted map of build types per project

getProjectsDirectory

public File getProjectsDirectory()

Specified by:

getProjectsDirectory in interface ProjectManagerEx

findVcsRootById

@Nullable
public SVcsRootEx findVcsRootById(long id)

Description copied from interface: ProjectVcsRoots

Finds VCS root by id

Specified by:

findVcsRootById in interface ProjectVcsRoots

Specified by:

findVcsRootById in interface ProjectVcsRootsEx

Parameters:

id - vcs root id

Returns:

found VCS root or null

findVcsRootByExternalId

@Nullable
public SVcsRootEx findVcsRootByExternalId(@NotNull
                                          String externalId)

Description copied from interface: ProjectVcsRoots

Finds VCS root by external id

Specified by:

findVcsRootByExternalId in interface ProjectVcsRoots

Specified by:

findVcsRootByExternalId in interface ProjectVcsRootsEx

Parameters:

externalId - external vcs root id

Returns:

found VCS root or null

findVcsRootByConfigId

@Nullable
public SVcsRoot findVcsRootByConfigId(@NotNull
                                      String configId)

Description copied from interface: ProjectVcsRoots

Finds VCS root by config id

Specified by:

findVcsRootByConfigId in interface ProjectVcsRoots

Parameters:

configId - the config is of vcs root

Returns:

found VCS root or null

findVcsRootsByIds

@NotNull
public Collection<SVcsRoot> findVcsRootsByIds(@NotNull
                                              Collection<Long> ids)

Description copied from interface: ProjectVcsRoots

Finds all VCS roots having the specified ids. Returns roots in the same order as provided ids.

Specified by:

findVcsRootsByIds in interface ProjectVcsRoots

Parameters:

ids - ids of VCS roots

Returns:

collection of found VCS roots

findVcsRootByName

@Nullable
public SVcsRootEx findVcsRootByName(@NotNull
                                    String name)

Specified by:

findVcsRootByName in interface ProjectVcsRootsEx

ensureProjectsDirectoryExists

public File ensureProjectsDirectoryExists()

Specified by:

ensureProjectsDirectoryExists in interface ProjectManagerEx

executeFSOperation

public void executeFSOperation(@NotNull
                               String description,
                               @NotNull
                               Runnable persistAction)

Specified by:

executeFSOperation in interface ProjectManagerEx

lockProject

public void lockProject(@NotNull
                        String internalId)

Specified by:

lockProject in interface ProjectManagerEx

unlockProject

public void unlockProject(@NotNull
                          String internalId)

Specified by:

unlockProject in interface ProjectManagerEx

getProjectPersisters

public Collection<ProjectFilePersister> getProjectPersisters()

Specified by:

getProjectPersisters in interface ProjectManagerEx

getProjectDataModel

@NotNull
public ProjectDataModel getProjectDataModel()

Specified by:

getProjectDataModel in interface ProjectManagerEx

findBuildTypeIdentityByExternalId

@Nullable
public BuildTypeIdentity findBuildTypeIdentityByExternalId(@NotNull
                                                           String extId)

Specified by:

findBuildTypeIdentityByExternalId in interface ProjectManagerEx

createProjectInternal

public ProjectEx createProjectInternal(@NotNull
                                       EntityId<String> parentId,
                                       @NotNull
                                       String externalId,
                                       @NotNull
                                       String projectName)

Specified by:

createProjectInternal in interface ProjectManagerEx

getNumberOfVirtualBuildTypes

public int getNumberOfVirtualBuildTypes()

Specified by:

getNumberOfVirtualBuildTypes in interface ProjectManagerEx

getBuildTypesComparator

@NotNull
public Comparator<SBuildType> getBuildTypesComparator()

Specified by:

getBuildTypesComparator in interface ProjectManager

Returns:

Comparator to sort build configurations with server-wide custom ordering. Project ordering is not used by this comparator - use BuildTypeComparator to order build configurations from different projects.

getAllVcsRoots

@NotNull
public List<SVcsRoot> getAllVcsRoots()

Specified by:

getAllVcsRoots in interface ProjectVcsRoots

Returns:

all VCS roots configured in all projects

filterProjects

@NotNull
public static List<SProject> filterProjects(@NotNull
                                            List<SProject> list,
                                            @NotNull
                                            Filter<BuildProject> projectFilter)

generateDefaultExternalIds

public ProjectManagerEx.IdsMaps generateDefaultExternalIds(@NotNull
                                                           SProject project,
                                                           @Nullable
                                                           String changedExtId,
                                                           boolean useCurrentIds,
                                                           boolean generateForCopy)

Description copied from interface: ProjectManagerEx

Generates identifiers for all nested entities (subprojects, VCS roots, build types and templates) of the given project. Applicable to regenerate ids or to generate ids befor copying.

Specified by:

generateDefaultExternalIds in interface ProjectManagerEx

Parameters:

project - project to generate ids for its nested objects.

changedExtId - the new external id for this project.

useCurrentIds - use suffixes of the current external ids if possible.

generateForCopy - false means regenerate ids for the existent objects; true - for copies.

Returns:

maps old id -> new id.

getDirectSubProjectsMap

@NotNull
public Map<String,List<ProjectEx>> getDirectSubProjectsMap()

Description copied from interface: ProjectManagerEx

Map where key is parent project internal id and value - all direct subprojects of this parent

Specified by:

getDirectSubProjectsMap in interface ProjectManagerEx

Returns:

getProjectsComparator

@NotNull
public Comparator<SProject> getProjectsComparator()

Specified by:

getProjectsComparator in interface ProjectManager

Returns:

Comparator to sort projects with server-wide custom ordering

runWithExclusiveProjectModelLock

public <T> T runWithExclusiveProjectModelLock(@NotNull
                                              Supplier<T> supplier)
                                       throws TimeoutException,
                                              InterruptedException

Description copied from interface: ProjectManagerEx

Runs the specified supplier with the exclusive project model lock and returns its result. The exclusive lock prevents model update from disk and entities addition/removal.

Specified by:

runWithExclusiveProjectModelLock in interface ProjectManagerEx

Type Parameters:

T - type of supplier's result

Parameters:

supplier - supplier to run

Returns:

see above

Throws:

TimeoutException - if exclusive lock cannot be acquired within the default timeout

InterruptedException - if the thread was interrupted while waiting for a lock

updateEntitiesRemovedMark

public void updateEntitiesRemovedMark()

Description copied from interface: ProjectManagerEx

Finds all removed project ids and marks them as removed in database. Also finds all which are marked as removed but no longer removed, and unmarks them.

Specified by:

updateEntitiesRemovedMark in interface ProjectManagerEx