com.atlassian.bamboo.vcs.configuration.service

Interface VcsConfigurationHelper

All Known Implementing Classes:

VcsConfigurationHelperImpl

@Internal
public interface VcsConfigurationHelper

Bunch of common operations used in repository related actions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VcsConfigurationHelper.Overrides

Field Summary

Fields

Modifier and Type	Field and Description
static String	BAMBOO_TEST_CONNECTION Special marker added to ActionParametersMap if validation invoked from test connection.
static EnumSet<VcsConfigurationHelper.Overrides>	OVERRIDE_ALL
static EnumSet<VcsConfigurationHelper.Overrides>	OVERRIDE_NOTHING

Method Summary

Modifier and Type	Method and Description
boolean	currentUserHasPermissionToCreateSharedRepository()
PartialVcsRepositoryData	getNewPartialVcsConfigurationFromActionData(ActionParametersMap apm, VcsRepositoryModuleDescriptor vcsDescriptor, String repositoryName, String userDescription, PartialVcsRepositoryData previousVcsDefinition, boolean createPlan, Set<VcsConfigurationHelper.Overrides> overrides) Extracts repository configuration from action's parameters for saving in DB.
PartialVcsRepositoryData	reconfigureRepositoryWithMavenData(VcsRepositoryModuleDescriptor oldModuleDescriptor, PartialVcsRepositoryData oldData, VcsRepositoryModuleDescriptor newModuleDescriptor, Map<String,String> newServerConfiguration, VcsBranch vcsBranch, String webRepositoryUrl) Creates new repository configuration according to data found in a maven pom.xml.
PartialVcsRepositoryData	temporaryVcsDataFromActionParams(ActionParametersMap apm, VcsRepositoryModuleDescriptor moduleDescriptor, PartialVcsRepositoryData existingData, Set<VcsConfigurationHelper.Overrides> overrides) Extracts repository configuration from action's parameters.
RepositoryDataEntity	validateRepositoryExistenceAndPermissions(long repositoryId, com.atlassian.struts.ValidationAware validationAware) Checks if a repository exists in the DB.
void	validateSharedRepositoryName(String repositoryName, com.atlassian.struts.ValidationAware validationAware) Check if new shared repository name is valid.
void	validateVcsConfiguration(ActionParametersMap apm, VcsRepositoryModuleDescriptor vcsDescriptor, PartialVcsRepositoryData previousVcsDefinition, ErrorCollection errorCollection, Set<VcsConfigurationHelper.Overrides> overrides) Run repository configuration validation(s) on action's data.
void	validateVcsConfigurationForConnectionTesting(ActionParametersMap apm, VcsRepositoryModuleDescriptor vcsDescriptor, PartialVcsRepositoryData previousVcsDefinition, ErrorCollection errorCollection) Run repository configuration validation(s) on action's data before testing the connection.

Field Detail

BAMBOO_TEST_CONNECTION

static final String BAMBOO_TEST_CONNECTION

Special marker added to ActionParametersMap if validation invoked from test connection.

See Also:

Constant Field Values

OVERRIDE_NOTHING

static final EnumSet<VcsConfigurationHelper.Overrides> OVERRIDE_NOTHING

OVERRIDE_ALL

static final EnumSet<VcsConfigurationHelper.Overrides> OVERRIDE_ALL

Method Detail

validateVcsConfiguration

void validateVcsConfiguration(@NotNull
                              ActionParametersMap apm,
                              @NotNull
                              VcsRepositoryModuleDescriptor vcsDescriptor,
                              @Nullable
                              PartialVcsRepositoryData previousVcsDefinition,
                              @NotNull
                              ErrorCollection errorCollection,
                              @NotNull
                              Set<VcsConfigurationHelper.Overrides> overrides)

Run repository configuration validation(s) on action's data.

Parameters:

apm -

vcsDescriptor -

previousVcsDefinition -

errorCollection -

validateVcsConfigurationForConnectionTesting

