com.atlassian.bamboo.vcs.configurator

Interface VcsLocationConfigurator

All Known Implementing Classes:

BitbucketCloudServerConfigurator, BitbucketServerServerConfigurator, GitHubServerConfigurator, GitServerConfigurator, LegacyRepositoryConfigurationExporter, LegacyVcsLocationConfigurator, SvnServerConfigurator

public interface VcsLocationConfigurator

Class providing UI to configure vcs server.

Since:

5.14

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 previousVcsLocationDefinition)
String	getLocationIdentifier(VcsLocationDefinition vcsLocationDefinition) A string representing the location of the repository.
default 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.
default 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 previousVcsLocationDefinition, ErrorCollection errorCollection)
default void	validateForConnectionTesting(ActionParametersMap actionParametersMap, VcsLocationDefinition previousVcsLocationDefinition, ErrorCollection errorCollection) A method similar to validate(ActionParametersMap, VcsLocationDefinition, ErrorCollection) used to validate repository configuration before connection testing.

Method Detail

populateContextForCreate

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

populateContextForEdit

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

populateContextForView

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

validate

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

validateForConnectionTesting

default void validateForConnectionTesting(@NotNull
                                          ActionParametersMap actionParametersMap,
                                          @Nullable
                                          VcsLocationDefinition previousVcsLocationDefinition,
                                          @NotNull
                                          ErrorCollection errorCollection)

A method similar to 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).

generateConfigMap

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

addDefaultsForAdvancedOptions

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

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

Parameters:

cfgMap -

getServerHost

@NotNull
String getServerHost(@NotNull
                              VcsLocationDefinition vcsLocationDefinition)

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

getLocationIdentifier

@NotNull
String getLocationIdentifier(@NotNull
                                      VcsLocationDefinition vcsLocationDefinition)

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

getSharedCredentialsIds

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

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

Parameters:

vcsLocationDefinition -

Returns:

the list of shared credential ids used by a repository.

getScmType

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

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

Parameters:

vcsLocationDefinition -

Returns:

vcs type