com.atlassian.bamboo.vcs.configuration.legacy.configurator

Class LegacyVcsLocationConfigurator

java.lang.Object

com.atlassian.bamboo.vcs.configuration.legacy.LegacyExecutorBase

com.atlassian.bamboo.vcs.configuration.legacy.configurator.LegacyVcsLocationConfigurator

All Implemented Interfaces:

VcsLocationConfigurator

Direct Known Subclasses:

LegacyRepositoryConfigurationExporter

public class LegacyVcsLocationConfigurator
extends LegacyExecutorBase
implements VcsLocationConfigurator

Field Summary

Fields

Modifier and Type	Field and Description
static String	LEGACY_XML

Fields inherited from class com.atlassian.bamboo.vcs.configuration.legacy.LegacyExecutorBase

repositoryModuleDescriptor

Constructor Summary

Constructors

Constructor and Description
LegacyVcsLocationConfigurator(RepositoryModuleDescriptor repositoryModuleDescriptor)

Method Summary

Modifier and Type	Method and Description
void	addDefaultsForAdvancedOptions(Map<String,String> cfgMap) In Plan creation screen advanced options' UI is not displayed.
Map<String,String>	generateConfigMap(ActionParametersMap actionParametersMap, VcsLocationDefinition previousDefinition)
String	getLocationIdentifier(VcsLocationDefinition vcsLocationDefinition) A string representing the location of the repository.
protected Repository	getRepositoryInstance(VcsLocationDefinition vcsLocationDefinition)
Optional<VcsType>	getScmType(VcsLocationDefinition vcsLocationDefinition) Return the type of vcs system used by a repository.
String	getServerHost(VcsLocationDefinition vcsLocationDefinition) What's the repository server host.
Iterable<Long>	getSharedCredentialsIds(VcsLocationDefinition vcsLocationDefinition) Returns a list of shared credential ids used by a repository.
void	populateContextForCreate(Map<String,Object> context)
void	populateContextForEdit(Map<String,Object> context, VcsLocationDefinition vcsLocationDefinition)
void	populateContextForView(Map<String,Object> context, VcsLocationDefinition vcsLocationDefinition)
void	validate(ActionParametersMap actionParametersMap, VcsLocationDefinition previousDefinition, ErrorCollection errorCollection)
void	validateForConnectionTesting(ActionParametersMap actionParametersMap, VcsLocationDefinition previousDefinition, ErrorCollection errorCollection) A method similar to VcsLocationConfigurator.validate(ActionParametersMap, VcsLocationDefinition, ErrorCollection) used to validate repository configuration before connection testing.

Methods inherited from class com.atlassian.bamboo.vcs.configuration.legacy.LegacyExecutorBase

getNewRepositoryInstance, getNewRepositoryInstanceAs, getRepositoryInstance, getRepositoryInstanceAs, xmlToConfiguration

Methods inherited from class java.lang.Object

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

Field Detail

LEGACY_XML

public static final String LEGACY_XML

See Also:

Constant Field Values

Constructor Detail

LegacyVcsLocationConfigurator

public LegacyVcsLocationConfigurator(RepositoryModuleDescriptor repositoryModuleDescriptor)

Method Detail

populateContextForCreate

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

Specified by:

populateContextForCreate in interface VcsLocationConfigurator

getRepositoryInstance

protected Repository getRepositoryInstance(@Nullable
                                           VcsLocationDefinition vcsLocationDefinition)

populateContextForEdit

public void populateContextForEdit(@NotNull
                                   Map<String,Object> context,
                                   @NotNull
                                   VcsLocationDefinition vcsLocationDefinition)

Specified by:

populateContextForEdit in interface VcsLocationConfigurator

populateContextForView

public void populateContextForView(@NotNull
                                   Map<String,Object> context,
                                   @NotNull
                                   VcsLocationDefinition vcsLocationDefinition)

Specified by:

populateContextForView in interface VcsLocationConfigurator

validate

public void validate(@NotNull
                     ActionParametersMap actionParametersMap,
                     @Nullable
                     VcsLocationDefinition previousDefinition,
                     @NotNull
                     ErrorCollection errorCollection)

Specified by:

validate in interface VcsLocationConfigurator

validateForConnectionTesting

public void validateForConnectionTesting(@NotNull
                                         ActionParametersMap actionParametersMap,
                                         @Nullable
                                         VcsLocationDefinition previousDefinition,
                                         @NotNull
                                         ErrorCollection errorCollection)

Description copied from interface: VcsLocationConfigurator

A method similar to VcsLocationConfigurator.validate(ActionParametersMap, VcsLocationDefinition, ErrorCollection) used to validate repository configuration before connection testing. This method may be more relaxed than normal validation. Additionally, different error messages may be displayed (e.g. related to impossibility of transferring files).

Specified by:

validateForConnectionTesting in interface VcsLocationConfigurator

generateConfigMap

@NotNull
public Map<String,String> generateConfigMap(@NotNull
                                                     ActionParametersMap actionParametersMap,
                                                     @Nullable
                                                     VcsLocationDefinition previousDefinition)

Specified by:

generateConfigMap in interface VcsLocationConfigurator

addDefaultsForAdvancedOptions

public void addDefaultsForAdvancedOptions(@NotNull
                                          Map<String,String> cfgMap)

Description copied from interface: VcsLocationConfigurator

In Plan creation screen advanced options' UI is not displayed. In that case the defaults for those options need to be provided.

Specified by:

addDefaultsForAdvancedOptions in interface VcsLocationConfigurator

getLocationIdentifier

@NotNull
public String getLocationIdentifier(@NotNull
                                             VcsLocationDefinition vcsLocationDefinition)

Description copied from interface: VcsLocationConfigurator

A string representing the location of the repository. Usually simply the content of url (or equivalent) field.

Specified by:

getLocationIdentifier in interface VcsLocationConfigurator

getServerHost

@NotNull
public String getServerHost(@NotNull
                                     VcsLocationDefinition vcsLocationDefinition)

Description copied from interface: VcsLocationConfigurator

What's the repository server host. It's OK to return an empty string.

Specified by:

getServerHost in interface VcsLocationConfigurator

getSharedCredentialsIds

@NotNull
public Iterable<Long> getSharedCredentialsIds(@NotNull
                                                       VcsLocationDefinition vcsLocationDefinition)

Description copied from interface: VcsLocationConfigurator

Returns a list of shared credential ids used by a repository.

Specified by:

getSharedCredentialsIds in interface VcsLocationConfigurator

Returns:

the list of shared credential ids used by a repository.

getScmType

public Optional<VcsType> getScmType(@NotNull
                                    VcsLocationDefinition vcsLocationDefinition)

Description copied from interface: VcsLocationConfigurator

Return the type of vcs system used by a repository. If the vcs system is a product build around some other vcs system (e.g. Bitbucket, GitHub), the type of that other system should be returned. For example, Bitbucket repositories are of type VcsType.GIT

Specified by:

getScmType in interface VcsLocationConfigurator

Returns:

vcs type