Package com.atlassian.bamboo.plan

Class ExecutableAgentsHelperImpl

java.lang.Object

com.atlassian.bamboo.plan.ExecutableAgentsHelperImpl

All Implemented Interfaces:

ExecutableAgentsHelper

public class ExecutableAgentsHelperImpl
extends Object
implements ExecutableAgentsHelper

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.plan.ExecutableAgentsHelper

ExecutableAgentsHelper.ExecutableQuery, ExecutableAgentsHelper.ExecutorQuery

Constructor Summary

Constructors

Constructor

Description

ExecutableAgentsHelperImpl(CachedPlanManager cachedPlanManager, ExecutionStatusProvider executionStatusProvider, com.atlassian.plugin.PluginAccessor pluginAccessor, AgentAssignmentService agentAssignmentService, CapabilityRequirementsMatcher capabilityRequirementsMatcher, CapabilitySetManager capabilitySetManager, ElasticInstanceManager elasticInstanceManager, ElasticImageConfigurationAccessor elasticImageConfigurationAccessor, EphemeralAgentsService ephemeralAgentsService, EnvironmentCustomConfigService environmentCustomConfigService)

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(@NotNull ExecutableAgentsHelper.ExecutorQuery executorQuery, @NotNull EphemeralAgentTemplate ephemeralAgentTemplate)	Checks if the given template is applicable for the given query - whether the template meets the query requirements.
boolean	canExecute(@NotNull BuildAgent buildAgent, @NotNull CommonContext context, @NotNull ImmutableRequirementSet requirements)	Returns true or false depending on whether the agent can execute the given context, taking into account requirement set and other global settings such as agent assignments.
@NotNull Collection<BuildAgent>	getExecutableAgents(@NotNull ExecutableAgentsHelper.ExecutorQuery executorQuery)
ExecutableAgentsMatrix	getExecutableAgentsMatrix(@NotNull ExecutableAgentsHelper.ExecutorQuery executorQuery)
@NotNull Collection<ImmutableBuildable>	getExecutableBuildables(@NotNull ExecutableAgentsHelper.ExecutableQuery executableQuery)	Collection of buildables for which this agent can execute.
@NotNull Collection<ImmutableBuildable>	getExecutableBuildables(ExecutableAgentsHelper.ExecutableQuery executableQuery, Predicate<? super ImmutableBuildable> filter)	Collection of buildables for which this agent can execute.
@NotNull Collection<Environment>	getExecutableEnvironments(@NotNull ExecutableAgentsHelper.ExecutableQuery executableQuery)
@NotNull Collection<EphemeralAgentTemplate>	getExecutableEphemeralAgentTemplates(@NotNull ExecutableAgentsHelper.ExecutorQuery executorQuery)	Calculates the list of ephemeral agents templates that are capable of running an agent that can build a Buildable plan.
Collection<ElasticImageConfiguration>	getExecutableImages(@NotNull ExecutableAgentsHelper.ExecutorQuery executorQuery)	Calculates the list of elastic images that are capable of running an agent that can build a Buildable plan.
boolean	isAgentEligibleForReceivingJobs(long agentId)	This method checks if agent is eligible to receive new jobs.
boolean	planHasExecutableAgents(@NotNull PlanKey planKey, boolean includeDisabled)	Checks if a Buildable can be built on any active agent.
boolean	planHasExecutableAgents(@NotNull PlanResultKey planResultKey)	Checks if a Job can be built on any active agent.
void	resendStopAgentMessageIfRequired(long agentId)	If agent is online and BuildAgent.isRequestedToBeStopped() is true, the system will re-request the agent stop.

Methods inherited from class java.lang.Object

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

Constructor Details

ExecutableAgentsHelperImpl

public ExecutableAgentsHelperImpl(CachedPlanManager cachedPlanManager,
 ExecutionStatusProvider executionStatusProvider,
 com.atlassian.plugin.PluginAccessor pluginAccessor,
 AgentAssignmentService agentAssignmentService,
 CapabilityRequirementsMatcher capabilityRequirementsMatcher,
 CapabilitySetManager capabilitySetManager,
 ElasticInstanceManager elasticInstanceManager,
 ElasticImageConfigurationAccessor elasticImageConfigurationAccessor,
 EphemeralAgentsService ephemeralAgentsService,
 EnvironmentCustomConfigService environmentCustomConfigService)

Method Details

getExecutableAgents

@NotNull
@Transactional
public @NotNull Collection<BuildAgent> getExecutableAgents(@NotNull
 @NotNull ExecutableAgentsHelper.ExecutorQuery executorQuery)

Specified by:

getExecutableAgents in interface ExecutableAgentsHelper

canExecute

public boolean canExecute(@NotNull
 @NotNull BuildAgent buildAgent,
 @NotNull
 @NotNull CommonContext context,
 @NotNull
 @NotNull ImmutableRequirementSet requirements)

