Package jetbrains.buildServer.serverSide.agentPools

Class AgentPoolManagerImpl

java.lang.Object

jetbrains.buildServer.serverSide.agentPools.AgentPoolManagerImpl

All Implemented Interfaces:

AgentPoolManager, AfterBuildsCleanupExtension, ServerExtension, TeamCityExtension

public class AgentPoolManagerImpl
extends Object
implements AgentPoolManager, AfterBuildsCleanupExtension

Field Summary

Fields

Modifier and Type	Field	Description
protected ProjectManagerEx	myProjectManager
static String	PROJECT_POOLS_CLEANUP_DELAY_PROP
static String	PROJECT_POOLS_CLEANUP_ENABLED_PROP

Constructor Summary

Constructors

Constructor	Description
AgentPoolManagerImpl(SQLRunnerEx sqlRunner, NumericIdSequences idSequences, AgentTypeStorage agentTypeStorage, EventDispatcher<AgentPoolListener> agentPoolEventDispatcher, EventDispatcher<BuildServerListener> eventDispatcher, BuildAgentManagerEx agentManager, ServerResponsibility serverResponsibility, MultiNodesEvents multiNodesEvents, ExecutorServices executorServices)

Method Summary

Modifier and Type	Method	Description
void	addListener(AgentPoolListener listener)	Adds listener for agent pool events.
void	afterCleanup(CleanupProcessState cleanupState)	Invoked upon finishing of the main cleanup process.
boolean	agentPoolContainsProject(int poolId, String projectId)	Returns true if agent pool with specified id exists and contains project with specified internal id.
void	associateProjectsWithPool(int agentPoolId, Set<String> projectIds)	Associates specified projects with the specified pool.
boolean	canAddAgent(int poolId)	Returns true if this pool can add least one more agent
boolean	canAddAgents(int poolId, int addCount)	Returns true if this pool can add desired # of agents
String	checkAgentPoolCanBeUsedByCloudProfile(String cloudProfileId, AgentPool agentPool)	Checks if agent from the given cloud profile can be used with a specified pool.
void	copyPoolAssociations(String sourceProjectId, String targetProjectId)	Copies set of pools associations from one project to the other.
AgentPool	createNewAgentPool(String agentPoolName)	Creates new agent pool with the specified name and no limits.
AgentPool	createNewAgentPool(String agentPoolName, AgentPoolLimits poolLimits)	Creates new agent pool with the specified name and specific limits
AgentPool	createUnknownPool(int agentPoolId)	Creates an instance of "unknown" pool without writing anything to DB.
AgentPool	deleteAgentPool(int agentPoolId)	Deletes agent pool with the specified identifier.
void	dissociateProjectsFromOtherPools(int agentPoolId, Set<String> projectIds)	Dissociates specified projects from all the pools except the specified one.
void	dissociateProjectsFromPool(int agentPoolId, Set<String> projectIds)	Dissociates specified projects from the specified pool.
void	ensureAgentTypeIsAssignedToPool(int agentTypeId)	This method ensures that agent type with specified id belongs at least to the default agent pool.
AgentPool	findAgentPoolById(int agentPoolId)	Returns agent pool with the specified identifier.
AgentPool	findAgentPoolByTypeId(int agentTypeId)	Searches for agent pool by agent type id.
int	findAgentPoolIdByTypeId(int agentTypeId)	Returns agent pool id for the specified agent type id or -1 if there is no such pool or agent type.
Map<Integer,AgentPool>	findAgentPoolsByIds(Collection<Integer> agentPoolIds)	Returns a map of agent pools corresponding to the specified agent pool ids
AgentPool	findProjectPoolByProjectId(String projectId)	Creates pool for project in memory, without persisting it to DB
Set<Integer>	getAgentPoolsWithProject(String projectId)	Returns all associated pools for the specified project.
Collection<Integer>	getAgentTypeIdsByPool(int agentPoolId)	Returns agent type ids associated with the specified pool
List<AgentPool>	getAllAgentPools()	Returns all agent pools.
List<AgentPool>	getAllAgentPoolsEx(boolean includeProjectPools)	returns list of agent pools (see options)
Collection<Pair<Integer,String>>	getAllPoolProjectRelations()	Returns all pool--project relations.
int	getNumberOfAgentPools()	Returns number of agent pools.
AgentPool	getOrCreateProjectPool(String projectId)	Creates pool for project in memory, without persisting it to DB
Set<String>	getPoolProjects(int poolId)	Returns projects that are associated with the specified pool.
Set<Integer>	getProjectAgentTypes(String projectId)	Returns all agents from pools the given projects associated with.
Collection<AgentPool>	getProjectOwnedAgentPools(String projectExternalId)	Returns agent pools that include only projects that are under this project's tree (including the project itself).
boolean	hasSeveralPools()	Returns true if number of agent pools is greater than one.
void	moveAgentToPool(int agentPoolId, BuildAgentEx agent)	Moves specified agent to the specified pool.
void	moveAgentTypesToPool(int agentPoolId, Set<Integer> agentTypeIds)	Moves specified agent types to the specified pool.
void	moveAgentTypesToProjectPool(String projectId, Set<Integer> agentTypeIds)	Moves the specified agent types to the project agents pool corresponding to the specified project id (pool will be created if it does not exist)
void	resetPoolsCache()
void	setAgentTypeProviderRegistry(AgentTypeProviderRegistry agentTypeProviderRegistry)
void	setAuditLogFactory(AuditLogFactory auditLogFactory)
void	setCloudManagerBase(CloudManagerBase cloudManagerBase)
void	setProjectManager(ProjectManagerEx projectManager)
AgentPool	updateAgentPool(int agentPoolId, String newAgentPoolName, AgentPoolLimits newPoolLimits)	Renames agent pool with the specified identifier.

