com.atlassian.bamboo.plan
Interface PlanExecutableAgentsHelper

All Known Implementing Classes:
PlanExecutableAgentsHelperImpl

public interface PlanExecutableAgentsHelper

Utility class to determine which agents can build a Plan


Method Summary
 java.util.Collection<BuildAgent> getExecutableAgentsForPlan(Buildable buildable, BuildContext buildContext)
          Calculates the list of active agents that can build a Buildable plan based on Requirements and criteria defined in plugins.
 java.util.Collection<ElasticImageConfiguration> getExecutableImagesForPlan(Buildable buildable)
          Calculates the list of elastic images that are capable of running an agent that can build a Buildable plan.
 boolean planHasExecutableAgents(PlanKey planKey, boolean includeDisabled)
          Checks if a Buildable can be built on any defined agent.
 boolean planHasExecutableAgents(PlanResultKey planResultKey)
          Checks if a Buildable can be built on any active agent.
 

Method Detail

planHasExecutableAgents

boolean planHasExecutableAgents(@NotNull
                                PlanKey planKey,
                                boolean includeDisabled)
Checks if a Buildable can be built on any defined agent.

Parameters:
planKey -
includeDisabled - indicate whether disabled agents should be included in checking
Returns:
Throws:
java.lang.IllegalArgumentException - if planKey is not a Buildable key

planHasExecutableAgents

boolean planHasExecutableAgents(@NotNull
                                PlanResultKey planResultKey)
Checks if a Buildable can be built on any active agent.

Parameters:
planResultKey -
Returns:
Throws:
java.lang.IllegalArgumentException - if planResultKey is not a key of running Job

getExecutableAgentsForPlan

java.util.Collection<BuildAgent> getExecutableAgentsForPlan(@NotNull
                                                            Buildable buildable,
                                                            @NotNull
                                                            BuildContext buildContext)
Calculates the list of active agents that can build a Buildable plan based on Requirements and criteria defined in plugins.

Parameters:
buildable -
buildContext -
Returns:

getExecutableImagesForPlan

java.util.Collection<ElasticImageConfiguration> getExecutableImagesForPlan(@NotNull
                                                                           Buildable buildable)
Calculates the list of elastic images that are capable of running an agent that can build a Buildable plan.

Parameters:
buildable -
Returns:


Copyright © 2012 Atlassian. All Rights Reserved.