Description copied from interface: ExecutableAgentsHelper

Returns true or false depending on whether the agent can execute the given context, taking into account requirement set and other global settings such as agent assignments.

Specified by:

canExecute in interface ExecutableAgentsHelper

getExecutableAgentsMatrix

public ExecutableAgentsMatrix getExecutableAgentsMatrix(@NotNull
 @NotNull ExecutableAgentsHelper.ExecutorQuery executorQuery)

Specified by:

getExecutableAgentsMatrix in interface ExecutableAgentsHelper

isAgentEligibleForReceivingJobs

public boolean isAgentEligibleForReceivingJobs(long agentId)

Description copied from interface: ExecutableAgentsHelper

This method checks if agent is eligible to receive new jobs.

Specified by:

isAgentEligibleForReceivingJobs in interface ExecutableAgentsHelper

Returns:

true iff agent it's ok to receive jobs (i.e. we haven't requested it's shutdown)

resendStopAgentMessageIfRequired

public void resendStopAgentMessageIfRequired(long agentId)

Description copied from interface: ExecutableAgentsHelper

If agent is online and BuildAgent.isRequestedToBeStopped() is true, the system will re-request the agent stop.

Specified by:

resendStopAgentMessageIfRequired in interface ExecutableAgentsHelper

getExecutableImages

public Collection<ElasticImageConfiguration> getExecutableImages(@NotNull
 @NotNull ExecutableAgentsHelper.ExecutorQuery executorQuery)

Description copied from interface: ExecutableAgentsHelper

Calculates the list of elastic images that are capable of running an agent that can build a Buildable plan.

Specified by:

getExecutableImages in interface ExecutableAgentsHelper

getExecutableEphemeralAgentTemplates

@NotNull
public @NotNull Collection<EphemeralAgentTemplate> getExecutableEphemeralAgentTemplates(@NotNull
 @NotNull ExecutableAgentsHelper.ExecutorQuery executorQuery)

Description copied from interface: ExecutableAgentsHelper

Calculates the list of ephemeral agents templates that are capable of running an agent that can build a Buildable plan.

Specified by:

getExecutableEphemeralAgentTemplates in interface ExecutableAgentsHelper

Returns:

collection of ephemeral agent templates that match the query

canExecute

public boolean canExecute(@NotNull
 @NotNull ExecutableAgentsHelper.ExecutorQuery executorQuery,
 @NotNull
 @NotNull EphemeralAgentTemplate ephemeralAgentTemplate)

Description copied from interface: ExecutableAgentsHelper

Checks if the given template is applicable for the given query - whether the template meets the query requirements.

Specified by:

canExecute in interface ExecutableAgentsHelper

Parameters:

executorQuery - query to check

ephemeralAgentTemplate - template to check

Returns:

true if the template is applicable for the query, false otherwise

planHasExecutableAgents

@Transactional
public boolean planHasExecutableAgents(@NotNull
 @NotNull PlanKey planKey,
 boolean includeDisabled)

Checks if a Buildable can be built on any active agent. This implementation utilises information already available in ExecutionStatus if it exists.

Specified by:

planHasExecutableAgents in interface ExecutableAgentsHelper

Parameters:

planKey -

includeDisabled - indicate whether disabled agents should be included in checking

Returns:

planHasExecutableAgents

@Transactional
public boolean planHasExecutableAgents(@NotNull
 @NotNull PlanResultKey planResultKey)

Checks if a Job can be built on any active agent. This implementation utilises information already available in ExecutionStatus if it exists.

Specified by:

planHasExecutableAgents in interface ExecutableAgentsHelper

Parameters:

planResultKey -

Returns:

getExecutableBuildables

@NotNull
public @NotNull Collection<ImmutableBuildable> getExecutableBuildables(@NotNull
 @NotNull ExecutableAgentsHelper.ExecutableQuery executableQuery)

Description copied from interface: ExecutableAgentsHelper

Collection of buildables for which this agent can execute. Checks capabilities and agent assignments

Specified by:

getExecutableBuildables in interface ExecutableAgentsHelper

getExecutableBuildables

@NotNull
public @NotNull Collection<ImmutableBuildable> getExecutableBuildables(ExecutableAgentsHelper.ExecutableQuery executableQuery,
 Predicate<? super ImmutableBuildable> filter)

Description copied from interface: ExecutableAgentsHelper

Collection of buildables for which this agent can execute. Checks capabilities and agent assignments

Specified by:

getExecutableBuildables in interface ExecutableAgentsHelper

getExecutableEnvironments

@NotNull
public @NotNull Collection<Environment> getExecutableEnvironments(@NotNull
 @NotNull ExecutableAgentsHelper.ExecutableQuery executableQuery)

Specified by:

getExecutableEnvironments in interface ExecutableAgentsHelper

Returns:

collection of environments that can be executed using given set of capabilities/assignments