com.atlassian.bamboo.plugins.github

Class GitHubCommitCommenter

java.lang.Object

com.atlassian.bamboo.plugins.github.GitHubCommitCommenter

All Implemented Interfaces:

IdentifyingExecutor<VcsCommitCommenter>, VcsCommitCommenter

public class GitHubCommitCommenter
extends Object
implements VcsCommitCommenter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitHubCommitCommenter.DeploymentDTO
static class	GitHubCommitCommenter.MissingPermissionEntity
static class	GitHubCommitCommenter.PlanDTO

Constructor Summary

Constructors

Constructor and Description

GitHubCommitCommenter(AdministrationConfigurationAccessor administrationConfigurationAccessor, CachedRepositoryDefinitionManager cachedRepositoryDefinitionManager, DeploymentProjectService deploymentProjectService, ProjectManager projectManager, RepositoryDefinitionManager repositoryDefinitionManager, RepositoryStoredSpecsLogService repositoryStoreSpecsLogService, TemplateRenderer templateRenderer)

Method Summary

Modifier and Type	Method and Description
ContextualVcsId<VcsCommitCommenter>	getVcsIdForExecutor(VcsRepositoryData vcsRepositoryData) Returned id has to fulfill the following: Given two VcsRepositoryData objects A and B, and executor e returning equal ContextualVcsId (in terms of equals()), for any operation foo() provided by the executor, the calls e::foo(A) and e::foo(B) should be equivalent.
boolean	publishComment(VcsRepositoryData repositoryData, String commitId, String payload) Publish comment to repository commit.
boolean	publishRssStatus(VcsRepositoryData repositoryData, String commitId, com.atlassian.event.Event event) Publish Bamboo Specs execution status to repository commit.

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubCommitCommenter

@Inject
public GitHubCommitCommenter(AdministrationConfigurationAccessor administrationConfigurationAccessor,
                                     CachedRepositoryDefinitionManager cachedRepositoryDefinitionManager,
                                     DeploymentProjectService deploymentProjectService,
                                     ProjectManager projectManager,
                                     RepositoryDefinitionManager repositoryDefinitionManager,
                                     RepositoryStoredSpecsLogService repositoryStoreSpecsLogService,
                                     TemplateRenderer templateRenderer)

Method Detail

publishRssStatus

public boolean publishRssStatus(@NotNull
                                VcsRepositoryData repositoryData,
                                @NotNull
                                String commitId,
                                @NotNull
                                com.atlassian.event.Event event)
                         throws RepositoryException

Description copied from interface: VcsCommitCommenter

Publish Bamboo Specs execution status to repository commit.

Specified by:

publishRssStatus in interface VcsCommitCommenter

commitId - identifier of commit which should receive comment. For git-based repos it's SHA.

event - is RssEvent from bamboo-core.

Returns:

true if published comment successfully.

Throws:

RepositoryException - when commit not found or credentials are wrong

publishComment

public boolean publishComment(@NotNull
                              VcsRepositoryData repositoryData,
                              @NotNull
                              String commitId,
                              @NotNull
                              String payload)
                       throws RepositoryException

Description copied from interface: VcsCommitCommenter

Publish comment to repository commit.

Specified by:

publishComment in interface VcsCommitCommenter

commitId - identifier of commit which should receive comment. For git-based repos it's SHA.

payload - content of comment

Returns:

true if published comment successfully.

Throws:

RepositoryException - when commit not found or credentials are wrong

getVcsIdForExecutor

@Nullable
public ContextualVcsId<VcsCommitCommenter> getVcsIdForExecutor(@NotNull
                                                                         VcsRepositoryData vcsRepositoryData)

Description copied from interface: IdentifyingExecutor

Returned id has to fulfill the following: Given two VcsRepositoryData objects A and B, and executor e returning equal ContextualVcsId (in terms of equals()), for any operation foo() provided by the executor, the calls e::foo(A) and e::foo(B) should be equivalent. To be more precise: given any time point t and any variable context v, calling a::foo(A) should yield the same results as calling e::foo(B). Given the above it follows that - calculation of the id should take into account global and plan variables. This means, that calling this method on the same object in different variable context can (possibly must) yield different results. - equal ids need not (and should not) guarantee equal call results over indefinite time. In particular, result of e:foo(A).equals(e::foo(A)) is allowed to be false, since 2 calls to e::foo(A) do not happen at the same time. Example: 2 git repositories with the same url and credentials are considered equal in context of VcsBranchDetector. If they also point to the same branch, they are considered equal in context of VcsChangeDetector

Specified by:

getVcsIdForExecutor in interface IdentifyingExecutor<VcsCommitCommenter>

Returns:

the id of repository, can be null if no feasible identification algorithm exists