Package com.atlassian.bamboo.vcs.runtime

Interface FixedDirectoryWorkingCopyManager

All Superinterfaces:

VcsWorkingCopyManager

All Known Implementing Classes:

LegacyFixedDirectoryWorkingCopyManager

@Deprecated
public interface FixedDirectoryWorkingCopyManager
extends VcsWorkingCopyManager

Deprecated.

since 5.14 the purpose of this interface is to support exotic repository types.

Manages working copy in a pre-defined directory (i.e. location of the working copy is determined by a repository configuration and cannot be changed at will). Implementation should be stateless. Implementors should prefer VcsWorkingCopyManager instead, as this variant severely limits implementation's usefulness. For example, repository plugins implementing this interface cannot be used in deployment projects. Use only if you must.

Method Summary

Modifier and Type	Method	Description
@NotNull File	getWorkingCopyPath(@NotNull CommonContext commonContext, @NotNull VcsRepositoryData repositoryData)	Deprecated. Based on configuration and current context produce absolute path to the working copy.
@NotNull VcsWorkingCopy	retrieveSourceCode(@NotNull CommonContext commonContext, @NotNull VcsRepositoryData repositoryData, @NotNull PlanVcsRevisionData targetRevision)	Deprecated. Checkout or update a working copy to a revision.
default @NotNull VcsWorkingCopy	retrieveSourceCode(@NotNull CommonContext commonContext, @NotNull VcsRepositoryData repositoryData, @NotNull PlanVcsRevisionData targetRevision, @NotNull File targetPath)	Deprecated. If you can implement this correctly using targetPath, then you should not be implementing this interface.
default @NotNull VcsWorkingCopy	updateToLatestRevision(@NotNull CommonContext commonContext, @NotNull VcsRepositoryData repositoryData, @NotNull File targetPath)	Deprecated. If you can implement this, then you should not be implementing this interface.

Method Detail

retrieveSourceCode

@NotNull
default @NotNull VcsWorkingCopy retrieveSourceCode(@NotNull
                                                   @NotNull CommonContext commonContext,
                                                   @NotNull
                                                   @NotNull VcsRepositoryData repositoryData,
                                                   @NotNull
                                                   @NotNull PlanVcsRevisionData targetRevision,
                                                   @NotNull
                                                   @NotNull File targetPath)
                                            throws RepositoryException

Deprecated.

If you can implement this correctly using targetPath, then you should not be implementing this interface.

Specified by:

retrieveSourceCode in interface VcsWorkingCopyManager

Parameters:

commonContext - - a current build or deployment context

repositoryData - - configuration of a repository to checkout/update

targetRevision - - revision to check out or update to

targetPath - - workings copy's path. Note that some legacy implementation may ignore this parameter. (see FixedDirectoryWorkingCopyManager)

Returns:

object representing created/updated working copy

Throws:

RepositoryException

updateToLatestRevision

@NotNull
default @NotNull VcsWorkingCopy updateToLatestRevision(@NotNull
                                                       @NotNull CommonContext commonContext,
                                                       @NotNull
                                                       @NotNull VcsRepositoryData repositoryData,
                                                       @NotNull
                                                       @NotNull File targetPath)
                                                throws RepositoryException

Deprecated.

If you can implement this, then you should not be implementing this interface.

Specified by:

updateToLatestRevision in interface VcsWorkingCopyManager

Parameters:

commonContext - - a current build or deployment context

repositoryData - - configuration of a repository to checkout/update

targetPath - - workings copy's path. Note that some legacy implementation may ignore this parameter. (see FixedDirectoryWorkingCopyManager)

Returns:

object representing created/updated working copy

Throws:

UnsupportedOperationException

RepositoryException

retrieveSourceCode

@NotNull
@NotNull VcsWorkingCopy retrieveSourceCode(@NotNull
                                           @NotNull CommonContext commonContext,
                                           @NotNull
                                           @NotNull VcsRepositoryData repositoryData,
                                           @NotNull
                                           @NotNull PlanVcsRevisionData targetRevision)
                                    throws RepositoryException

Deprecated.

Checkout or update a working copy to a revision.

Parameters:

commonContext - - a current build or deployment context

repositoryData - - configuration of a repository to checkout/update

targetRevision - - revision to check out or update to

Returns:

object representing created/updated working copy

Throws:

RepositoryException

getWorkingCopyPath

@NotNull
@NotNull File getWorkingCopyPath(@NotNull
                                 @NotNull CommonContext commonContext,
                                 @NotNull
                                 @NotNull VcsRepositoryData repositoryData)
                          throws RepositoryException

Deprecated.

Based on configuration and current context produce absolute path to the working copy.

Parameters:

commonContext -

repositoryData -

Returns:

Throws:

RepositoryException