com.atlassian.bamboo.plugins.git.v2

Class GitBambooSpecsHandler

java.lang.Object

com.atlassian.bamboo.plugins.git.v2.AbstractGitExecutor

com.atlassian.bamboo.plugins.git.v2.GitBambooSpecsHandler

All Implemented Interfaces:

BambooSpecsHandler

public class GitBambooSpecsHandler
extends AbstractGitExecutor
implements BambooSpecsHandler

Field Summary

Fields inherited from class com.atlassian.bamboo.plugins.git.v2.AbstractGitExecutor

buildDirectoryManager, customVariableContext, DEFAULT_BRANCH, i18nResolver, sshProxyService, trustedKeyHelper

Fields inherited from interface com.atlassian.bamboo.vcs.BambooSpecsHandler

BAMBOO_SPECS_DIRECTORY, BAMBOO_YAML_FILES

Constructor Summary

Constructors

Constructor and Description
GitBambooSpecsHandler(CapabilityContext capabilityContext, CredentialsAccessor credentialsAccessor, CustomVariableContext customVariableContext, BuildDirectoryManager buildDirectoryManager, com.atlassian.sal.api.message.I18nResolver i18nResolver, TrustedKeyHelper trustedKeyHelper, SshProxyService sshProxyService)

Method Summary

Modifier and Type	Method and Description
Optional<String>	detectSpecRevision(VcsRepositoryData repositoryData, Object source) Attempts to obtain latest revision from the repository which may have changed Bamboo Specs.
List<CommitContext>	findCommitsToSpecs(VcsRepositoryData repositoryData, String rev1, String rev2) Extracts a list of commits related to Bamboo Specs, which occurred between revisions rev1 and rev2.
boolean	isNewer(VcsRepositoryData repositoryData, String rev1, String rev2) Returns true if rev2 is a newer revision in the repository than rev1.
boolean	isWebhookRequired()

Methods inherited from class com.atlassian.bamboo.plugins.git.v2.AbstractGitExecutor

getAccessData, getCacheDirectory, getCachePath, getGitCapability, getSharedCredentialsIdField, getSshCapability, getSubstitutedAccessData, getSubstitutedAccessDataBuilder, getWorkingDirectory, isUsingSharedCredentials, rethrowOrRemoveDirectory, substituteString

Methods inherited from class java.lang.Object

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

Constructor Detail

GitBambooSpecsHandler

@Inject
public GitBambooSpecsHandler(CapabilityContext capabilityContext,
                                     CredentialsAccessor credentialsAccessor,
                                     CustomVariableContext customVariableContext,
                                     BuildDirectoryManager buildDirectoryManager,
                                     com.atlassian.sal.api.message.I18nResolver i18nResolver,
                                     TrustedKeyHelper trustedKeyHelper,
                                     SshProxyService sshProxyService)

Method Detail

detectSpecRevision

@NotNull
public Optional<String> detectSpecRevision(@NotNull
                                                    VcsRepositoryData repositoryData,
                                                    @NotNull
                                                    Object source)
                                             throws RepositoryException

Description copied from interface: BambooSpecsHandler

Attempts to obtain latest revision from the repository which may have changed Bamboo Specs.

Specified by:

detectSpecRevision in interface BambooSpecsHandler

Parameters:

repositoryData - repository

source - entry point to begin scanning (for example: branch name), actual type may depend on repository type

Returns:

latest revision or Optional.empty() if BambooSpecsHandler.BAMBOO_SPECS_DIRECTORY doesn't exist.

Throws:

RepositoryException

isNewer

public boolean isNewer(@NotNull
                       VcsRepositoryData repositoryData,
                       @NotNull
                       String rev1,
                       @NotNull
                       String rev2)
                throws RepositoryException

Description copied from interface: BambooSpecsHandler

Returns true if rev2 is a newer revision in the repository than rev1. In other words, returns true if it is possible to reach rev1 by following parent relationship starting from rev2.

Specified by:

isNewer in interface BambooSpecsHandler

Throws:

RepositoryException

findCommitsToSpecs

@NotNull
public List<CommitContext> findCommitsToSpecs(@NotNull
                                                       VcsRepositoryData repositoryData,
                                                       @NotNull
                                                       String rev1,
                                                       @NotNull
                                                       String rev2)
                                                throws RepositoryException

Description copied from interface: BambooSpecsHandler

Extracts a list of commits related to Bamboo Specs, which occurred between revisions rev1 and rev2.

Specified by:

findCommitsToSpecs in interface BambooSpecsHandler

Throws:

RepositoryException

isWebhookRequired

public boolean isWebhookRequired()

Specified by:

isWebhookRequired in interface BambooSpecsHandler

Returns:

true if vcs requires setting webhook for Bamboo Specs processing, false otherwise