com.atlassian.bamboo.plugins.variable.inject
Class InjectVariablesTaskConfigurator

java.lang.Object
  com.atlassian.bamboo.task.AbstractTaskConfigurator
      com.atlassian.bamboo.plugins.variable.inject.InjectVariablesTaskConfigurator

All Implemented Interfaces:

TaskConfigurator

public class InjectVariablesTaskConfigurator
extends AbstractTaskConfigurator

Field Summary

static String	CFG_FILEPATH
static String	CFG_NAMESPACE
static String	CFG_SCOPE
static String	CFG_SCOPE_LIST
static String	DEFAULT_NAMESPACE
static com.google.common.collect.ImmutableList<String>	VARIABLE_TYPES

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

bambooAuthenticationContext, taskConfiguratorHelper

Constructor Summary

InjectVariablesTaskConfigurator(com.atlassian.sal.api.message.I18nResolver i18nResolver)

Method Summary

Map<String,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.
void	populateContextForCreate(Map<String,Object> context) Provide any required context to be used when rendering the freemarker template for creating a task definition.
void	populateContextForEdit(Map<String,Object> context, TaskDefinition taskDefinition) Provide any required context to be used when rendering the freemarker template for view editing a task definition
void	populateContextForView(Map<String,Object> context, TaskDefinition taskDefinition) Provide any required context to be used when rendering the freemarker template for viewing a task definition
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

calculateRequirements, calculateRequirements, getI18nBean, setAuthenticationContext, setTaskConfiguratorHelper

Methods inherited from class java.lang.Object

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

Field Detail

CFG_FILEPATH

public static final String CFG_FILEPATH

See Also:

Constant Field Values

CFG_SCOPE

public static final String CFG_SCOPE

See Also:

Constant Field Values

CFG_NAMESPACE

public static final String CFG_NAMESPACE

See Also:

Constant Field Values

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

See Also:

Constant Field Values

CFG_SCOPE_LIST

public static final String CFG_SCOPE_LIST

See Also:

Constant Field Values

VARIABLE_TYPES

public static final com.google.common.collect.ImmutableList<String> VARIABLE_TYPES

Constructor Detail

InjectVariablesTaskConfigurator

public InjectVariablesTaskConfigurator(com.atlassian.sal.api.message.I18nResolver i18nResolver)

Method Detail

generateTaskConfigMap

@NotNull
public Map<String,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

populateContextForCreate

public void populateContextForCreate(@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
                                   Map<String,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

populateContextForView

public void populateContextForView(@NotNull
                                   Map<String,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

validate

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