Package jetbrains.buildServer.serverSide.impl.auth

Class SecuredBuildAgentManager

java.lang.Object

jetbrains.buildServer.serverSide.impl.auth.SecuredBuildAgentManager

All Implemented Interfaces:

AgentDistributionMonitorAware, BuildAgentManager, BuildAgentManagerEx, BuildAgentDistributionMonitorAware

public class SecuredBuildAgentManager
extends Object
implements BuildAgentManagerEx, BuildAgentDistributionMonitorAware

Author:

Sergey.Anchipolevsky Date: 24.09.2007

Nested Class Summary

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

BuildAgentManager.RunConfigurationPolicy

Constructor Summary

Constructors

Constructor	Description
SecuredBuildAgentManager(SecurityContextEx securityContext)

Method Summary

Modifier and Type	Method	Description
BuildAgentEx	findAgentById(int agentId, boolean searchUnregistered)	Searches for an agent with specified id among registered and unregistered agents.
BuildAgentEx	findAgentByName(String agentName, boolean searchUnregistered)	Searches for an agent with specified name among registered and unregistered agents.
List<BuildAgentEx>	findAgentsByAgentTypeIds(Set<Integer> agentTypeIds, boolean searchUnregistered)
<T extends SBuildAgent> List<AgentCompatibility>	getAgentCompatibilities(T agent)	Returns build configuration compatibility information for the specified agent
List<BuildAgentEx>	getAllAgents()
List<BuildAgentEx>	getAllAgents(boolean includeUnauthorized)
<T extends SBuildAgent> Set<String>	getCanRunConfigurations(T agent)	Returns list of build configurations this agent can potentially run.
<T extends SBuildAgent> int	getNumberOfCompatibleConfigurations(T agent)	Returns number of configurations compatible with specified agent
<T extends SBuildAgent> int	getNumberOfIncompatibleConfigurations(T agent)	Returns number of configurations incompatible with specified agent
int	getNumberOfRegisteredAgents()	Returns number of registered and authorized agents
List<BuildAgentEx>	getRegisteredAgents()	Returns all registered authorized agents.
List<BuildAgentEx>	getRegisteredAgents(boolean includeUnauthorized)	Returns all registered agents.
<T extends SBuildAgent> BuildAgentManager.RunConfigurationPolicy	getRunConfigurationPolicy(T agent)	Returns run configuration policy for an agent.
List<BuildAgentEx>	getUnregisteredAgents()	Returns list of all currently unregistered and authorized agents, i.e.
List<BuildAgentEx>	getUnregisteredAgents(boolean includeUnauthorized)	Returns list of all currently unregistered agents, with additional filter based on authorization status.
<T extends SBuildAgent> boolean	isCanRunConfiguration(T agent, BuildTypeDescriptor buildType)	Returns true if specified agent can run specified build configuration.
void	pingAllAgents()
BuildAgentEx	registerAgent(BuildAgentEx agent, long currentlyRunningBuildId)	Returns the registered agent - the same instance as was passed in the parameters if this is a new registration, or another instance if such agent is already registered.
boolean	registrationIsTemporallyNotAvailable()
void	removeAgent(SBuildAgent agent, SUser user)	Removes specified agent and cleans up this agent state from the database.
void	setAgentDistributionMonitor(AgentDistributionMonitor monitor)
void	setAgentPoolManager(AgentPoolManager agentPoolManager)
void	setAgentTypeManager(AgentTypeManager agentTypeManager)
<T extends SBuildAgent> void	setCanRunConfiguration(T agent, String buildTypeId, boolean canRun)	If BuildAgentManager.RunConfigurationPolicy.SELECTED_COMPATIBLE_CONFIGURATIONS policy is selected for the agent, sets whether configuration with specified id can or can't run on the agent.
void	setDelegate(BuildAgentManagerEx delegate)
void	setProjectManager(ProjectManager projectManager)
<T extends SBuildAgent> void	setRunConfigurationPolicy(T agent, BuildAgentManager.RunConfigurationPolicy policy)	Sets build configuration run policy for an agent.
void	unregisterAgent(int agentId)
void	unregisterAgent(int id, String reason)
void	unregisterAllAgents(String reason, boolean shouldCancelRunningBuilds)
void	updateAgentParameters(int agentId, String authorizationToken, AgentDescription newAgentDescription)	Sets agent parameters to the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecuredBuildAgentManager

public SecuredBuildAgentManager(@NotNull
                                SecurityContextEx securityContext)

Method Detail

setDelegate

public void setDelegate(@NotNull
                        BuildAgentManagerEx delegate)

setProjectManager

public void setProjectManager(@NotNull
                              ProjectManager projectManager)

setAgentPoolManager

public void setAgentPoolManager(@NotNull
                                AgentPoolManager agentPoolManager)

setAgentTypeManager

public void setAgentTypeManager(@NotNull
                                AgentTypeManager agentTypeManager)

registerAgent

