com.atlassian.bamboo.repository
Interface Repository

All Superinterfaces:

BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, ConvertibleFromConfig, DescriptionProvider, InitablePluginModule, NameProvider, RenderableBuildConfiguration, RepositoryV2, Serializable

All Known Subinterfaces:

BitbucketDelegatedRepository, BranchAwareRepository, BranchDetectionCapableRepository, BranchInformationProvider, BranchingAwareRepository, BranchMergingAwareRepository, CachingAwareRepository, CheckoutCustomRevisionDataAwareRepository, CommitIsolationAwareRepository, CustomRevisionDataAwareRepository, CustomSourceDirectoryAwareRepository, CustomVariableProviderRepository, EditActionAwareRepository, IncludeExcludeAwareRepository, InitialBuildAwareRepository, MavenPomAccessorCapableRepository, OnceOffCapableRepository, PreparableRepository, PushCapableRepository, QuietPeriodAwareRepository, RepositoryEventAware, RequirementsAwareRepository, RequiresRepositoryData, SelectableAuthenticationRepository, StandaloneRepository, TaggingAwareRepository

All Known Implementing Classes:

AbstractRepository, AbstractStandaloneRepository, BitbucketRepository, CVSRepository, GitHubRepository, GitRepository, HgRepository, NullRepository, PerforceRepository, StashRepository, SvnRepository

public interface Repository
extends ConvertibleFromConfig, RepositoryV2, ConfigurablePlugin, DescriptionProvider

Basic contract for interfacing with various version control repository systems.

Field Summary

static String	SELECTED_REPOSITORY Deprecated. since 3.3 repository definition is no longer part of BuildConfiguration
static String	UNKNOWN_HOST A marker string to return when the host is not known

Method Summary

ErrorCollection	checkConnection() This method internally validates the current connection for the repository.
String	getHost() What's the repository server host
String	getKey() The full complete plugin key for the repo
String	getLocationIdentifier() A string representing the location of the repository
String	getMinimalEditHtml(BuildConfiguration buildConfiguration) Returns HTML for the minimal configuration of the repository.
String	getName() The display name for the repository type
String	getShortKey() The mini key from the plugin (should not contain plugin prefix)

Methods inherited from interface com.atlassian.bamboo.fieldvalue.ConvertibleFromConfig

populateFromConfig, toConfiguration

Methods inherited from interface com.atlassian.bamboo.v2.build.repository.RepositoryV2

collectChangesSinceLastBuild, getSourceCodeDirectory, isRepositoryDifferent

Methods inherited from interface com.atlassian.bamboo.v2.build.ConfigurablePlugin

customizeBuildRequirements, removeBuildRequirements

Methods inherited from interface com.atlassian.bamboo.v2.build.BuildConfigurationAwarePlugin

addDefaultValues, prepareConfigObject, validate

Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule

init

Methods inherited from interface com.atlassian.bamboo.v2.build.RenderableBuildConfiguration

getEditHtml, getViewHtml

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

getDescription

Field Detail

UNKNOWN_HOST

static final String UNKNOWN_HOST

A marker string to return when the host is not known

See Also:

Constant Field Values

SELECTED_REPOSITORY

@Deprecated
static final String SELECTED_REPOSITORY

Deprecated. since 3.3 repository definition is no longer part of BuildConfiguration

Constant for fetching out the selected repository key from a BuildConfiguration

See Also:

Constant Field Values

Method Detail

getKey

@NotNull
String getKey()

The full complete plugin key for the repo

Returns:

getShortKey

@NotNull
String getShortKey()

The mini key from the plugin (should not contain plugin prefix)

Returns:

getName

@NotNull
String getName()

The display name for the repository type

Specified by:

getName in interface DescriptionProvider

Specified by:

getName in interface NameProvider

Returns:

getHost

String getHost()

What's the repository server host

Returns:

The host!

getLocationIdentifier

@NotNull
String getLocationIdentifier()

A string representing the location of the repository

Returns:

checkConnection

@NotNull
ErrorCollection checkConnection()

This method internally validates the current connection for the repository. Usually the same as running validate

Returns:

ErrorCollection must not be null. The errors should be translated to error messages, rather than field errors.

getMinimalEditHtml

@Nullable
String getMinimalEditHtml(@NotNull
                                   BuildConfiguration buildConfiguration)

Returns HTML for the minimal configuration of the repository. i.e. the basic config required to get it working.

Parameters:

buildConfiguration - BuildConfiguration object

Returns:

HTML for the minimal configuration of the repository