com.atlassian.bamboo.v2.build.repository

Interface CustomSourceDirectoryAwareRepository

All Superinterfaces:

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

All Known Subinterfaces:

BitbucketDelegatedRepository, BranchMergingAwareRepository, StashRepository

All Known Implementing Classes:

BitbucketRepository, GitHubRepository, GitRepository, NullRepository, StashRepositoryImpl, SvnRepository

public interface CustomSourceDirectoryAwareRepository
extends Repository

Repository that supports checkout to any directory.

Field Summary

Fields inherited from interface com.atlassian.bamboo.repository.Repository

SELECTED_REPOSITORY, UNKNOWN_HOST

Method Summary

Modifier and Type	Method and Description
@NotNull String	retrieveSourceCode(@NotNull BuildContext buildContext, @Nullable String vcsRevisionKey, @NotNull File sourceDirectory) Checks out the latest source code from an appropriate repository to specified directory

Methods inherited from interface com.atlassian.bamboo.repository.Repository

checkConnection, getHost, getKey, getLocationIdentifier, getMinimalEditHtml, getName, getShortKey

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, isConfigurationMissing, 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

Method Detail

retrieveSourceCode

@NotNull
@NotNull String retrieveSourceCode(@NotNull
                                            @NotNull BuildContext buildContext,
                                            @Nullable
                                            @Nullable String vcsRevisionKey,
                                            @NotNull
                                            @NotNull File sourceDirectory)
                                     throws RepositoryException

Checks out the latest source code from an appropriate repository to specified directory

Parameters:

buildContext -

vcsRevisionKey - - may be null if you want latest code

sourceDirectory - - directory to checkout to

Returns:

vcsRevisionKey - the revision

Throws:

RepositoryException