Package com.atlassian.bamboo.plugins.vcs.task.configuration

Class AbstractVcsTaskConfigurator

java.lang.Object

com.atlassian.bamboo.task.AbstractTaskConfigurator

com.atlassian.bamboo.task.repository.AbstractRepositoryAwareTaskConfigurator

com.atlassian.bamboo.plugins.vcs.task.configuration.AbstractVcsTaskConfigurator

All Implemented Interfaces:

DeploymentTaskRequirementSupport, RepositoryAwareDeploymentTaskConfigurator, BuildTaskRequirementSupport, RepositoryAwareTaskConfigurator, TaskConfigurator

Direct Known Subclasses:

VcsBranchTaskConfigurator, VcsCommitTaskConfigurator, VcsPushTaskConfigurator, VcsTagTaskConfigurator

public abstract class AbstractVcsTaskConfigurator
extends AbstractRepositoryAwareTaskConfigurator
implements RepositoryAwareTaskConfigurator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFG_AVAILABLE_REPOSITORIES
static final String	CFG_DEFAULT_REPOSITORY_KEY
static final String	CFG_DEFAULT_REPOSITORY_NAME
static final String	CFG_SUPPORTED_REPOSITORIES

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
AbstractVcsTaskConfigurator()

Method Summary

Modifier and Type	Method	Description
protected abstract void	additionalValidate(@NotNull ActionParametersMap params, @NotNull ErrorCollection errorCollection)	Additional validation required by this task.
final @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>	getAdditionalFieldsToCopy()	Additional fields to persist to the database.
protected abstract @NotNull Map<String,Object>	getDefaultFieldValues()	Default values for specified fields.
protected abstract boolean	isRepositoryModuleSupported(@NotNull VcsRepositoryModuleDescriptor repositoryModuleDescriptor)	Whether the given repository type is eligible for this task.
final 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
final 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_AVAILABLE_REPOSITORIES

public static final String CFG_AVAILABLE_REPOSITORIES

See Also:

• Constant Field Values

CFG_SUPPORTED_REPOSITORIES

public static final String CFG_SUPPORTED_REPOSITORIES

See Also:

• Constant Field Values

CFG_DEFAULT_REPOSITORY_KEY

public static final String CFG_DEFAULT_REPOSITORY_KEY

See Also:

• Constant Field Values

CFG_DEFAULT_REPOSITORY_NAME

public static final String CFG_DEFAULT_REPOSITORY_NAME

See Also:

• Constant Field Values

Constructor Details

AbstractVcsTaskConfigurator

public AbstractVcsTaskConfigurator()

Method Details

isRepositoryModuleSupported

protected abstract boolean isRepositoryModuleSupported(@NotNull
 @NotNull VcsRepositoryModuleDescriptor repositoryModuleDescriptor)

Whether the given repository type is eligible for this task.

getAdditionalFieldsToCopy

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

Additional fields to persist to the database. TaskConfigConstants.CFG_WORKING_SUB_DIRECTORY and RepositoryTaskHelper.CFG_SELECTED_REPOSITORY are always persisted, so they needn't be returned by this method. Return an empty list if no additional fields are needed.

getDefaultFieldValues

@NotNull
protected abstract @NotNull Map<String,Object> getDefaultFieldValues()

Default values for specified fields. Return an empty map if no defaults are needed.

additionalValidate

protected abstract void additionalValidate(@NotNull
 @NotNull ActionParametersMap params,
 @NotNull
 @NotNull ErrorCollection errorCollection)

Additional validation required by this task. Lack of TaskConfigConstants.CFG_WORKING_SUB_DIRECTORY is always validated.

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 final 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 final 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 final @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