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

Class AbstractMavenBuildTaskConfigurator

java.lang.Object

com.atlassian.bamboo.task.AbstractTaskConfigurator

com.atlassian.bamboo.plugins.maven.task.configuration.AbstractMavenBuildTaskConfigurator

All Implemented Interfaces:

TaskConfigurator, TaskRequirementSupport, TaskTestResultsSupport

Direct Known Subclasses:

Maven1BuildTaskConfigurator, Maven2BuildTaskConfigurator, Maven3BuildTaskConfigurator

public abstract class AbstractMavenBuildTaskConfigurator
extends AbstractTaskConfigurator
implements TaskRequirementSupport, TaskTestResultsSupport

Field Summary

Fields

Modifier and Type	Field	Description
static String	CFG_TEST_RESULTS_FILE_PATTERN_OPTION_CUSTOM
static String	CFG_TEST_RESULTS_FILE_PATTERN_OPTION_STANDARD
static String	DEFAULT_GOALS

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

bambooAuthenticationContext, taskConfiguratorHelper

Constructor Summary

Constructors

Constructor	Description
AbstractMavenBuildTaskConfigurator()

Method Summary

Modifier and Type	Method	Description
@NotNull Set<Requirement>	calculateRequirements(@NotNull TaskDefinition taskDefinition)	Populates the RequirementSet needed based off of the TaskDefinition
@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	setUiConfigSupport(UIConfigSupport uiConfigSupport)	Deprecated. since 6.8 use constructor injection or annotation injection
boolean	taskProducesTestResults(@NotNull TaskDefinition taskDefinition)	Returns true iff task defined by TaskDefinition produces test results.
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.AbstractTaskConfigurator

calculateRequirements, calculateRequirements, getI18nBean, populateContextForView, setAuthenticationContext, setTaskConfiguratorHelper

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_GOALS

public static final String DEFAULT_GOALS

See Also:

Constant Field Values

CFG_TEST_RESULTS_FILE_PATTERN_OPTION_CUSTOM

public static final String CFG_TEST_RESULTS_FILE_PATTERN_OPTION_CUSTOM

See Also:

Constant Field Values

CFG_TEST_RESULTS_FILE_PATTERN_OPTION_STANDARD

public static final String CFG_TEST_RESULTS_FILE_PATTERN_OPTION_STANDARD

See Also:

Constant Field Values

Constructor Detail

AbstractMavenBuildTaskConfigurator

public AbstractMavenBuildTaskConfigurator()

Method Detail

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

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.

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

calculateRequirements

@NotNull
public @NotNull Set<Requirement> calculateRequirements(@NotNull
                                                       @NotNull TaskDefinition taskDefinition)

Description copied from interface: TaskRequirementSupport

Populates the RequirementSet needed based off of the TaskDefinition

Specified by:

calculateRequirements in interface TaskRequirementSupport

Returns:

requirements

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.

taskProducesTestResults

public boolean taskProducesTestResults(@NotNull
                                       @NotNull TaskDefinition taskDefinition)

Description copied from interface: TaskTestResultsSupport

Returns true iff task defined by TaskDefinition produces test results.

Specified by:

taskProducesTestResults in interface TaskTestResultsSupport

setUiConfigSupport

@Deprecated
public void setUiConfigSupport(UIConfigSupport uiConfigSupport)

Deprecated.

since 6.8 use constructor injection or annotation injection