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 Type	Method and Description
default boolean	divergentBranchesEnabled(@NotNull VcsRepositoryData vcsRepositoryData) Check if VCS repository supports divergent branches and if the configuration allows them.
@Nullable Repository2VcsTypeConverter	findConverterFor(@NotNull String pluginKey) Looks for converted of an old style repository plugin data to a new style plugin data.
@Nullable Repository2VcsTypeConverter	findReverseConverterFor(@NotNull String pluginKey) Looks for converted of an new style repository plugin data to a old style plugin data.
@NotNull List<VcsRepositoryModuleDescriptor>	getAvailableRepositoryDescriptors() Returns a list of available (i.e.
@NotNull List<VcsRepositoryModuleDescriptor>	getAvailableStandaloneRepositoryDescriptors() Deprecated. since 5.14
@Nullable VcsRepositoryModuleDescriptor	getRepositoryModuleDescriptorByMavenScmKey(@NotNull String mavenScmKey, @NotNull String preferredPluginKey)
@Nullable VcsRepositoryModuleDescriptor	getVcsRepositoryModuleDescriptor(@NotNull String pluginKey) Return module descriptor for given plugin key or null if it doesn't exists or plugin is disabled.
default boolean	supportsDivergentBranches(@NotNull String pluginKey) Check if VCS plugin supports divergent branches.

Method Detail

getAvailableRepositoryDescriptors

@NotNull
@NotNull List<VcsRepositoryModuleDescriptor> getAvailableRepositoryDescriptors()

Returns a list of available (i.e. installed and enabled) VcsRepositoryModuleDescriptor objects.

Returns:

Immutable list of VcsRepositoryModuleDescriptor sorted 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.14

Returns a list of available (i.e. installed and enabled) VcsRepositoryModuleDescriptor objects representing repository plugins that do not require Plan during configuration. This method only exist for compatibility with old plugins, that still use Repository interface. All plugins implemented with new API are "standalone" by definition.

Returns:

Immutable list of VcsRepositoryModuleDescriptor sorted by weight. Empty list if none exists.

getRepositoryModuleDescriptorByMavenScmKey

@Nullable
@Nullable VcsRepositoryModuleDescriptor getRepositoryModuleDescriptorByMavenScmKey(@NotNull
                                                                                             @NotNull String mavenScmKey,
                                                                                             @NotNull
                                                                                             @NotNull String preferredPluginKey)

findConverterFor

@Nullable
@Nullable Repository2VcsTypeConverter findConverterFor(@NotNull
                                                                 @NotNull String pluginKey)

Looks for converted of an old style repository plugin data to a new style plugin data.

Parameters:

pluginKey - key of an old plugin

Returns:

converter class or null if none available

findReverseConverterFor

@Nullable
@Nullable Repository2VcsTypeConverter findReverseConverterFor(@NotNull
                                                                        @NotNull String pluginKey)

Looks for converted of an new style repository plugin data to a old style plugin data.

Parameters:

pluginKey - key of an new plugin

Returns:

converter class or null if none available

supportsDivergentBranches

default boolean supportsDivergentBranches(@NotNull
                                          @NotNull String pluginKey)

Check if VCS plugin supports divergent branches. This method only checks the general capability, in order to check if the current configuration allows them use divergentBranchesEnabled(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

default boolean divergentBranchesEnabled(@NotNull
                                         @NotNull VcsRepositoryData vcsRepositoryData)

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