Package com.atlassian.bamboo.vcs.configurator

Interface VcsChangeDetectionOptionsConfigurator

All Known Implementing Classes:

BitbucketCloudChangeDetectionOptionsConfigurator, BitbucketServerChangeDetectionOptionsConfigurator, DefaultChangeDetectionOptionsConfigurator, GitChangeDetectionOptionsConfigurator, SvnChangeDetectionOptionsConfigurator

public interface VcsChangeDetectionOptionsConfigurator

Class handling change detection options for a repository.

Since:

5.14

Field Summary

Fields

Modifier and Type	Field	Description
static String	CHANGESET_FILTER_REGEX_CFG_KEY
static String	COMMIT_ISOLATION_OPTION_CFG_KEY
static String	FILTER_PATTERN_EXCLUDE_OPTION
static String	FILTER_PATTERN_INCLUDE_OPTION
static String	FILTER_PATTERN_OPTION_CFG_KEY
static String	FILTER_PATTERN_REGEX_CFG_KEY
static List<String>	HANDLED_OPTIONS	List of options handled by Bamboo itself (not plugin specific) These are removed from map given to plugin validator, so plugin focus only on it's own specific options.
static String	QUIET_PERIOD_CFG_KEY
static String	QUIET_PERIOD_ENABLED_CFG_KEY
static String	QUIET_PERIOD_MAX_RETRIES_CFG_KEY

Method Summary

Modifier and Type	Method	Description
@NotNull Map<String,String>	generateConfigMap(@NotNull ActionParametersMap actionParametersMap, @Nullable VcsChangeDetectionOptions previousTriggerDefinition)
boolean	isCommitIsolationSupported()	Informs if associated repository type supports commits being broken up into individual builds
boolean	isQuietPeriodSupported()	Informs if associated repository type works with Bamboo's standard quiet period handling.
void	populateContextForCreate(@NotNull Map<String,Object> context)
void	populateContextForEdit(@NotNull Map<String,Object> context, @NotNull VcsChangeDetectionOptions triggerDefinition)
void	populateContextForView(@NotNull Map<String,Object> context, @NotNull VcsChangeDetectionOptions triggerDefinition)
void	validate(@NotNull ActionParametersMap actionParametersMap, @NotNull ErrorCollection errorCollection)

Field Detail

QUIET_PERIOD_ENABLED_CFG_KEY

static final String QUIET_PERIOD_ENABLED_CFG_KEY

See Also:

Constant Field Values

QUIET_PERIOD_CFG_KEY

static final String QUIET_PERIOD_CFG_KEY

See Also:

Constant Field Values

QUIET_PERIOD_MAX_RETRIES_CFG_KEY

static final String QUIET_PERIOD_MAX_RETRIES_CFG_KEY

See Also:

Constant Field Values

CHANGESET_FILTER_REGEX_CFG_KEY

static final String CHANGESET_FILTER_REGEX_CFG_KEY

See Also:

Constant Field Values

FILTER_PATTERN_OPTION_CFG_KEY

static final String FILTER_PATTERN_OPTION_CFG_KEY

See Also:

Constant Field Values

FILTER_PATTERN_REGEX_CFG_KEY

static final String FILTER_PATTERN_REGEX_CFG_KEY

See Also:

Constant Field Values

FILTER_PATTERN_EXCLUDE_OPTION

static final String FILTER_PATTERN_EXCLUDE_OPTION

See Also:

Constant Field Values

FILTER_PATTERN_INCLUDE_OPTION

static final String FILTER_PATTERN_INCLUDE_OPTION

See Also:

Constant Field Values

COMMIT_ISOLATION_OPTION_CFG_KEY

static final String COMMIT_ISOLATION_OPTION_CFG_KEY

See Also:

Constant Field Values

HANDLED_OPTIONS

static final List<String> HANDLED_OPTIONS

List of options handled by Bamboo itself (not plugin specific) These are removed from map given to plugin validator, so plugin focus only on it's own specific options.

Method Detail

populateContextForCreate

void populateContextForCreate(@NotNull
                              @NotNull Map<String,Object> context)

populateContextForEdit

void populateContextForEdit(@NotNull
                            @NotNull Map<String,Object> context,
                            @NotNull
                            @NotNull VcsChangeDetectionOptions triggerDefinition)

populateContextForView

void populateContextForView(@NotNull
                            @NotNull Map<String,Object> context,
                            @NotNull
                            @NotNull VcsChangeDetectionOptions triggerDefinition)

validate

void validate(@NotNull
              @NotNull ActionParametersMap actionParametersMap,
              @NotNull
              @NotNull ErrorCollection errorCollection)

generateConfigMap

@NotNull
@NotNull Map<String,String> generateConfigMap(@NotNull
                                                    @NotNull ActionParametersMap actionParametersMap,
                                                    @Nullable
                                                    @Nullable VcsChangeDetectionOptions previousTriggerDefinition)

isQuietPeriodSupported

boolean isQuietPeriodSupported()

Informs if associated repository type works with Bamboo's standard quiet period handling. Depending on the result, proper UI will be rendered (or not) and appropriate options will be added to the configMap.

Returns:

true iff Bamboo should include standard quiet period options in the configuration.

isCommitIsolationSupported

boolean isCommitIsolationSupported()

Informs if associated repository type supports commits being broken up into individual builds

Returns:

true if Bamboo should break the single build changes object into a list of changes