Methods inherited from class java.lang.Object

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

Field Detail

PROJECT_POOLS_CLEANUP_DELAY_PROP

public static final String PROJECT_POOLS_CLEANUP_DELAY_PROP

See Also:

Constant Field Values

PROJECT_POOLS_CLEANUP_ENABLED_PROP

public static final String PROJECT_POOLS_CLEANUP_ENABLED_PROP

See Also:

Constant Field Values

myProjectManager

@NotNull
protected ProjectManagerEx myProjectManager

Constructor Detail

AgentPoolManagerImpl

public AgentPoolManagerImpl(@NotNull
                            SQLRunnerEx sqlRunner,
                            @NotNull
                            NumericIdSequences idSequences,
                            @NotNull
                            AgentTypeStorage agentTypeStorage,
                            @NotNull
                            EventDispatcher<AgentPoolListener> agentPoolEventDispatcher,
                            @NotNull
                            EventDispatcher<BuildServerListener> eventDispatcher,
                            @NotNull
                            BuildAgentManagerEx agentManager,
                            @NotNull
                            ServerResponsibility serverResponsibility,
                            @NotNull
                            MultiNodesEvents multiNodesEvents,
                            @NotNull
                            ExecutorServices executorServices)

Method Detail

setProjectManager

public void setProjectManager(@NotNull
                              ProjectManagerEx projectManager)

setAuditLogFactory

public void setAuditLogFactory(AuditLogFactory auditLogFactory)

setAgentTypeProviderRegistry

public void setAgentTypeProviderRegistry(@NotNull
                                         AgentTypeProviderRegistry agentTypeProviderRegistry)

setCloudManagerBase

public void setCloudManagerBase(@NotNull
                                CloudManagerBase cloudManagerBase)

addListener

public void addListener(@NotNull
                        AgentPoolListener listener)

Description copied from interface: AgentPoolManager

Adds listener for agent pool events.

Specified by:

addListener in interface AgentPoolManager

Parameters:

listener - listener

getAllPoolProjectRelations

@NotNull
public Collection<Pair<Integer,String>> getAllPoolProjectRelations()

Description copied from interface: AgentPoolManager

Returns all pool--project relations.

Specified by:

getAllPoolProjectRelations in interface AgentPoolManager

Returns:

pool--project relations as an unsorted collection of pairs where first element is a pool id and second element is a project id.

getAgentPoolsWithProject

@NotNull
public Set<Integer> getAgentPoolsWithProject(@NotNull
                                             String projectId)

Description copied from interface: AgentPoolManager

Returns all associated pools for the specified project.

Specified by:

getAgentPoolsWithProject in interface AgentPoolManager

Parameters:

projectId - project id

Returns:

set of agent pool ids

getProjectOwnedAgentPools

@NotNull
public Collection<AgentPool> getProjectOwnedAgentPools(@NotNull
                                                       String projectExternalId)

Description copied from interface: AgentPoolManager

Returns agent pools that include only projects that are under this project's tree (including the project itself).

Specified by:

getProjectOwnedAgentPools in interface AgentPoolManager

Returns:

getProjectAgentTypes

@NotNull
public Set<Integer> getProjectAgentTypes(@NotNull
                                         String projectId)

Description copied from interface: AgentPoolManager

Returns all agents from pools the given projects associated with.

