Package 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	Description
GitHubServerConfigurator(com.atlassian.sal.api.message.I18nResolver i18nResolver, CredentialsAccessor credentialsAccessor, AdministrationConfigurationAccessor administrationConfigurationAccessor)

Method Summary

Modifier and Type	Method	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.
@NotNull Iterable<Long>	getSharedCredentialsIds(@NotNull VcsLocationDefinition vcsLocationDefinition)	Returns a list of shared credential ids used by a repository.
boolean	isWebhookEnabled(VcsRepositoryData vcsRepositoryData)	Determines whether the specified repository data has the webhook option enabled.
static boolean	isWebhookEnabledForRepository(@NotNull VcsRepositoryData vcsRepositoryData)
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)
void	validate(@NotNull ActionParametersMap actionParametersMap, @Nullable VcsLocationDefinition previousVcsLocationDefinition, @NotNull 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

setVcsLocationDataInConfig, validateForConnectionTesting

Constructor Details

GitHubServerConfigurator

@Inject
public GitHubServerConfigurator(com.atlassian.sal.api.message.I18nResolver i18nResolver,
 CredentialsAccessor credentialsAccessor,
 AdministrationConfigurationAccessor administrationConfigurationAccessor)

Method Details

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

generateConfigMap

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

Specified by:

generateConfigMap in interface VcsLocationConfigurator

getSharedCredentialsIds

@NotNull
public @NotNull Iterable<Long> getSharedCredentialsIds(@NotNull
 @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.

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

isWebhookEnabled

public boolean isWebhookEnabled(VcsRepositoryData vcsRepositoryData)

Description copied from interface: VcsLocationConfigurator

Determines whether the specified repository data has the webhook option enabled.

Specified by:

isWebhookEnabled in interface VcsLocationConfigurator

Returns:

true if webhooks is enabled, false otherwise

isWebhookEnabledForRepository

public static boolean isWebhookEnabledForRepository(@NotNull
 @NotNull VcsRepositoryData vcsRepositoryData)