Package com.atlassian.bamboo.vcs.module
Interface VcsRepositoryManager
- All Known Implementing Classes:
VcsRepositoryManagerImpl
public interface VcsRepositoryManager
Provides access to repository plugins.
- Since:
- 5.14
-
Method Summary
Modifier and TypeMethodDescriptiondefault booleandivergentBranchesEnabled(@NotNull VcsRepositoryData vcsRepositoryData) Check if VCS repository supports divergent branches and if the configuration allows them.@NotNull List<VcsRepositoryModuleDescriptor>Returns a list of available (i.e. installed and enabled)VcsRepositoryModuleDescriptorobjects.@NotNull List<VcsRepositoryModuleDescriptor>Deprecated.since 5.14@Nullable VcsRepositoryModuleDescriptorgetRepositoryModuleDescriptorByMavenScmKey(@NotNull String mavenScmKey, @NotNull String preferredPluginKey) @Nullable VcsRepositoryModuleDescriptorgetVcsRepositoryModuleDescriptor(@NotNull String pluginKey) Return module descriptor for given plugin key or null if it doesn't exists or plugin is disabled.default booleansupportsDivergentBranches(@NotNull String pluginKey) Check if VCS plugin supports divergent branches.
-
Method Details
-
getAvailableRepositoryDescriptors
Returns a list of available (i.e. installed and enabled)VcsRepositoryModuleDescriptorobjects.- Returns:
- Immutable list of
VcsRepositoryModuleDescriptorsorted by weight. Empty list if none exists. - Since:
- 5.14
-
getVcsRepositoryModuleDescriptor
@Nullable @Nullable VcsRepositoryModuleDescriptor getVcsRepositoryModuleDescriptor(@NotNull @NotNull String pluginKey) Return module descriptor for given plugin key or null if it doesn't exists or plugin is disabled.- Parameters:
pluginKey- plugin key
-
getAvailableStandaloneRepositoryDescriptors
@NotNull @Deprecated @NotNull List<VcsRepositoryModuleDescriptor> getAvailableStandaloneRepositoryDescriptors()Deprecated.since 5.14Returns a list of available (i.e. installed and enabled)VcsRepositoryModuleDescriptorobjects representing repository plugins that do not requirePlanduring configuration. All plugins implemented with new API are "standalone" by definition.- Returns:
- Immutable list of
VcsRepositoryModuleDescriptorsorted by weight. Empty list if none exists.
-
getRepositoryModuleDescriptorByMavenScmKey
@Nullable @Nullable VcsRepositoryModuleDescriptor getRepositoryModuleDescriptorByMavenScmKey(@NotNull @NotNull String mavenScmKey, @NotNull @NotNull String preferredPluginKey) -
supportsDivergentBranches
Check if VCS plugin supports divergent branches. This method only checks the general capability, in order to check if the current configuration allows them usedivergentBranchesEnabled(VcsRepositoryData)- Parameters:
pluginKey- plugin key- Returns:
- true if plugin supports different plan branch structure and settings for Bamboo Specs at VCS branch.
- Since:
- 7.0
-
divergentBranchesEnabled
Check if VCS repository supports divergent branches and if the configuration allows them.- Parameters:
vcsRepositoryData- repository data- Returns:
- true if the repository supports different plan branch structure and settings for Bamboo Specs at VCS branch.
- Since:
- 9.0
-