Specified by:

getProjectAgentTypes in interface AgentPoolManager

Parameters:

projectId - project id

Returns:

set of agent tyeps ids

getPoolProjects

@NotNull
public Set<String> getPoolProjects(int poolId)

Description copied from interface: AgentPoolManager

Returns projects that are associated with the specified pool.

Specified by:

getPoolProjects in interface AgentPoolManager

Parameters:

poolId - pool identifier we want projects for.

Returns:

set of internal project ids.

agentPoolContainsProject

public boolean agentPoolContainsProject(int poolId,
                                        @NotNull
                                        String projectId)

Description copied from interface: AgentPoolManager

Returns true if agent pool with specified id exists and contains project with specified internal id.

Specified by:

agentPoolContainsProject in interface AgentPoolManager

Parameters:

poolId - pool id

projectId - project id

Returns:

see above

canAddAgent

public boolean canAddAgent(int poolId)
                    throws NoSuchAgentPoolException

Description copied from interface: AgentPoolManager

Returns true if this pool can add least one more agent

Specified by:

canAddAgent in interface AgentPoolManager

Returns:

see above

Throws:

NoSuchAgentPoolException

canAddAgents

public boolean canAddAgents(int poolId,
                            int addCount)
                     throws NoSuchAgentPoolException

Description copied from interface: AgentPoolManager

Returns true if this pool can add desired # of agents

Specified by:

canAddAgents in interface AgentPoolManager

addCount - number of agents to add

Returns:

Throws:

NoSuchAgentPoolException

getAgentTypeIdsByPool

@NotNull
public Collection<Integer> getAgentTypeIdsByPool(int agentPoolId)

Description copied from interface: AgentPoolManager

Returns agent type ids associated with the specified pool

Specified by:

getAgentTypeIdsByPool in interface AgentPoolManager

Parameters:

agentPoolId - - agent pool internal id

findAgentPoolByTypeId

@Nullable
public AgentPool findAgentPoolByTypeId(int agentTypeId)

Description copied from interface: AgentPoolManager

Searches for agent pool by agent type id.

Specified by:

findAgentPoolByTypeId in interface AgentPoolManager

Parameters:

agentTypeId - agent type id

Returns:

found agent pool or null

findAgentPoolIdByTypeId

public int findAgentPoolIdByTypeId(int agentTypeId)

Description copied from interface: AgentPoolManager

Returns agent pool id for the specified agent type id or -1 if there is no such pool or agent type.

Specified by:

findAgentPoolIdByTypeId in interface AgentPoolManager

Parameters:

agentTypeId - agent type id

Returns:

found agent pool id or -1

getAllAgentPoolsEx

@NotNull
public List<AgentPool> getAllAgentPoolsEx(boolean includeProjectPools)

Description copied from interface: AgentPoolManager

returns list of agent pools (see options)

Specified by:

getAllAgentPoolsEx in interface AgentPoolManager

Parameters:

includeProjectPools - - true to include project pools

Returns:

getAllAgentPools

@NotNull
public List<AgentPool> getAllAgentPools()

Description copied from interface: AgentPoolManager

Returns all agent pools. Sorting is by name, but default pool is always the last.

Specified by:

getAllAgentPools in interface AgentPoolManager

Returns:

see above

getNumberOfAgentPools

public int getNumberOfAgentPools()

Description copied from interface: AgentPoolManager

Returns number of agent pools.

Specified by:

getNumberOfAgentPools in interface AgentPoolManager

Returns:

see above

hasSeveralPools

public boolean hasSeveralPools()

Description copied from interface: AgentPoolManager

Returns true if number of agent pools is greater than one.

Specified by:

hasSeveralPools in interface AgentPoolManager

Returns:

see above

findAgentPoolById

@Nullable
public AgentPool findAgentPoolById(int agentPoolId)

Description copied from interface: AgentPoolManager

Returns agent pool with the specified identifier.

Specified by:

findAgentPoolById in interface AgentPoolManager

Parameters:

agentPoolId - agent pool id

Returns:

agent pool or null if it does not exist

findAgentPoolsByIds

@NotNull
public Map<Integer,AgentPool> findAgentPoolsByIds(@NotNull
                                                        Collection<Integer> agentPoolIds)

Description copied from interface: AgentPoolManager

Returns a map of agent pools corresponding to the specified agent pool ids

Specified by:

findAgentPoolsByIds in interface AgentPoolManager

Returns:

see above

createNewAgentPool

@NotNull
public AgentPool createNewAgentPool(@NotNull
                                    String agentPoolName)
                             throws AgentPoolCannotBeRenamedException