void validateVcsConfigurationForConnectionTesting(@NotNull
                                                  ActionParametersMap apm,
                                                  @NotNull
                                                  VcsRepositoryModuleDescriptor vcsDescriptor,
                                                  @Nullable
                                                  PartialVcsRepositoryData previousVcsDefinition,
                                                  @NotNull
                                                  ErrorCollection errorCollection)

Run repository configuration validation(s) on action's data before testing the connection.

Parameters:

apm -

vcsDescriptor -

previousVcsDefinition -

errorCollection -

reconfigureRepositoryWithMavenData

@NotNull
PartialVcsRepositoryData reconfigureRepositoryWithMavenData(@NotNull
                                                                     VcsRepositoryModuleDescriptor oldModuleDescriptor,
                                                                     @NotNull
                                                                     PartialVcsRepositoryData oldData,
                                                                     @Nullable
                                                                     VcsRepositoryModuleDescriptor newModuleDescriptor,
                                                                     @NotNull
                                                                     Map<String,String> newServerConfiguration,
                                                                     @Nullable
                                                                     VcsBranch vcsBranch,
                                                                     @Nullable
                                                                     String webRepositoryUrl)

Creates new repository configuration according to data found in a maven pom.xml.

Parameters:

oldModuleDescriptor - descriptor of the plugin which was used to check out maven pom

oldData - repository data used to check out maven pom

newModuleDescriptor - descriptor of the repository plugin according to repository url found in pom.xml

newServerConfiguration - server configuration as extracted by VcsMavenPomAccessor.parseMavenScmUrlToVcsLocation(String, VcsRepositoryData)

vcsBranch - vcs branch as extracted by VcsMavenPomAccessor.parseMavenScmUrlToVcsBranch(String, VcsRepositoryData)

webRepositoryUrl - url to be used by web repository viewer

Returns:

getNewPartialVcsConfigurationFromActionData

@NotNull
PartialVcsRepositoryData getNewPartialVcsConfigurationFromActionData(@NotNull
                                                                              ActionParametersMap apm,
                                                                              @NotNull
                                                                              VcsRepositoryModuleDescriptor vcsDescriptor,
                                                                              @NotNull
                                                                              String repositoryName,
                                                                              @Nullable
                                                                              String userDescription,
                                                                              @Nullable
                                                                              PartialVcsRepositoryData previousVcsDefinition,
                                                                              boolean createPlan,
                                                                              @NotNull
                                                                              Set<VcsConfigurationHelper.Overrides> overrides)

Extracts repository configuration from action's parameters for saving in DB.

Parameters:

apm -

vcsDescriptor -

repositoryName -

userDescription -

previousVcsDefinition -

createPlan -

Returns:

temporaryVcsDataFromActionParams

@NotNull
PartialVcsRepositoryData temporaryVcsDataFromActionParams(@NotNull
                                                                   ActionParametersMap apm,
                                                                   @NotNull
                                                                   VcsRepositoryModuleDescriptor moduleDescriptor,
                                                                   @Nullable
                                                                   PartialVcsRepositoryData existingData,
                                                                   @NotNull
                                                                   Set<VcsConfigurationHelper.Overrides> overrides)

Extracts repository configuration from action's parameters. Used if action requires to be able to perform some vcs ops without actually creating a proper repository object in DB (e.g. test connection, checkout for maven import)

Parameters:

apm -

moduleDescriptor -

existingData -

Returns:

validateSharedRepositoryName

void validateSharedRepositoryName(String repositoryName,
                                  com.atlassian.struts.ValidationAware validationAware)

Check if new shared repository name is valid.

Parameters:

repositoryName -

validationAware -

currentUserHasPermissionToCreateSharedRepository

boolean currentUserHasPermissionToCreateSharedRepository()

Returns:

true if creation of a repository is allowed

validateRepositoryExistenceAndPermissions

@Nullable
RepositoryDataEntity validateRepositoryExistenceAndPermissions(long repositoryId,
                                                                         com.atlassian.struts.ValidationAware validationAware)

Checks if a repository exists in the DB.

Parameters:

repositoryId -

validationAware -

Returns:

repository database object if exists, null if it doesn't