com.atlassian.bamboo.plugins.hg

Class HgRepositoryAccessImpl

java.lang.Object

com.atlassian.bamboo.plugins.hg.HgRepositoryAccessImpl

All Implemented Interfaces:

HgRepositoryAccess

@NotThreadSafe
public class HgRepositoryAccessImpl
extends Object
implements HgRepositoryAccess

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SSH_COMMAND
static SecureTemporaryFiles.FileSpecBuilder	TEMPORARY_FILE_SPEC

Constructor Summary

Constructors

Constructor and Description
HgRepositoryAccessImpl(HgRepositoryAccessData substitutedAccessData, BuildLogger buildLogger, com.atlassian.sal.api.message.I18nResolver i18nResolver, SshProxyService sshProxyService, ScopedExclusionService exclusionService, TrustedKeyHelper trustedKeyHelper, CapabilityContext capabilityContext, File workingDirectory)
HgRepositoryAccessImpl(HgRepository repository, BuildLogger buildLogger, com.atlassian.sal.api.message.I18nResolver i18nResolver, SshProxyService sshProxyService, ScopedExclusionService exclusionService, TrustedKeyHelper trustedKeyHelper, CapabilityContext capabilityContext)

Method Summary

Modifier and Type	Method and Description
void	archiveSourceCode(File destinationDirectory, File cacheDirectory, String vcsRevision, String[] includePattern) "Archive" (as in svn export) contents of specified revision, applying specified --include pattern
void	close() Cleans up resources, connections, etc...
void	collectChangesetsBetweenRevisions(BuildRepositoryChanges buildChanges, File planDirectory, String previousVcsRevisionKey, String targetRevision, int maxCommitsToReturn)
BuildRepositoryChanges	collectChangesSinceLastBuild(File cacheDirectory, String previousVcsRevisionKey, int maxCommitsToReturn) Checks whether remote repository has newer revision(s).
String	getDefaultSshCommand()
String	getDisplayName(AuthenticationType authenticationType)
CommitContext	getFirstCommit(File cacheDirectory)
HgCommandProcessor	getHgCommandProcessor()
String	getHgExeCapability()
CommitContext	getLastCommit(File cacheDirectory)
String	getLatestRemoteRevisionHash(File workingDirectory) Returns the latest 40-character hash code of the tip-most change set in remote repository.
String	getProxiedUrl(String connectionDescription)
URI	getRemoteUri()
HgRepositoryAccessData	getSubstitutedAccessData()
void	pullToLocalDirectory(File directory, String repositoryUrl, String targetRevision)
String	retrieveSourceCode(File sourceDirectory, File cacheDirectory, String vcsRevision) Updates sources in sourceDirectory from remote repository to targetRevision.
String	retrieveSourceCode(File sourceDirectory, File cacheDirectory, String vcsRevision, int attempt)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SSH_COMMAND

public static final String DEFAULT_SSH_COMMAND

See Also:

Constant Field Values

TEMPORARY_FILE_SPEC

public static final SecureTemporaryFiles.FileSpecBuilder TEMPORARY_FILE_SPEC

Constructor Detail

HgRepositoryAccessImpl

public HgRepositoryAccessImpl(HgRepository repository,
                              BuildLogger buildLogger,
                              com.atlassian.sal.api.message.I18nResolver i18nResolver,
                              SshProxyService sshProxyService,
                              ScopedExclusionService exclusionService,
                              TrustedKeyHelper trustedKeyHelper,
                              CapabilityContext capabilityContext)
                       throws RepositoryException

Throws:

RepositoryException

HgRepositoryAccessImpl

public HgRepositoryAccessImpl(HgRepositoryAccessData substitutedAccessData,
                              BuildLogger buildLogger,
                              com.atlassian.sal.api.message.I18nResolver i18nResolver,
                              SshProxyService sshProxyService,
                              ScopedExclusionService exclusionService,
                              TrustedKeyHelper trustedKeyHelper,
                              CapabilityContext capabilityContext,
                              File workingDirectory)
                       throws RepositoryException

Throws:

RepositoryException

Method Detail

getDefaultSshCommand

public String getDefaultSshCommand()

collectChangesSinceLastBuild

public BuildRepositoryChanges collectChangesSinceLastBuild(@NotNull
                                                           File cacheDirectory,
                                                           @Nullable
                                                           String previousVcsRevisionKey,
                                                           int maxCommitsToReturn)
                                                    throws RepositoryException

Description copied from interface: HgRepositoryAccess

Checks whether remote repository has newer revision(s). If pullAndCollect is true then updates local cache directory and returns changesets since last checked revision

Specified by:

collectChangesSinceLastBuild in interface HgRepositoryAccess

Parameters:

