com.atlassian.bamboo.plugins.vcs.task.configuration
Class VcsCheckoutTaskConfigurator

java.lang.Object
  com.atlassian.bamboo.task.AbstractTaskConfigurator
      com.atlassian.bamboo.task.repository.AbstractRepositoryAwareTaskConfigurator
          com.atlassian.bamboo.plugins.vcs.task.configuration.VcsCheckoutTaskConfigurator

All Implemented Interfaces:

BuildTaskRequirementSupport, RepositoryAwareTaskConfigurator, TaskConfigurator

public class VcsCheckoutTaskConfigurator
extends AbstractRepositoryAwareTaskConfigurator
implements RepositoryAwareTaskConfigurator

Field Summary

static java.lang.String	CFG_CHECKOUT_DIR_PREFIX
static java.lang.String	CFG_CLEAN_CHECKOUT
static java.lang.String	CFG_DEFAULT_REPOSITORY
static java.lang.String	CFG_SELECTED_REPOSITORIES_INDICES
static java.lang.String	CFG_SELECTED_REPOSITORY_ID_PREFIX

Fields inherited from class com.atlassian.bamboo.task.repository.AbstractRepositoryAwareTaskConfigurator

repositoryManager, textProvider

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

bambooAuthenticationContext, taskConfiguratorHelper

Constructor Summary

VcsCheckoutTaskConfigurator()

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.
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	validate(ActionParametersMap params, ErrorCollection errorCollection) Validate the params submitted from the UI for this task definition

Methods inherited from class com.atlassian.bamboo.task.repository.AbstractRepositoryAwareTaskConfigurator

calculateRequirements, getRepositoriesUsedByTask, handleRepositoryIdChanged, setRepositoryManager, setTextProvider

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

calculateRequirements, getI18nBean, setAuthenticationContext, setTaskConfiguratorHelper

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.task.repository.RepositoryAwareTaskConfigurator

getRepositoriesUsedByTask, handleRepositoryIdChanged

Methods inherited from interface com.atlassian.bamboo.task.BuildTaskRequirementSupport

calculateRequirements, calculateRequirements

Field Detail

CFG_SELECTED_REPOSITORIES_INDICES

public static final java.lang.String CFG_SELECTED_REPOSITORIES_INDICES

See Also:

Constant Field Values

CFG_SELECTED_REPOSITORY_ID_PREFIX

public static final java.lang.String CFG_SELECTED_REPOSITORY_ID_PREFIX

See Also:

Constant Field Values

CFG_DEFAULT_REPOSITORY

public static final java.lang.String CFG_DEFAULT_REPOSITORY

See Also:

Constant Field Values

CFG_CHECKOUT_DIR_PREFIX

public static final java.lang.String CFG_CHECKOUT_DIR_PREFIX

See Also:

Constant Field Values

CFG_CLEAN_CHECKOUT

public static final java.lang.String CFG_CLEAN_CHECKOUT

See Also:

Constant Field Values

Constructor Detail

VcsCheckoutTaskConfigurator

public VcsCheckoutTaskConfigurator()

Method Detail

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

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.

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.

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