@NotNull
public BuildAgentEx registerAgent(BuildAgentEx agent,
                                  long currentlyRunningBuildId)
                           throws TeamCityRuntimeException

Description copied from interface: BuildAgentManagerEx

Returns the registered agent - the same instance as was passed in the parameters if this is a new registration, or another instance if such agent is already registered.

Specified by:

registerAgent in interface BuildAgentManagerEx

Throws:

TeamCityRuntimeException

updateAgentParameters

public void updateAgentParameters(int agentId,
                                  @NotNull
                                  String authorizationToken,
                                  @NotNull
                                  AgentDescription newAgentDescription)

Description copied from interface: BuildAgentManagerEx

Sets agent parameters to the database.

This method is called by an agent when its parameters are changes, i.e. if one of agent-side plugins has changed agents parameters.

Specified by:

updateAgentParameters in interface BuildAgentManagerEx

unregisterAgent

public void unregisterAgent(int agentId)

Specified by:

unregisterAgent in interface BuildAgentManagerEx

unregisterAgent

public void unregisterAgent(int id,
                            String reason)

Specified by:

unregisterAgent in interface BuildAgentManagerEx

unregisterAllAgents

public void unregisterAllAgents(String reason,
                                boolean shouldCancelRunningBuilds)

Specified by:

unregisterAllAgents in interface BuildAgentManagerEx

pingAllAgents

public void pingAllAgents()

Specified by:

pingAllAgents in interface BuildAgentManagerEx

getRegisteredAgents

public List<BuildAgentEx> getRegisteredAgents(boolean includeUnauthorized)

Description copied from interface: BuildAgentManager

Returns all registered agents. Registered means connected at the moment of call.

Specified by:

getRegisteredAgents in interface BuildAgentManager

Specified by:

getRegisteredAgents in interface BuildAgentManagerEx

Parameters:

includeUnauthorized - if true, unauthorized agents, i.e. agents which cannot run builds until authorized by admin

Returns:

see above

getRegisteredAgents

public List<BuildAgentEx> getRegisteredAgents()

Description copied from interface: BuildAgentManager

Returns all registered authorized agents. Registered means connected at the moment of call.

Specified by:

getRegisteredAgents in interface BuildAgentManager

Specified by:

getRegisteredAgents in interface BuildAgentManagerEx

Returns:

see above

getUnregisteredAgents

public List<BuildAgentEx> getUnregisteredAgents(boolean includeUnauthorized)

Description copied from interface: BuildAgentManager

Returns list of all currently unregistered agents, with additional filter based on authorization status. See also BuildAgentManager.getUnregisteredAgents()

Specified by:

getUnregisteredAgents in interface BuildAgentManager

Specified by:

getUnregisteredAgents in interface BuildAgentManagerEx

Parameters:

includeUnauthorized - whether to include or exclude unauthorized agents

Returns:

list of all currently unregistered agents

getUnregisteredAgents

public List<BuildAgentEx> getUnregisteredAgents()

Description copied from interface: BuildAgentManager

Returns list of all currently unregistered and authorized agents, i.e. agents registered on server some time ago, but currently unregistered by server because they are either not responding, or upgrading. This list doesn't include unauthorized agents. The list is sorted by agent registration date in reverse order.

Specified by:

getUnregisteredAgents in interface BuildAgentManager

Specified by:

getUnregisteredAgents in interface BuildAgentManagerEx

Returns:

list of all currently unregistered agents

getAllAgents

public List<BuildAgentEx> getAllAgents()

Specified by:

getAllAgents in interface BuildAgentManagerEx

getAllAgents

public List<BuildAgentEx> getAllAgents(boolean includeUnauthorized)

Specified by:

getAllAgents in interface BuildAgentManagerEx

findAgentById

@Nullable
public BuildAgentEx findAgentById(int agentId,
                                  boolean searchUnregistered)

Description copied from interface: BuildAgentManager

Searches for an agent with specified id among registered and unregistered agents.

Specified by:

findAgentById in interface BuildAgentManager

Specified by:

findAgentById in interface BuildAgentManagerEx

Parameters:

agentId - id of the agent to search

searchUnregistered - true if unregistered agents should be searched too

Returns:

found agent or null

findAgentByName

@Nullable
public BuildAgentEx findAgentByName(@NotNull
                                    String agentName,
                                    boolean searchUnregistered)

Description copied from interface: BuildAgentManager

Searches for an agent with specified name among registered and unregistered agents.

Specified by:

findAgentByName in interface BuildAgentManager

Specified by:

findAgentByName in interface BuildAgentManagerEx

Parameters:

agentName - name of the agent to search

searchUnregistered - true if unregistered agents should be searched too

Returns:

found agent or null

findAgentsByAgentTypeIds

@NotNull
public List<BuildAgentEx> findAgentsByAgentTypeIds(@NotNull
                                                   Set<Integer> agentTypeIds,
                                                   boolean searchUnregistered)

Specified by:

findAgentsByAgentTypeIds in interface BuildAgentManagerEx

removeAgent

