Package 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:

DeploymentTaskRequirementSupport, RepositoryAwareDeploymentTaskConfigurator, BuildTaskRequirementSupport, RepositoryAwareTaskConfigurator, TaskConfigurator

public class VcsCheckoutTaskConfigurator
extends AbstractRepositoryAwareTaskConfigurator
implements RepositoryAwareTaskConfigurator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFG_CHECKOUT_DIR_PREFIX
static final String	CFG_CLEAN_CHECKOUT
static final String	CFG_DEFAULT_REPOSITORY
static final String	CFG_SELECTED_REPOSITORIES_INDICES
static final String	CFG_SELECTED_REPOSITORY_ID_PREFIX

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

environmentService, repositoryDefinitionManager, textProvider, vcsRepositoryManager

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

bambooAuthenticationContext, taskConfiguratorHelper

Constructor Summary

Constructors

Constructor	Description
VcsCheckoutTaskConfigurator()

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.
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	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.repository.AbstractRepositoryAwareTaskConfigurator

calculateRequirements, calculateRequirements, getPlanRepositoriesUsedByTask, getPlanRepositoriesUsedByTask, handleRepositoryIdChanged, setEnvironmentService, setRepositoryDefinitionManager, setTextProvider, setVcsRepositoryManager

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

calculateRequirements, getI18nBean, populateContextForView, 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.BuildTaskRequirementSupport

calculateRequirements

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

getPlanRepositoriesUsedByTask, handleRepositoryIdChanged

Field Details

CFG_SELECTED_REPOSITORIES_INDICES

public static final String CFG_SELECTED_REPOSITORIES_INDICES

See Also:

• Constant Field Values

CFG_SELECTED_REPOSITORY_ID_PREFIX

public static final String CFG_SELECTED_REPOSITORY_ID_PREFIX

CFG_DEFAULT_REPOSITORY

public static final String CFG_DEFAULT_REPOSITORY

CFG_CHECKOUT_DIR_PREFIX

public static final String CFG_CHECKOUT_DIR_PREFIX

CFG_CLEAN_CHECKOUT

public static final String CFG_CLEAN_CHECKOUT

See Also:

• Constant Field Values

Constructor Details

VcsCheckoutTaskConfigurator

public VcsCheckoutTaskConfigurator()

Method Details

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

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.

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

Overrides:

validate in class AbstractTaskConfigurator

Parameters:

params - - request paramaters

errorCollection - - collection to put any errors in.

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