Package com.atlassian.bamboo.task

Class AbstractTaskConfigurator

java.lang.Object

com.atlassian.bamboo.task.AbstractTaskConfigurator

All Implemented Interfaces:

TaskConfigurator

Direct Known Subclasses:

AbstractMavenBuildTaskConfigurator, AbstractRepositoryAwareTaskConfigurator, AbstractShellCommandTaskConfigurator, AntBuildTaskConfigurator, ArtifactDownloaderTaskConfigurator, GrailsTaskConfigurator, InjectVariablesTaskConfigurator, MavenDependenciesProcessorTaskConfigurator, PhpUnitBuildTaskConfigurator, TestResultsParserTaskConfigurator

public abstract class AbstractTaskConfigurator
extends Object
implements TaskConfigurator

Field Summary

Fields

Modifier and Type	Field	Description
protected BambooAuthenticationContext	bambooAuthenticationContext	Deprecated. since 6.8 inject your own instance
protected TaskConfiguratorHelper	taskConfiguratorHelper	Deprecated. since 6.8 inject your own instance

Constructor Summary

Constructors

Constructor	Description
AbstractTaskConfigurator()

Method Summary

Modifier and Type	Method	Description
Set<Requirement>	calculateRequirements(@NotNull TaskDefinition taskDefinition, @NotNull Buildable job)	Deprecated. since 5.0
Set<Requirement>	calculateRequirements(@NotNull TaskDefinition taskDefinition, @NotNull Job job)
@NotNull Map<String,String>	generateTaskConfigMap(@NotNull ActionParametersMap params, @Nullable TaskDefinition previousTaskDefinition)	Convert the params from the ui into a config map to be stored in the database for the taskDefinition.
protected I18nBean	getI18nBean()
void	populateContextForCreate(@NotNull Map<String,Object> context)	Provide any required context to be used when rendering the freemarker template for creating a task definition.
void	populateContextForEdit(@NotNull Map<String,Object> context, @NotNull TaskDefinition taskDefinition)	Provide any required context to be used when rendering the freemarker template for view editing a task definition
void	populateContextForView(@NotNull Map<String,Object> context, @NotNull TaskDefinition taskDefinition)	Deprecated. since 5.13, tasks do not have view UI anymore and any overrides of this method are not executed
void	setAuthenticationContext(BambooAuthenticationContext bambooAuthenticationContext)	Deprecated. since 6.8 use constructor injection or annotation injection
void	setTaskConfiguratorHelper(TaskConfiguratorHelper taskConfiguratorHelper)	Deprecated. since 6.8 use constructor injection or annotation injection
void	validate(@NotNull ActionParametersMap params, @NotNull ErrorCollection errorCollection)	Validate the params submitted from the UI for this task definition

Methods inherited from class java.lang.Object

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

Field Detail

taskConfiguratorHelper

@Deprecated
protected TaskConfiguratorHelper taskConfiguratorHelper

Deprecated.

since 6.8 inject your own instance

bambooAuthenticationContext

@Deprecated
protected BambooAuthenticationContext bambooAuthenticationContext

Deprecated.

since 6.8 inject your own instance

Constructor Detail

AbstractTaskConfigurator

public AbstractTaskConfigurator()

Method Detail

generateTaskConfigMap

@NotNull
public @NotNull Map<String,String> generateTaskConfigMap(@NotNull
                                                               @NotNull ActionParametersMap params,
                                                               @Nullable
                                                               @Nullable TaskDefinition previousTaskDefinition)

Description copied from interface: TaskConfigurator

Convert the params from the ui into a config map to be stored in the database for the taskDefinition. Can assume validation has occurred in the #validate method

Specified by:

generateTaskConfigMap in interface TaskConfigurator

Parameters:

params - - request paramaters

previousTaskDefinition - - the previous immutable TaskDefinition before saving or null if Task is being created

Returns:

the configuration map to be stored in the database

populateContextForCreate

public void populateContextForCreate(@NotNull
                                     @NotNull Map<String,Object> context)

Description copied from interface: TaskConfigurator

Provide any required context to be used when rendering the freemarker template for creating a task definition. Allows you to add any default values for initial creation

Specified by:

populateContextForCreate in interface TaskConfigurator

Parameters:

context - map to put your context in.

populateContextForEdit

public void populateContextForEdit(@NotNull
                                   @NotNull Map<String,Object> context,
                                   @NotNull
                                   @NotNull TaskDefinition taskDefinition)

Description copied from interface: TaskConfigurator

Provide any required context to be used when rendering the freemarker template for view editing a task definition

Specified by:

populateContextForEdit in interface TaskConfigurator

Parameters:

context - map to put your context in.

taskDefinition - existing task definition

populateContextForView

@Deprecated
public void populateContextForView(@NotNull
                                   @NotNull Map<String,Object> context,
                                   @NotNull
                                   @NotNull TaskDefinition taskDefinition)

Deprecated.

since 5.13, tasks do not have view UI anymore and any overrides of this method are not executed

validate

public void validate(@NotNull
                     @NotNull ActionParametersMap params,
                     @NotNull
                     @NotNull ErrorCollection errorCollection)

Description copied from interface: TaskConfigurator

Validate the params submitted from the UI for this task definition

Specified by:

validate in interface TaskConfigurator

Parameters:

params - - request paramaters

errorCollection - - collection to put any errors in.

getI18nBean

protected final I18nBean getI18nBean()

calculateRequirements

public Set<Requirement> calculateRequirements(@NotNull
                                              @NotNull TaskDefinition taskDefinition,
                                              @NotNull
                                              @NotNull Job job)

calculateRequirements

@Deprecated
public Set<Requirement> calculateRequirements(@NotNull
                                              @NotNull TaskDefinition taskDefinition,
                                              @NotNull
                                              @NotNull Buildable job)

Deprecated.

since 5.0

For backward compatibility.

setTaskConfiguratorHelper

@Deprecated
public void setTaskConfiguratorHelper(TaskConfiguratorHelper taskConfiguratorHelper)

Deprecated.

since 6.8 use constructor injection or annotation injection

setAuthenticationContext

@Deprecated
public void setAuthenticationContext(BambooAuthenticationContext bambooAuthenticationContext)

Deprecated.

since 6.8 use constructor injection or annotation injection