public void removeAgent(@NotNull
                        SBuildAgent agent,
                        @Nullable
                        SUser user)
                 throws AgentCannotBeRemovedException

Description copied from interface: BuildAgentManager

Removes specified agent and cleans up this agent state from the database. Only unregistered agents can be removed.

Specified by:

removeAgent in interface BuildAgentManager

Parameters:

agent - agent

user - user who removes agent (can be null)

Throws:

AgentCannotBeRemovedException - if agent is connected/registered

setRunConfigurationPolicy

public <T extends SBuildAgent> void setRunConfigurationPolicy(T agent,
                                                              BuildAgentManager.RunConfigurationPolicy policy)

Description copied from interface: BuildAgentManager

Sets build configuration run policy for an agent. Possible values are:

• BuildAgentManager.RunConfigurationPolicy.ALL_COMPATIBLE_CONFIGURATIONS - all compatible configurations can run on this agent
• BuildAgentManager.RunConfigurationPolicy.SELECTED_COMPATIBLE_CONFIGURATIONS - only selected configurations can run on this agent (configuration needs to be compatible too)

Specified by:

setRunConfigurationPolicy in interface BuildAgentManager

Parameters:

agent - the agent

policy - policy to set

getRunConfigurationPolicy

public <T extends SBuildAgent> BuildAgentManager.RunConfigurationPolicy getRunConfigurationPolicy(T agent)

Description copied from interface: BuildAgentManager

Returns run configuration policy for an agent.

Specified by:

getRunConfigurationPolicy in interface BuildAgentManager

Parameters:

agent - the agent

Returns:

current run configuration policy

setCanRunConfiguration

public <T extends SBuildAgent> void setCanRunConfiguration(T agent,
                                                           String buildTypeId,
                                                           boolean canRun)

Description copied from interface: BuildAgentManager

If BuildAgentManager.RunConfigurationPolicy.SELECTED_COMPATIBLE_CONFIGURATIONS policy is selected for the agent, sets whether configuration with specified id can or can't run on the agent.

Specified by:

setCanRunConfiguration in interface BuildAgentManager

Parameters:

agent - the agent

buildTypeId - id of the configuration

canRun - if true then this configuration can run on the agent, if false it can't

isCanRunConfiguration

public <T extends SBuildAgent> boolean isCanRunConfiguration(T agent,
                                                             BuildTypeDescriptor buildType)

Description copied from interface: BuildAgentManager

Returns true if specified agent can run specified build configuration.

Specified by:

isCanRunConfiguration in interface BuildAgentManager

Parameters:

agent - the agent

buildType - build configuration

Returns:

true if BuildAgentManager.RunConfigurationPolicy.ALL_COMPATIBLE_CONFIGURATIONS policy selected or configuration was explicitly marked as accessible by the agent. Please note that compatibility check is not performed.

getCanRunConfigurations

public <T extends SBuildAgent> Set<String> getCanRunConfigurations(T agent)

Description copied from interface: BuildAgentManager

Returns list of build configurations this agent can potentially run.

Specified by:

getCanRunConfigurations in interface BuildAgentManager

Parameters:

agent - the agent

Returns:

list of ids of potentially available for this agent configurations

getNumberOfCompatibleConfigurations

public <T extends SBuildAgent> int getNumberOfCompatibleConfigurations(T agent)

Description copied from interface: BuildAgentManager

Returns number of configurations compatible with specified agent

Specified by:

getNumberOfCompatibleConfigurations in interface BuildAgentManager

Parameters:

agent - agent

Returns:

number of compatible configurations

getNumberOfIncompatibleConfigurations

public <T extends SBuildAgent> int getNumberOfIncompatibleConfigurations(T agent)

Description copied from interface: BuildAgentManager

Returns number of configurations incompatible with specified agent

Specified by:

getNumberOfIncompatibleConfigurations in interface BuildAgentManager

Parameters:

agent - agent

Returns:

number of incompatible configurations

getAgentCompatibilities

public <T extends SBuildAgent> List<AgentCompatibility> getAgentCompatibilities(T agent)

Description copied from interface: BuildAgentManager

Returns build configuration compatibility information for the specified agent

Specified by:

getAgentCompatibilities in interface BuildAgentManager

Parameters:

agent - agent

Returns:

build configuration compatibility information

getNumberOfRegisteredAgents

public int getNumberOfRegisteredAgents()

Description copied from interface: BuildAgentManager

Returns number of registered and authorized agents

Specified by:

getNumberOfRegisteredAgents in interface BuildAgentManager

Returns:

see above

setAgentDistributionMonitor

public void setAgentDistributionMonitor(@NotNull
                                        AgentDistributionMonitor monitor)

Specified by:

setAgentDistributionMonitor in interface AgentDistributionMonitorAware

Specified by:

setAgentDistributionMonitor in interface BuildAgentManagerEx

registrationIsTemporallyNotAvailable

public boolean registrationIsTemporallyNotAvailable()

Specified by:

registrationIsTemporallyNotAvailable in interface BuildAgentManagerEx