public class BitbucketRepository extends AbstractStandaloneRepository implements BranchInformationProvider, BranchMergingAwareRepository, CachingAwareRepository, CustomSourceDirectoryAwareRepository, CustomVariableProviderRepository, DeploymentAwareRepository, HgRepositoryFacade, GitRepositoryFacade, PushCapableRepository, RequirementsAwareRepository, UniqueRevisionIdRepository, ScmTypePublishingRepository, TestConnectionAwareRepository, SharedCredentialDepender, EditActionAwareRepository
CachingAwareRepository.CachableOperation
administrationConfigurationAccessor, BUILD_TRIGGER_IP, buildDirectoryManager, buildLoggerManager, customVariableContext, featureManager, REPO_PREFIX, repositoryModuleDescriptor, templateRenderer, textProvider
moduleDescriptor
SELECTED_REPOSITORY, UNKNOWN_HOST
GIT_REPOSITORIES_OF_PLAN
HOST_KEY
FILTER_PATTERN_EXCLUDE, FILTER_PATTERN_INCLUDE, FILTER_PATTERN_NONE, FILTER_PATTERN_OPTION, FILTER_PATTERN_REGEX
CHANGESET_FILTER_PATTERN_REGEX, MAVEN_RELEASE_PLUGIN_EXCLUSION_PATTERN
Constructor and Description |
---|
BitbucketRepository() |
Modifier and Type | Method and Description |
---|---|
void |
addDefaultValues(BuildConfiguration buildConfiguration)
Extension point for adding default values to the form for
RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan) |
BitbucketAuthenticationType |
authenticationType() |
void |
beforeEditPageRendering(org.apache.commons.configuration.HierarchicalConfiguration configuration)
Action to be taken before rendering the edit page.
|
ErrorCollection |
beforeSave(org.apache.commons.configuration.HierarchicalConfiguration configuration)
Action to be taken before repository is saved from the UI.
|
BuildRepositoryChanges |
collectChangesForRevision(PlanKey planKey,
String targetRevision)
Collects the changes for the targetRevision.
|
BuildRepositoryChanges |
collectChangesSinceLastBuild(String planKey,
String lastVcsRevisionKey)
Collects the changes since the lastVcsRevisionKey.
|
String |
commit(File sourceDirectory,
String message)
Perform a commit (dvcs commit).
|
BitbucketAccessLevel |
getAccessLevel() |
List<NameValuePair> |
getAccessLevels() |
CacheId |
getCacheId(CachingAwareRepository.CachableOperation cachableOperation)
Cache id has to fulfill the following:
Given two Repository objects A and B, returning equal CacheId (in terms of equals()) and a cachable operation foo(),
in the following sequence of calls made in a short time period:
1.
|
CapabilityContext |
getCapabilityContext() |
Map<String,String> |
getCustomVariables()
Return a map containing name->value mapping of the variables.
|
CommitContext |
getFirstCommit()
Retrieve the commit that created the Branch.
|
GitRepository |
getGitRepository() |
HgRepository |
getHgRepository() |
String |
getHost()
What's the repository server host
|
CommitContext |
getLastCommit()
Retrieve last commit on the branch set on this Repository.
|
String |
getName()
The display name for the repository type
|
List<VcsBranch> |
getOpenBranches(String context)
Set of open branches that are discovered in the repository. |
String |
getOptionDescription() |
String |
getOwner() |
String |
getPassword() |
BitbucketPasswordCredentialsSource |
getPasswordCredentialsSource() |
List<NameValuePair> |
getPasswordCredentialsSources() |
List<NameValuePair> |
getPasswordSharedCredentials() |
Long |
getPasswordSharedCredentialsId() |
Map<String,String> |
getPlanRepositoryVariables()
Return a map containing name->value mapping of the plan repository format variables.
|
List<NameValuePair> |
getPrivateRepositoryAuthenticationTypes() |
String |
getRealRepositoryUrl() |
String |
getRepositoryOwner() |
String |
getRepositorySlug() |
Set<Requirement> |
getRequirements() |
String |
getScm()
Get a string representing the name of the repository type.
|
Iterable<Long> |
getSharedCredentialIds()
Returns a list of shared credential ids used by this class.
|
BitbucketSshCredentialsSource |
getSshCredentialsSource() |
List<NameValuePair> |
getSshCredentialsSources() |
List<NameValuePair> |
getSshSharedCredentials() |
String |
getUsername() |
VcsBranch |
getVcsBranch() |
boolean |
isCachingSupportedFor(CachingAwareRepository.CachableOperation cachableOperation) |
boolean |
isFetchWholeRepository() |
boolean |
isMergingSupported() |
boolean |
isRepositoryDifferent(Repository repository)
Checks if the current repo is the same as the given repository
|
boolean |
isVerboseLogs() |
boolean |
mergeWorkspaceWith(BuildContext buildContext,
File checkoutDirectory,
String targetRevision)
Merges a workspace located in checkout directory with the target revision.
|
void |
populateFromConfig(org.apache.commons.configuration.HierarchicalConfiguration config)
Update the current object with data in the
HierarchicalConfiguration |
void |
prepareConfigObject(BuildConfiguration buildConfiguration)
Do any preprocessing work before validation occurs.
|
void |
pushRevision(File sourceDirectory,
String vcsRevisionKey)
Push the specified revision to the remote directory.
|
String |
retrieveSourceCode(BuildContext buildContext,
String vcsRevisionKey,
File sourceDirectory)
Checks out the latest source code from an appropriate repository to specified directory
|
String |
retrieveSourceCode(BuildContext buildContext,
String vcsRevisionKey,
File sourceDirectory,
int depth)
Checks out the latest source code from an appropriate repository to specified directory
|
void |
setBitbucketApiService(BitbucketApiService bitbucketApiService) |
void |
setBitbucketValidationHelper(BitbucketValidationHelper bitbucketValidationHelper) |
void |
setCapabilityContext(CapabilityContext capabilityContext) |
void |
setCredentialsAccessor(CredentialsAccessor credentialsAccessor) |
void |
setI18nResolver(com.atlassian.sal.api.message.I18nResolver i18nResolver) |
void |
setRepositoryHelperService(BitbucketRepositoryHelperService repositoryHelperService) |
void |
setRepositoryManager(RepositoryManager repositoryManager) |
void |
setVcsBranch(VcsBranch branch)
Set and prepare the repository for using an arbitrary branch.
|
ErrorCollection |
testConnection(long timeout,
TimeUnit unit)
Test connection to the repository within the given timeout.
|
org.apache.commons.configuration.HierarchicalConfiguration |
toConfiguration()
Generate a
HierarchicalConfiguration from the current state of the object |
boolean |
usePollingForBranchDetection()
If Bamboo generic detection polling should be used for this repository
|
ErrorCollection |
validate(BuildConfiguration configuration)
Validates the properties in the
BuildConfiguration object. |
ErrorCollection |
validateForConnectionTesting(BuildConfiguration configuration)
A method similar to
BuildConfigurationAwarePlugin.validate(BuildConfiguration) used to validate repository configuration
before connection testing. |
getAdvancedEditHtml, getAdvancedViewHtml, getEditHtml, getViewHtml, getViewHtml
checkConnection, customizeBuildRequirements, getAdvancedEditHtml, getAdvancedViewHtml, getBranchIntegrationEditHtml, getChangesetFilterPatternRegex, getDefaultTriggerModule, getDescription, getEditHtml, getFilterFilePatternOption, getFilterFilePatternRegex, getKey, getLocationIdentifier, getMavenPomCheckoutAccessEditHtml, getMaxCommitsToReturn, getMaxRetries, getMinimalEditHtml, getPollingTriggerModule, getQuietPeriod, getShortKey, getSourceCodeDirectory, getSystemWideExclusionPatterns, getViewHtml, getWorkingDirectory, init, isAdvancedOptionEnabled, isQuietPeriodEnabled, isWorkspaceEmpty, removeBuildRequirements, setAdministrationConfigurationAccessor, setBuildDirectoryManager, setBuildLoggerManager, setChangesetFilterPatternRegex, setCustomVariableContext, setFeatureManager, setFilterFilePatternOption, setFilterFilePatternRegex, setTemplateRenderer, setTextProvider, setWorkingDir, substituteString, toMergeCapableRepository
populateContextForEdit, populateContextForView
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
checkConnection, getKey, getLocationIdentifier, getMinimalEditHtml, getShortKey
getSourceCodeDirectory
customizeBuildRequirements, removeBuildRequirements
isConfigurationMissing
init
getEditHtml, getViewHtml
getDescription
getBranchIntegrationEditHtml
public static final String REPOSITORY_BITBUCKET_ACCESS_LEVEL
public static final String REPOSITORY_BITBUCKET_AUTHENTICATION_TYPE
public static final String REPOSITORY_BITBUCKET_OWNER
public static final String REPOSITORY_BITBUCKET_USERNAME
public static final String REPOSITORY_BITBUCKET_PASSWORD
public static final String REPOSITORY_BITBUCKET_PASSWORD_CREDENTIALS_SOURCE
public static final String REPOSITORY_BITBUCKET_PASSWORD_SHARED_CREDENTIALS_ID
public static final String REPOSITORY_BITBUCKET_PASSWORD_SHARED_CREDENTIALS_DELETED
public static final String REPOSITORY_BITBUCKET_REPOSITORY
public static final String REPOSITORY_BITBUCKET_SSH_CREDENTIALS_SOURCE
public static final String REPOSITORY_BITBUCKET_SSH_SHARED_CREDENTIALS_ID
public static final String REPOSITORY_BITBUCKET_SSH_SHARED_CREDENTIALS_DELETED
public static final String REPOSITORY_BITBUCKET_SSH_KEY
public static final String REPOSITORY_BITBUCKET_SSH_PASSPHRASE
public static final String REPOSITORY_BITBUCKET_SCM
public static final String REPOSITORY_BITBUCKET_BRANCH
public static final String REPOSITORY_BITBUCKET_COMMAND_TIMEOUT
public static final String REPOSITORY_BITBUCKET_VERBOSE_LOGS
public static final String REPOSITORY_BITBUCKET_FETCH_WHOLE_REPOSITORY
public static final String REPOSITORY_BITBUCKET_GIT_USE_SHALLOW_CLONES
public static final String REPOSITORY_BITBUCKET_GIT_LFS
public static final String REPOSITORY_BITBUCKET_GIT_USE_SUBMODULES
public static final String REPOSITORY_BITBUCKET_GIT_USE_REMOTE_AGENT_CACHE
public static final String REPOSITORY_BITBUCKET_TEMPORARY_PASSWORD
public static final String REPOSITORY_BITBUCKET_PASSWORD_CHANGE
public static final String REPOSITORY_BITBUCKET_TEMPORARY_SSH_PASSPHRASE
public static final String REPOSITORY_BITBUCKET_TEMPORARY_SSH_PASSPHRASE_CHANGE
public static final String REPOSITORY_BITBUCKET_TEMPORARY_SSH_KEY_FROM_FILE
public static final String REPOSITORY_BITBUCKET_TEMPORARY_SSH_KEY_CHANGE
@NotNull public String getName()
Repository
getName
in interface Repository
getName
in interface DescriptionProvider
getName
in interface NameProvider
public String getScm()
ScmTypePublishingRepository
getScm
in interface ScmTypePublishingRepository
public String getHost()
Repository
getHost
in interface Repository
public boolean isRepositoryDifferent(@NotNull Repository repository)
RepositoryV2
isRepositoryDifferent
in interface RepositoryV2
repository
- to compare againstpublic void addDefaultValues(@NotNull BuildConfiguration buildConfiguration)
BuildConfigurationAwarePlugin
RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)
addDefaultValues
in interface BuildConfigurationAwarePlugin
addDefaultValues
in class AbstractRepository
buildConfiguration
- -public void beforeEditPageRendering(@NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)
EditActionAwareRepository
beforeEditPageRendering
in interface EditActionAwareRepository
configuration
- configuration to be loaded into the UIpublic ErrorCollection beforeSave(@NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)
EditActionAwareRepository
beforeSave
in interface EditActionAwareRepository
public void prepareConfigObject(@NotNull BuildConfiguration buildConfiguration)
BuildConfigurationAwarePlugin
prepareConfigObject
in interface BuildConfigurationAwarePlugin
prepareConfigObject
in class BaseBuildConfigurationAwarePlugin
buildConfiguration
- -public void populateFromConfig(@NotNull org.apache.commons.configuration.HierarchicalConfiguration config)
ConvertibleFromConfig
HierarchicalConfiguration
populateFromConfig
in interface ConvertibleFromConfig
populateFromConfig
in class AbstractRepository
@NotNull public org.apache.commons.configuration.HierarchicalConfiguration toConfiguration()
ConvertibleFromConfig
HierarchicalConfiguration
from the current state of the objecttoConfiguration
in interface ConvertibleFromConfig
toConfiguration
in class AbstractRepository
HierarchicalConfiguration
. Never null@NotNull public ErrorCollection validateForConnectionTesting(@NotNull BuildConfiguration configuration)
TestConnectionAwareRepository
BuildConfigurationAwarePlugin.validate(BuildConfiguration)
used to validate repository configuration
before connection testing.
This method may be more relaxed than normal validation. Additionally, different error messages may be displayed
(e.g. related to impossibility of transferring files).validateForConnectionTesting
in interface TestConnectionAwareRepository
configuration
- repository configuration to validate@NotNull public ErrorCollection validate(@NotNull BuildConfiguration configuration)
BuildConfigurationAwarePlugin
BuildConfiguration
object. The name of the properties match those passed
in through the form fragments in RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)
template.validate
in interface BuildConfigurationAwarePlugin
validate
in class AbstractRepository
configuration
- -ErrorCollection
keyed by the field name.@Nullable public Long getPasswordSharedCredentialsId()
@NotNull public Iterable<Long> getSharedCredentialIds()
SharedCredentialDepender
getSharedCredentialIds
in interface SharedCredentialDepender
@NotNull public List<NameValuePair> getPasswordCredentialsSources()
@NotNull public List<NameValuePair> getSshCredentialsSources()
@NotNull public List<NameValuePair> getPasswordSharedCredentials()
@NotNull public List<NameValuePair> getSshSharedCredentials()
@NotNull public List<NameValuePair> getAccessLevels()
@NotNull public List<NameValuePair> getPrivateRepositoryAuthenticationTypes()
@NotNull public BuildRepositoryChanges collectChangesForRevision(@NotNull PlanKey planKey, @NotNull String targetRevision) throws RepositoryException
OnceOffCapableRepository
collectChangesForRevision
in interface OnceOffCapableRepository
collectChangesForRevision
in class AbstractRepository
RepositoryException
- if something goes wrong@NotNull public BuildRepositoryChanges collectChangesSinceLastBuild(@NotNull String planKey, @Nullable String lastVcsRevisionKey) throws RepositoryException
RepositoryV2
collectChangesSinceLastBuild
in interface RepositoryV2
lastVcsRevisionKey
- can be null, if null you should ensure the correct vcsrevisionkey is returned in the BuildChanges object.RepositoryException
- if something goes wrong@NotNull public String retrieveSourceCode(@NotNull BuildContext buildContext, @Nullable String vcsRevisionKey, @NotNull File sourceDirectory) throws RepositoryException
CustomSourceDirectoryAwareRepository
retrieveSourceCode
in interface CustomSourceDirectoryAwareRepository
vcsRevisionKey
- - may be null if you want latest codesourceDirectory
- - directory to checkout toRepositoryException
@NotNull public String retrieveSourceCode(@NotNull BuildContext buildContext, @Nullable String vcsRevisionKey, @NotNull File sourceDirectory, int depth) throws RepositoryException
BranchMergingAwareRepository
retrieveSourceCode
in interface BranchMergingAwareRepository
vcsRevisionKey
- - may be null if you want latest codesourceDirectory
- - directory to checkout todepth
- - how many historical revisions we'd like to check out (-1 means all revisions)RepositoryException
@NotNull public ErrorCollection testConnection(long timeout, @NotNull TimeUnit unit)
TestConnectionAwareRepository
testConnection
in interface TestConnectionAwareRepository
timeout
- the maximum time to waitunit
- the time unit of the timeout argument@NotNull public Set<Requirement> getRequirements()
getRequirements
in interface RequirementsAwareRepository
public void setBitbucketApiService(BitbucketApiService bitbucketApiService)
public void setRepositoryHelperService(BitbucketRepositoryHelperService repositoryHelperService)
public void setI18nResolver(com.atlassian.sal.api.message.I18nResolver i18nResolver)
public void setRepositoryManager(RepositoryManager repositoryManager)
public void setCredentialsAccessor(CredentialsAccessor credentialsAccessor)
public void setBitbucketValidationHelper(BitbucketValidationHelper bitbucketValidationHelper)
public CapabilityContext getCapabilityContext()
public void setCapabilityContext(CapabilityContext capabilityContext)
public String getRealRepositoryUrl()
public boolean isVerboseLogs()
public boolean isFetchWholeRepository()
public String getOptionDescription()
public CacheId getCacheId(@NotNull CachingAwareRepository.CachableOperation cachableOperation)
CachingAwareRepository
getCacheId
in interface CachingAwareRepository
public boolean isCachingSupportedFor(@NotNull CachingAwareRepository.CachableOperation cachableOperation)
isCachingSupportedFor
in interface CachingAwareRepository
@NotNull public List<VcsBranch> getOpenBranches(@Nullable String context) throws RepositoryException
BranchDetectionCapableRepository
Set
of open branches that are discovered in the repository. Returns empty collection if no branches at
all (can that happen?). Used for monitoring repositories for new branches.
An open branch is a branch that is considered 'open' by underlying VCS - it has nothing to do with the actual
development on that branch (recent commits or so).getOpenBranches
in interface BranchDetectionCapableRepository
List
of branch names. May be empty.RepositoryException
@Nullable public String getOwner()
@Nullable public String getUsername()
@Nullable public String getPassword()
public BitbucketAccessLevel getAccessLevel()
public BitbucketAuthenticationType authenticationType()
public BitbucketPasswordCredentialsSource getPasswordCredentialsSource()
public BitbucketSshCredentialsSource getSshCredentialsSource()
public String getRepositoryOwner()
public String getRepositorySlug()
@NotNull public VcsBranch getVcsBranch()
getVcsBranch
in interface BranchAwareRepository
public void setVcsBranch(@NotNull VcsBranch branch)
BranchAwareRepository
setVcsBranch
in interface BranchAwareRepository
public CommitContext getFirstCommit() throws RepositoryException
BranchDetectionCapableRepository
getFirstCommit
in interface BranchDetectionCapableRepository
RepositoryException
public CommitContext getLastCommit() throws RepositoryException
BranchDetectionCapableRepository
getLastCommit
in interface BranchDetectionCapableRepository
RepositoryException
public boolean mergeWorkspaceWith(@NotNull BuildContext buildContext, @NotNull File checkoutDirectory, @NotNull String targetRevision) throws RepositoryException
BranchMergingAwareRepository
mergeWorkspaceWith
in interface BranchMergingAwareRepository
buildContext
- the build context of build doing the mergecheckoutDirectory
- the workspace to use for mergetargetRevision
- the revision to merge withRepositoryException
public boolean isMergingSupported()
isMergingSupported
in interface BranchMergingAwareRepository
public void pushRevision(@NotNull File sourceDirectory, @Nullable String vcsRevisionKey) throws RepositoryException
PushCapableRepository
pushRevision
in interface PushCapableRepository
sourceDirectory
- - the working directory of the repository we want to push fromvcsRevisionKey
- - the revisionKey (usually a branch name) to pushRepositoryException
- - when something goes wrong@NotNull public String commit(@NotNull File sourceDirectory, @NotNull String message) throws RepositoryException
PushCapableRepository
commit
in interface PushCapableRepository
sourceDirectory
- - which workspace directory to perform the commitmessage
- - what message use for commitRepositoryException
- - when something goes wrongpublic boolean usePollingForBranchDetection()
BranchInformationProvider
usePollingForBranchDetection
in interface BranchInformationProvider
@Nullable public GitRepository getGitRepository()
getGitRepository
in interface GitRepositoryFacade
@Nullable public HgRepository getHgRepository()
getHgRepository
in interface HgRepositoryFacade
@NotNull public Map<String,String> getCustomVariables()
CustomVariableProviderRepository
Null values will be filtered out so it's safe to put them in the map.
getCustomVariables
in interface CustomVariableProviderRepository
@NotNull public Map<String,String> getPlanRepositoryVariables()
CustomVariableProviderRepository
Null values will be filtered out so it's safe to put them in the map.
getPlanRepositoryVariables
in interface CustomVariableProviderRepository
Copyright © 2019 Atlassian Software Systems Pty Ltd. All rights reserved.