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

AbstractShellCommandTaskConfigurator()

Method Summary

java.util.Map<java.lang.String,java.lang.String>	generateTaskConfigMap(ActionParametersMap params, TaskDefinition previousTaskDefinition) Convert the params from the ui into a config map to be stored in the database for the taskDefinition.
protected abstract java.util.List<java.lang.String>	getFieldsToCopy()
void	populateContextForCreate(java.util.Map<java.lang.String,java.lang.Object> context) Provide any required context to be used when rendering the freemarker template for creating a task definition.
void	populateContextForEdit(java.util.Map<java.lang.String,java.lang.Object> context, TaskDefinition taskDefinition) Provide any required context to be used when rendering the freemarker template for view editing a task definition
void	populateContextForView(java.util.Map<java.lang.String,java.lang.Object> context, TaskDefinition taskDefinition) Provide any required context to be used when rendering the freemarker template for viewing a task definition
void	setUiConfigBean(UIConfigBean uiConfigBean)
abstract void	validate(ActionParametersMap params, ErrorCollection errorCollection) Validate the params submitted from the UI for this task definition

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

getI18nBean, setAuthenticationContext, setTaskConfiguratorHelper

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractShellCommandTaskConfigurator

public AbstractShellCommandTaskConfigurator()

Method Detail

getFieldsToCopy

@NotNull
protected abstract java.util.List<java.lang.String> getFieldsToCopy()

validate

public abstract void validate(@NotNull
                              ActionParametersMap params,
                              @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
                                     java.util.Map<java.lang.String,java.lang.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.

populateContextForView

public void populateContextForView(@NotNull
                                   java.util.Map<java.lang.String,java.lang.Object> context,
                                   @NotNull
                                   TaskDefinition taskDefinition)

Description copied from interface: TaskConfigurator

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

Specified by:

populateContextForView in interface TaskConfigurator

Overrides:

populateContextForView in class AbstractTaskConfigurator

Parameters:

context - map to put your context in.

taskDefinition - existing task definition

populateContextForEdit

public void populateContextForEdit(@NotNull
                                   java.util.Map<java.lang.String,java.lang.Object> context,
                                   @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 java.util.Map<java.lang.String,java.lang.String> generateTaskConfigMap(@NotNull
                                                                                      ActionParametersMap params,
                                                                                      @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 occured 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

setUiConfigBean

public void setUiConfigBean(UIConfigBean uiConfigBean)