cacheDirectory - specifies where to store updated repository. Perfectly it should be the 'cache' directory holding shared repository for all plans using the same repository URL

previousVcsRevisionKey - specifies since which revision we want to collect changesets

Returns:

BuildChanges object which will have filled vcsRevisionKey with newest revision from remote repository. If pullAndCollect is true then BuildChanges will have filled changes with repository changesets between previousRevision and newest revision

Throws:

RepositoryException

retrieveSourceCode

public String retrieveSourceCode(@NotNull
                                 File sourceDirectory,
                                 @Nullable
                                 File cacheDirectory,
                                 @Nullable
                                 String vcsRevision)
                          throws RepositoryException

Description copied from interface: HgRepositoryAccess

Updates sources in sourceDirectory from remote repository to targetRevision. Extracts changesets since previousRevision and stores them in collectedChangesetsReceiver. If cacheDirectory is not null it will use it as a mid-repository. Otherwise will pull from remote repository directly.

Specified by:

retrieveSourceCode in interface HgRepositoryAccess

Parameters:

sourceDirectory - specifies where we want to retrieve sources

cacheDirectory - specifies where is kept local cache directory, which will hold presumably a more updated repository than sourceDirectory.

vcsRevision - specifies since which revision we want to collect changesets

Returns:

targetRevision

Throws:

RepositoryException

retrieveSourceCode

public String retrieveSourceCode(@NotNull
                                 File sourceDirectory,
                                 @Nullable
                                 File cacheDirectory,
                                 @Nullable
                                 String vcsRevision,
                                 int attempt)
                          throws RepositoryException

Throws:

RepositoryException

archiveSourceCode

public void archiveSourceCode(@NotNull
                              File destinationDirectory,
                              @NotNull
                              File cacheDirectory,
                              @NotNull
                              String vcsRevision,
                              @Nullable
                              String[] includePattern)
                       throws RepositoryException

Description copied from interface: HgRepositoryAccess

"Archive" (as in svn export) contents of specified revision, applying specified --include pattern

Differs from {link #retrieveSourceCode} by not cloning the repository first (think "svn checkout" vs. "svn export")

Specified by:

archiveSourceCode in interface HgRepositoryAccess

Parameters:

destinationDirectory - directory to extract files to

cacheDirectory - local repository to extract from

vcsRevision - revision to extract, tip if null

includePattern - include patterns to limit extracted files, all files if null or empty

Throws:

RepositoryException - on any error

close

public void close()

Description copied from interface: HgRepositoryAccess

Cleans up resources, connections, etc...

Specified by:

close in interface HgRepositoryAccess

getLastCommit

public CommitContext getLastCommit(@NotNull
                                   File cacheDirectory)
                            throws RepositoryException

Specified by:

getLastCommit in interface HgRepositoryAccess

Throws:

RepositoryException

getFirstCommit

@NotNull
public CommitContext getFirstCommit(@NotNull
                                             File cacheDirectory)
                                      throws RepositoryException

Specified by:

getFirstCommit in interface HgRepositoryAccess

Throws:

RepositoryException

collectChangesetsBetweenRevisions

public void collectChangesetsBetweenRevisions(@NotNull
                                              BuildRepositoryChanges buildChanges,
                                              File planDirectory,
                                              String previousVcsRevisionKey,
                                              String targetRevision,
                                              int maxCommitsToReturn)
                                       throws RepositoryException

Throws:

RepositoryException

pullToLocalDirectory

public void pullToLocalDirectory(@NotNull
                                 File directory,
                                 @NotNull
                                 String repositoryUrl,
                                 @Nullable
                                 String targetRevision)
                          throws RepositoryException

Throws:

RepositoryException

getLatestRemoteRevisionHash

@NotNull
public String getLatestRemoteRevisionHash(@NotNull
                                                   File workingDirectory)
                                            throws RepositoryException

Description copied from interface: HgRepositoryAccess

Returns the latest 40-character hash code of the tip-most change set in remote repository.

Specified by:

getLatestRemoteRevisionHash in interface HgRepositoryAccess

Parameters:

workingDirectory - working directory to execute command

Returns:

latest revision hash

Throws:

RepositoryException - on any error

getRemoteUri

@Nullable
public URI getRemoteUri()

getProxiedUrl

@NotNull
public String getProxiedUrl(@Nullable
                                     String connectionDescription)
                              throws RepositoryException

Throws:

RepositoryException

getDisplayName

public String getDisplayName(AuthenticationType authenticationType)

Returns:

display name for AuthenticationType

getHgExeCapability

@Nullable
public String getHgExeCapability()

getHgCommandProcessor

public HgCommandProcessor getHgCommandProcessor()

getSubstitutedAccessData

public HgRepositoryAccessData getSubstitutedAccessData()