Description copied from interface: AgentPoolManager

Creates new agent pool with the specified name and no limits.

Specified by:

createNewAgentPool in interface AgentPoolManager

Parameters:

agentPoolName - agent pool name

Returns:

identifier of the created agent pool

Throws:

AgentPoolCannotBeRenamedException - if the agent pool with such name already exists

getOrCreateProjectPool

@NotNull
public AgentPool getOrCreateProjectPool(@NotNull
                                        String projectId)

Description copied from interface: AgentPoolManager

Creates pool for project in memory, without persisting it to DB

Specified by:

getOrCreateProjectPool in interface AgentPoolManager

createNewAgentPool

@NotNull
public AgentPool createNewAgentPool(@NotNull
                                    String agentPoolName,
                                    @NotNull
                                    AgentPoolLimits poolLimits)
                             throws AgentPoolCannotBeRenamedException

Description copied from interface: AgentPoolManager

Creates new agent pool with the specified name and specific limits

Specified by:

createNewAgentPool in interface AgentPoolManager

Parameters:

agentPoolName - agent pool name

poolLimits - - agent pool limits

Returns:

identifier of the created agent pool

Throws:

AgentPoolCannotBeRenamedException - if the agent pool with such name already exists

createUnknownPool

@NotNull
public AgentPool createUnknownPool(int agentPoolId)

Description copied from interface: AgentPoolManager

Creates an instance of "unknown" pool without writing anything to DB. Used in special cases

Specified by:

createUnknownPool in interface AgentPoolManager

Parameters:

agentPoolId - agent pool id

Returns:

identifier of the created agent pool

updateAgentPool

@NotNull
public AgentPool updateAgentPool(int agentPoolId,
                                 @NotNull
                                 String newAgentPoolName,
                                 @NotNull
                                 AgentPoolLimits newPoolLimits)
                          throws NoSuchAgentPoolException,
                                 AgentPoolCannotBeRenamedException

Description copied from interface: AgentPoolManager

Renames agent pool with the specified identifier.

Specified by:

updateAgentPool in interface AgentPoolManager

Parameters:

agentPoolId - agent pool id

newAgentPoolName - new agent pool name

newPoolLimits - - agent pool limits

Returns:

previous state of the agent pool

Throws:

NoSuchAgentPoolException - if the specified agent pool does not exist

AgentPoolCannotBeRenamedException - if it is an attempt to rename default agent pool or the agent pool with such name already exists

deleteAgentPool

@NotNull
public AgentPool deleteAgentPool(int agentPoolId)
                          throws NoSuchAgentPoolException,
                                 AgentPoolCannotBeDeletedException

Description copied from interface: AgentPoolManager

Deletes agent pool with the specified identifier. If there are some agent types those belong to this pool, they will be moved to default pool.

Specified by:

deleteAgentPool in interface AgentPoolManager

Parameters:

agentPoolId - agent pool id

Returns:

previous state of the agent pool

Throws:

NoSuchAgentPoolException - if the specified agent pool does not exist

AgentPoolCannotBeDeletedException - if it is an attempt to delete default agent pool

moveAgentTypesToPool

public void moveAgentTypesToPool(int agentPoolId,
                                 @NotNull
                                 Set<Integer> agentTypeIds)
                          throws NoSuchAgentPoolException,
                                 PoolQuotaExceededException,
                                 AgentTypeCannotBeMovedException

Description copied from interface: AgentPoolManager

Moves specified agent types to the specified pool.

Specified by:

moveAgentTypesToPool in interface AgentPoolManager

Parameters:

agentPoolId - agent pool id

agentTypeIds - agent type ids

Throws:

NoSuchAgentPoolException - if the specified agent pool does not exist

PoolQuotaExceededException - if pool quota cannot accept desired # of agents

AgentTypeCannotBeMovedException

moveAgentTypesToProjectPool

public void moveAgentTypesToProjectPool(@NotNull
                                        String projectId,
                                        @NotNull
                                        Set<Integer> agentTypeIds)
                                 throws PoolQuotaExceededException,
                                        AgentTypeCannotBeMovedException

Description copied from interface: AgentPoolManager

Moves the specified agent types to the project agents pool corresponding to the specified project id (pool will be created if it does not exist)

Specified by:

moveAgentTypesToProjectPool in interface AgentPoolManager

Throws:

PoolQuotaExceededException

AgentTypeCannotBeMovedException

ensureAgentTypeIsAssignedToPool

public void ensureAgentTypeIsAssignedToPool(int agentTypeId)

