com.atlassian.bamboo.deployments.environments
Interface DeploymentTaskRequirementSupport

All Known Subinterfaces:
RepositoryAwareDeploymentTaskConfigurator
All Known Implementing Classes:
AbstractRepositoryAwareTaskConfigurator, VcsBranchingTaskConfigurator, VcsCheckoutTaskConfigurator, VcsTaggingTaskConfigurator

public interface DeploymentTaskRequirementSupport

Allows creators of TaskTypes to specify Requirements. There are three interfaces which you can use for this purpose TaskRequirementSupport: Preferred option. Will work for both deployment environments and for jobs (you can not implement the other interfaces if using this) BuildTaskRequirementSupport: Supports Jobs only. Only use if you require the job information to generate your task's requirements (can be used in conjunction with DeploymentTaskRequirementSupport) DeploymentTaskRequirementSupport: Supports Environments only. Only use if you require the environment information to generate your task's requirements (can be used in conjunction with BuildTaskRequirementSupport)

Since:
5.0

Method Summary
 java.util.Set<Requirement> calculateRequirements(TaskDefinition taskDefinition, Environment environment)
          Populates the RequirementSet needed based off of the TaskDefinition
 

Method Detail

calculateRequirements

@NotNull
java.util.Set<Requirement> calculateRequirements(@NotNull
                                                         TaskDefinition taskDefinition,
                                                         @NotNull
                                                         Environment environment)
Populates the RequirementSet needed based off of the TaskDefinition

Parameters:
taskDefinition - the task definition that would be causing the requirement to be needed.
environment - the task definition belongs to
Returns:
requirements


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.