com.atlassian.bamboo.plugins.github.configurator

Class GitHubServerConfigurator

java.lang.Object

com.atlassian.bamboo.plugins.github.configurator.GitHubServerConfigurator

All Implemented Interfaces:

VcsLocationConfigurator

public class GitHubServerConfigurator
extends Object
implements VcsLocationConfigurator

Constructor Summary

Constructors

Constructor and Description
GitHubServerConfigurator()

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.
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.
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)

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, validateForConnectionTesting

Constructor Detail

GitHubServerConfigurator

public GitHubServerConfigurator()

Method Detail

populateContextForCreate

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

Specified by:

populateContextForCreate in interface VcsLocationConfigurator

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 previousVcsLocationDefinition,
                     @NotNull
                     ErrorCollection errorCollection)

Specified by:

validate in interface VcsLocationConfigurator

generateConfigMap

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

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

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

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

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 or VcsType.HG

Specified by:

getScmType in interface VcsLocationConfigurator

Returns:

vcs type