com.atlassian.bamboo.vcs.module

Interface VcsRepositoryModuleDescriptor

All Superinterfaces:

com.atlassian.plugin.ModuleDescriptor<VcsWorkingCopyManager>, NameProvider, com.atlassian.plugin.Resourced, com.atlassian.plugin.web.descriptors.WeightedDescriptor

All Known Implementing Classes:

LegacyRepositoryModuleDescriptor, VcsRepositoryModuleDescriptorImpl

public interface VcsRepositoryModuleDescriptor
extends com.atlassian.plugin.ModuleDescriptor<VcsWorkingCopyManager>, com.atlassian.plugin.web.descriptors.WeightedDescriptor, NameProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	SELECTED_REPOSITORY

Method Summary

Modifier and Type	Method and Description
default BambooSpecsHandler	getBambooSpecsHandler()
VcsBranchCreator	getBranchCreator()
VcsBranchDetector	getBranchDetector()
default VcsBuildWarningsUpdater	getBuildWarningsUpdater()
VcsChangeDetector	getChangeDetector()
VcsConnectionTester	getConnectionTester()
String	getDefaultTriggerKey() Default trigger key for this repository If none was set polling trigger key will be returned
String	getDefaultVcsViewerKey() Default web viewer for this repository.
VcsRepositoryDataExporter	getExporter()
String	getIcon() Returns IMAGE (icon) for specific repository.
String	getOptionDescription() Additional description rendered in repository selection UI.
VcsPullRequestDetector	getPullRequestDetector()
VcsTagCreator	getTagCreator()
String	getTooltipKey() Returns TRANSLATION key which is used in tooltips.
String	getTypeString() Returns "type" of vcs to be used for variable generation.
VcsVariableGenerator	getVariableGenerator()
VcsBranchConfigurator	getVcsBranchConfigurator()
VcsBranchDetectionOptionsConfigurator	getVcsBranchDetectionOptionsConfigurator()
VcsChangeDetectionOptionsConfigurator	getVcsChangeDetectionOptionsConfigurator()
default VcsCommitCommenter	getVcsCommitCommenter()
VcsLocationConfigurator	getVcsLocationConfigurator()
VcsMavenPomAccessor	getVcsMavenPomAccessor()
VcsWorkingCopyManager	getWorkingCopyManager()
default boolean	isDistributedVcs() Returns true if this repository type is a DVCS.
boolean	isPrimary() Marks repository for PRIMARY (in our case Stash & Bitbucket), is used for rendering.
boolean	providesCustomVariables()
default boolean	providesWorkingCopyStatus()
boolean	revisionIdsAreUnique() Return true for vcs systems that uses revision ids that can be considered unique.
boolean	supportsBranchCreation()
boolean	supportsBranchDetection()
boolean	supportsBranchOverrides()
default boolean	supportsBuildWarnings()
default boolean	supportsCommitComment()
boolean	supportsImportFromMaven()
boolean	supportsMerging()
default boolean	supportsPullRequestDetection()
boolean	supportsRemoteUpdates()
boolean	supportsTagCreation()
boolean	supportsTestingConnection()

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Methods inherited from interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

getWeight

Methods inherited from interface com.atlassian.bamboo.utils.NameProvider

getName

Field Detail

SELECTED_REPOSITORY

static final String SELECTED_REPOSITORY

See Also:

Constant Field Values

Method Detail

getOptionDescription

@Nullable
String getOptionDescription()

Additional description rendered in repository selection UI.

getIcon

@Nullable
String getIcon()

Returns IMAGE (icon) for specific repository.

Returns:

IMAGE path

getTooltipKey

@Nullable
String getTooltipKey()

Returns TRANSLATION key which is used in tooltips.

Returns:

TRANSLATION key

isPrimary

boolean isPrimary()

Marks repository for PRIMARY (in our case Stash & Bitbucket), is used for rendering.

getChangeDetector

@NotNull
VcsChangeDetector getChangeDetector()

getWorkingCopyManager

@NotNull
VcsWorkingCopyManager getWorkingCopyManager()

getBranchDetector

@Nullable
VcsBranchDetector getBranchDetector()

getBranchCreator

@Nullable
VcsBranchCreator getBranchCreator()

getTagCreator

@Nullable
VcsTagCreator getTagCreator()

getConnectionTester

@Nullable
VcsConnectionTester getConnectionTester()

getVariableGenerator

@Nullable
VcsVariableGenerator getVariableGenerator()

getPullRequestDetector

@Nullable
VcsPullRequestDetector getPullRequestDetector()

getBambooSpecsHandler

@Nullable
default BambooSpecsHandler getBambooSpecsHandler()

getVcsCommitCommenter

@Nullable
default VcsCommitCommenter getVcsCommitCommenter()

getBuildWarningsUpdater

@Nullable
default VcsBuildWarningsUpdater getBuildWarningsUpdater()

getVcsLocationConfigurator

@NotNull
VcsLocationConfigurator getVcsLocationConfigurator()

getVcsChangeDetectionOptionsConfigurator

@Nullable
VcsChangeDetectionOptionsConfigurator getVcsChangeDetectionOptionsConfigurator()

getVcsBranchDetectionOptionsConfigurator

@Nullable
VcsBranchDetectionOptionsConfigurator getVcsBranchDetectionOptionsConfigurator()

getVcsBranchConfigurator

@Nullable
VcsBranchConfigurator getVcsBranchConfigurator()

getVcsMavenPomAccessor

@Nullable
VcsMavenPomAccessor getVcsMavenPomAccessor()

getExporter

@Nullable
VcsRepositoryDataExporter getExporter()

supportsBranchDetection

boolean supportsBranchDetection()

supportsBranchOverrides

boolean supportsBranchOverrides()

supportsBranchCreation

boolean supportsBranchCreation()

supportsTagCreation

boolean supportsTagCreation()

supportsMerging

boolean supportsMerging()

supportsRemoteUpdates

boolean supportsRemoteUpdates()

supportsTestingConnection

boolean supportsTestingConnection()

providesCustomVariables

boolean providesCustomVariables()

supportsImportFromMaven

boolean supportsImportFromMaven()

supportsPullRequestDetection

default boolean supportsPullRequestDetection()

supportsCommitComment

default boolean supportsCommitComment()

providesWorkingCopyStatus

default boolean providesWorkingCopyStatus()

supportsBuildWarnings

default boolean supportsBuildWarnings()

revisionIdsAreUnique

boolean revisionIdsAreUnique()

Return true for vcs systems that uses revision ids that can be considered unique. For example Git and Mercurial use hashes that have low collision chance, so it follows that 2 commits with that same revision id are in fact the same commit. Subversion, on the other hand, uses cardinal numbers which are obviously not unique.

isDistributedVcs

default boolean isDistributedVcs()

Returns true if this repository type is a DVCS. In particular, this means that the repository type distinguishes between local and remote commits.

getTypeString

@NotNull
String getTypeString()

Returns "type" of vcs to be used for variable generation.

getDefaultTriggerKey

@NotNull
String getDefaultTriggerKey()

Default trigger key for this repository If none was set polling trigger key will be returned

Returns:

trigger key

getDefaultVcsViewerKey

@NotNull
String getDefaultVcsViewerKey()

Default web viewer for this repository.