com.atlassian.bamboo.plugins.stash.v2.configurator

Class BitbucketServerServerConfigurator

java.lang.Object

com.atlassian.bamboo.plugins.stash.v2.configurator.BitbucketServerSshKeyHandler

com.atlassian.bamboo.plugins.stash.v2.configurator.BitbucketServerServerConfigurator

All Implemented Interfaces:

VcsLocationConfigurator

public class BitbucketServerServerConfigurator
extends BitbucketServerSshKeyHandler
implements VcsLocationConfigurator

Field Summary

Fields

Modifier and Type	Field and Description
static String	NEGOTIATE_SSH_KEYS

Constructor Summary

Constructors

Constructor and Description
BitbucketServerServerConfigurator()

Method Summary

Modifier and Type	Method and Description
void	addDefaultsForAdvancedOptions(@NotNull Map<String,String> cfgMap) In Plan creation screen advanced options' UI is not displayed.
@NotNull Map<String,String>	generateConfigMap(@NotNull ActionParametersMap actionParametersMap, @Nullable VcsLocationDefinition previousVcsLocationDefinition)
@NotNull String	getLocationIdentifier(@NotNull VcsLocationDefinition vcsLocationDefinition) A string representing the location of the repository.
Optional<VcsType>	getScmType(@NotNull VcsLocationDefinition vcsLocationDefinition) Return the type of vcs system used by a repository.
@NotNull String	getServerHost(@NotNull VcsLocationDefinition vcsLocationDefinition) What's the repository server host.
void	populateContextForCreate(@NotNull Map<String,Object> context)
void	populateContextForEdit(@NotNull Map<String,Object> context, @NotNull VcsLocationDefinition vcsLocationDefinition)
void	populateContextForView(@NotNull Map<String,Object> context, @NotNull VcsLocationDefinition vcsLocationDefinition)
@NotNull Map<String,String>	setVcsLocationDataInConfig(@NotNull Map<String,String> configMap, @Nullable String vcsLocationParentIdentifier, @Nullable String vcsLocationRepositoryIdentifier) Modify config map by setting repository location data.
protected String	substituteString(@Nullable String stringWithValuesToSubstitute)
void	validate(@NotNull ActionParametersMap actionParametersMap, @Nullable VcsLocationDefinition previousVcsLocationDefinition, @NotNull ErrorCollection errorCollection)

Methods inherited from class com.atlassian.bamboo.plugins.stash.v2.configurator.BitbucketServerSshKeyHandler

generateKeyPair, getAuthenticationErrors, sshKeyLocationToString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.vcs.configurator.VcsLocationConfigurator

getSharedCredentialsIds, isWebhookEnabled, validateForConnectionTesting

Field Detail

NEGOTIATE_SSH_KEYS

public static final String NEGOTIATE_SSH_KEYS

See Also:

Constant Field Values

Constructor Detail

BitbucketServerServerConfigurator

public BitbucketServerServerConfigurator()

Method Detail

populateContextForCreate

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

Specified by:

populateContextForCreate in interface VcsLocationConfigurator

populateContextForEdit

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

Specified by:

populateContextForEdit in interface VcsLocationConfigurator

populateContextForView

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

Specified by:

populateContextForView in interface VcsLocationConfigurator

validate

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

Specified by:

validate in interface VcsLocationConfigurator

substituteString

protected String substituteString(@Nullable
                                  @Nullable String stringWithValuesToSubstitute)

generateConfigMap

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

Specified by:

generateConfigMap in interface VcsLocationConfigurator

addDefaultsForAdvancedOptions

public void addDefaultsForAdvancedOptions(@NotNull
                                          @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

getServerHost

@NotNull
public @NotNull String getServerHost(@NotNull
                                              @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

getLocationIdentifier

@NotNull
public @NotNull String getLocationIdentifier(@NotNull
                                                      @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

getScmType

public Optional<VcsType> getScmType(@NotNull
                                    @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

setVcsLocationDataInConfig

@NotNull
public @NotNull Map<String,String> setVcsLocationDataInConfig(@NotNull
                                                                       @NotNull Map<String,String> configMap,
                                                                       @Nullable
                                                                       @Nullable String vcsLocationParentIdentifier,
                                                                       @Nullable
                                                                       @Nullable String vcsLocationRepositoryIdentifier)

Description copied from interface: VcsLocationConfigurator

Modify config map by setting repository location data. The default implementation does not modify anything. The method should be overridden in pull request related implementations.

Specified by:

setVcsLocationDataInConfig in interface VcsLocationConfigurator

Returns:

modified map