Description copied from interface: AgentPoolManager

This method ensures that agent type with specified id belongs at least to the default agent pool. A call of this method is required for every new agent type, because newly created agent types no longer belong to default pool by default.

Specified by:

ensureAgentTypeIsAssignedToPool in interface AgentPoolManager

checkAgentPoolCanBeUsedByCloudProfile

@Nullable
public String checkAgentPoolCanBeUsedByCloudProfile(@NotNull
                                                    String cloudProfileId,
                                                    @NotNull
                                                    AgentPool agentPool)

Description copied from interface: AgentPoolManager

Checks if agent from the given cloud profile can be used with a specified pool.

Specified by:

checkAgentPoolCanBeUsedByCloudProfile in interface AgentPoolManager

Parameters:

cloudProfileId - - agent's cloud profile id

agentPool - - destination pool

Returns:

- reason why agents from the given cloud profile cannot be used with specified pool or 'null' otherwise

moveAgentToPool

public void moveAgentToPool(int agentPoolId,
                            @NotNull
                            BuildAgentEx agent)
                     throws NoSuchAgentPoolException,
                            PoolQuotaExceededException,
                            AgentTypeCannotBeMovedException

Description copied from interface: AgentPoolManager

Moves specified agent to the specified pool.

Specified by:

moveAgentToPool in interface AgentPoolManager

Parameters:

agentPoolId - agent pool id

agent - agent

Throws:

NoSuchAgentPoolException - if the specified agent pool does not exist

PoolQuotaExceededException - if pool quota cannot accept desired # of agents

AgentTypeCannotBeMovedException

associateProjectsWithPool

public void associateProjectsWithPool(int agentPoolId,
                                      @NotNull
                                      Set<String> projectIds)
                               throws NoSuchAgentPoolException

Description copied from interface: AgentPoolManager

Associates specified projects with the specified pool. Does not affect projects which are not specified in parameters.

Specified by:

associateProjectsWithPool in interface AgentPoolManager

Parameters:

agentPoolId - agent pool id

projectIds - project ids to associate with the specified pool

Throws:

NoSuchAgentPoolException - if the specified agent pool does not exist

resetPoolsCache

public void resetPoolsCache()

dissociateProjectsFromPool

public void dissociateProjectsFromPool(int agentPoolId,
                                       @NotNull
                                       Set<String> projectIds)
                                throws NoSuchAgentPoolException

Description copied from interface: AgentPoolManager

Dissociates specified projects from the specified pool. Does not affect projects which are not specified in parameters.

Specified by:

dissociateProjectsFromPool in interface AgentPoolManager

Parameters:

agentPoolId - agent pool id

projectIds - project ids to dissociate from the specified pool

Throws:

NoSuchAgentPoolException - if the specified agent pool does not exist

dissociateProjectsFromOtherPools

public void dissociateProjectsFromOtherPools(int agentPoolId,
                                             @NotNull
                                             Set<String> projectIds)

Description copied from interface: AgentPoolManager

Dissociates specified projects from all the pools except the specified one. Does not affect projects which are not specified in parameters. Does not affect agent pool which is specified in parameters.

Specified by:

dissociateProjectsFromOtherPools in interface AgentPoolManager

Parameters:

agentPoolId - agent pool id

projectIds - project ids to dissociate from all the pools except the specified one

copyPoolAssociations

public void copyPoolAssociations(@NotNull
                                 String sourceProjectId,
                                 @NotNull
                                 String targetProjectId)

Description copied from interface: AgentPoolManager

Copies set of pools associations from one project to the other.

Specified by:

copyPoolAssociations in interface AgentPoolManager

Parameters:

sourceProjectId - source

targetProjectId - target

findProjectPoolByProjectId

@Nullable
public AgentPool findProjectPoolByProjectId(@NotNull
                                            String projectId)

Description copied from interface: AgentPoolManager

Creates pool for project in memory, without persisting it to DB

Specified by:

findProjectPoolByProjectId in interface AgentPoolManager

afterCleanup

public void afterCleanup(@NotNull
                         CleanupProcessState cleanupState)

Description copied from interface: AfterBuildsCleanupExtension

Invoked upon finishing of the main cleanup process. At this point all data for specific builds is deleted.
Note: This extension might not be called for every cleanup run as cleanup process can be interrupted earlier. Extension must check cleanup process state and if it is interrupted, complete its operations and return as quick as possible.

Specified by:

afterCleanup in interface AfterBuildsCleanupExtension

Parameters:

cleanupState - cleanup process state