Package com.atlassian.bamboo.plugins.stash

Class BitbucketServerBuildWarningsUpdater

java.lang.Object

com.atlassian.bamboo.plugins.stash.v2.AbstractBitbucketServerExecutor

com.atlassian.bamboo.plugins.stash.BitbucketServerBuildWarningsUpdater

All Implemented Interfaces:

IdentifyingExecutor<VcsBuildWarningsUpdater>, VcsBuildWarningsUpdater

public class BitbucketServerBuildWarningsUpdater
extends AbstractBitbucketServerExecutor
implements VcsBuildWarningsUpdater

Field Summary

Fields inherited from class com.atlassian.bamboo.plugins.stash.v2.AbstractBitbucketServerExecutor

vcsRepositoryManager

Constructor Summary

Constructors

Constructor	Description
BitbucketServerBuildWarningsUpdater()

Method Summary

Modifier and Type	Method	Description
void	deleteBuildWarnings(@NotNull VcsRepositoryData repository, @NotNull String changeSetId, @NotNull ImmutableChainResultsSummary resultsSummary)	Removes all warnings previously sent by Bamboo for the given repository used in a build.
@Nullable ContextualVcsId<VcsBuildWarningsUpdater>	getVcsIdForExecutor(@NotNull VcsRepositoryData repository)	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	sendBuildWarnings(@NotNull VcsRepositoryData repository, @NotNull String changesetId, @NotNull ImmutableChainResultsSummary resultsSummary, @NotNull BuildWarningSummary warningSummary, @NotNull Iterable<WarningAnnotation> warnings)	Sends build warnings for the given repository used in a build.
boolean	supportsBuildWarnings(@NotNull VcsRepositoryData repository)	Returns true if build warnings are supported by the given repository.

Methods inherited from class com.atlassian.bamboo.plugins.stash.v2.AbstractBitbucketServerExecutor

bitbucketServerToGitData, executeOnMirrorWithPrimaryFallback, executeOnMirrorWithPrimaryFallback, getGitModuleDescriptor, shouldFallbackToPolling

Methods inherited from class java.lang.Object

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

Constructor Detail

BitbucketServerBuildWarningsUpdater

public BitbucketServerBuildWarningsUpdater()

Method Detail

getVcsIdForExecutor

@Nullable
public @Nullable ContextualVcsId<VcsBuildWarningsUpdater> getVcsIdForExecutor(@NotNull
                                                                              @NotNull VcsRepositoryData repository)

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<VcsBuildWarningsUpdater>

Returns:

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

supportsBuildWarnings

public boolean supportsBuildWarnings(@NotNull
                                     @NotNull VcsRepositoryData repository)

Description copied from interface: VcsBuildWarningsUpdater

Returns true if build warnings are supported by the given repository.

Specified by:

supportsBuildWarnings in interface VcsBuildWarningsUpdater

sendBuildWarnings

public boolean sendBuildWarnings(@NotNull
                                 @NotNull VcsRepositoryData repository,
                                 @NotNull
                                 @NotNull String changesetId,
                                 @NotNull
                                 @NotNull ImmutableChainResultsSummary resultsSummary,
                                 @NotNull
                                 @NotNull BuildWarningSummary warningSummary,
                                 @NotNull
                                 @NotNull Iterable<WarningAnnotation> warnings)
                          throws RepositoryException

Description copied from interface: VcsBuildWarningsUpdater

Sends build warnings for the given repository used in a build.

This method can be called multiple times to send warnings incrementally, to allow external data batching.

Specified by:

sendBuildWarnings in interface VcsBuildWarningsUpdater

Parameters:

repository - repository for which to send code warnings

changesetId - commit identifier

resultsSummary - summary of the build result which generated the warnings

warningSummary - summary of the warnings

warnings - batch of warnings to send

Returns:

true if annotations have been successfully sent, false otherwise. When false is returned, no further calls to this method should be performed for the same repository and result.

Throws:

RepositoryException - if for any reason the build warnings could not have been sent.

deleteBuildWarnings

public void deleteBuildWarnings(@NotNull
                                @NotNull VcsRepositoryData repository,
                                @NotNull
                                @NotNull String changeSetId,
                                @NotNull
                                @NotNull ImmutableChainResultsSummary resultsSummary)
                         throws RepositoryException

Description copied from interface: VcsBuildWarningsUpdater

Removes all warnings previously sent by Bamboo for the given repository used in a build.

Specified by:

deleteBuildWarnings in interface VcsBuildWarningsUpdater

Parameters:

repository - repository for which to delete code warnings

changeSetId - commit identifier

resultsSummary - summary of the build result which generated the warnings

Throws:

RepositoryException - if for any reason the build warnings could not have been deleted.