Package com.atlassian.bamboo.plugins.shell.configuration

Class AbstractShellCommandTaskConfigurator

java.lang.Object

com.atlassian.bamboo.task.AbstractTaskConfigurator

com.atlassian.bamboo.plugins.shell.configuration.AbstractShellCommandTaskConfigurator

All Implemented Interfaces:

TaskConfigurator

Direct Known Subclasses:

CommandBuildTaskConfigurator, ScriptBuildTaskConfigurator

public abstract class AbstractShellCommandTaskConfigurator
extends AbstractTaskConfigurator

Field Summary

Fields inherited from class com.atlassian.bamboo.task.AbstractTaskConfigurator

bambooAuthenticationContext, taskConfiguratorHelper

Constructor Summary

Constructors

Constructor	Description
AbstractShellCommandTaskConfigurator()

Method Summary

Modifier and Type	Method	Description
@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 abstract @NotNull List<String>	getFieldsToCopy()
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	setUiConfigSupport(UIConfigSupport uiConfigSupport)
abstract void	validate(@NotNull ActionParametersMap params, @NotNull ErrorCollection errorCollection)	Validate the params submitted from the UI for this task definition

Methods inherited from class com.atlassian.bamboo.task.AbstractTaskConfigurator

calculateRequirements, calculateRequirements, getI18nBean, populateContextForView, setAuthenticationContext, setTaskConfiguratorHelper

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractShellCommandTaskConfigurator

public AbstractShellCommandTaskConfigurator()

Method Details

getFieldsToCopy

@NotNull
protected abstract @NotNull List<String> getFieldsToCopy()

validate

public abstract 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

Overrides:

validate in class AbstractTaskConfigurator

Parameters:

params - - request paramaters

errorCollection - - collection to put any errors in.

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

Overrides:

populateContextForCreate in class AbstractTaskConfigurator

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

Overrides:

populateContextForEdit in class AbstractTaskConfigurator

Parameters:

context - map to put your context in.

taskDefinition - existing task definition

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

Overrides:

generateTaskConfigMap in class AbstractTaskConfigurator

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

setUiConfigSupport

public void setUiConfigSupport(UIConfigSupport uiConfigSupport)