Package com.atlassian.bamboo.vcs.module

Interface VcsRepositoryModuleDescriptor

All Superinterfaces:
com.atlassian.plugin.ModuleDescriptor<VcsWorkingCopyManager>, NameProvider, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.web.api.descriptors.WeightedDescriptor
All Known Implementing Classes:
LegacyRepositoryModuleDescriptor, VcsRepositoryModuleDescriptorImpl
public interface VcsRepositoryModuleDescriptor extends com.atlassian.plugin.ModuleDescriptor<VcsWorkingCopyManager>, com.atlassian.plugin.web.api.descriptors.WeightedDescriptor, NameProvider

  • Field Details

  • Method Details

    • getOptionDescription

      @Nullable @Nullable String getOptionDescription()
      Additional description rendered in repository selection UI.

    • getIcon

      @Nullable @Nullable String getIcon()
      Returns IMAGE (icon) for specific repository.
      Returns:
      IMAGE path

    • getTooltipKey

      @Nullable @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 @NotNull VcsChangeDetector getChangeDetector()

    • getTagsHandler

      @Nullable @Nullable VcsTagsHandler getTagsHandler()

    • getWorkingCopyManager

      @NotNull @NotNull VcsWorkingCopyManager getWorkingCopyManager()

    • getBranchDetector

      @Nullable @Nullable VcsBranchDetector getBranchDetector()

    • getBranchCreator

      @Nullable @Nullable VcsBranchCreator getBranchCreator()

    • getTagCreator

      @Nullable @Nullable VcsTagCreator getTagCreator()

    • getConnectionTester

      @Nullable @Nullable VcsConnectionTester getConnectionTester()

    • getVariableGenerator

      @Nullable @Nullable VcsVariableGenerator getVariableGenerator()

    • getPullRequestDetector

      @Nullable @Nullable VcsPullRequestDetector getPullRequestDetector()

    • getBambooSpecsHandler

      @Nullable default @Nullable BambooSpecsHandler getBambooSpecsHandler()

    • getVcsCommitCommenter

      @Nullable default @Nullable VcsCommitCommenter getVcsCommitCommenter()

    • getBuildWarningsUpdater

      @Nullable default @Nullable VcsBuildWarningsUpdater getBuildWarningsUpdater()

    • getVcsLocationConfigurator

      @NotNull @NotNull VcsLocationConfigurator getVcsLocationConfigurator()

    • getVcsChangeDetectionOptionsConfigurator

      @Nullable @Nullable VcsChangeDetectionOptionsConfigurator getVcsChangeDetectionOptionsConfigurator()

    • getVcsBranchDetectionOptionsConfigurator

      @Nullable @Nullable VcsBranchDetectionOptionsConfigurator getVcsBranchDetectionOptionsConfigurator()

    • getVcsBranchConfigurator

      @Nullable @Nullable VcsBranchConfigurator getVcsBranchConfigurator()

    • getVcsMavenPomAccessor

      @Nullable @Nullable VcsMavenPomAccessor getVcsMavenPomAccessor()

    • getExporter

      @Nullable @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()

    • supportsForkedPullRequestDetection

      default boolean supportsForkedPullRequestDetection()

    • 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 uses 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 @NotNull String getTypeString()
      Returns "type" of vcs to be used for variable generation.

    • getDefaultTriggerKey

      @NotNull @NotNull String getDefaultTriggerKey()
      Default trigger key for this repository If none was set polling trigger key will be returned
      Returns:
      trigger key

    • getDefaultVcsViewerKey

      @NotNull @NotNull String getDefaultVcsViewerKey()
      Default web viewer for this repository.