com.atlassian.bamboo.plan.vcsRevision
Interface PlanVcsRevisionHistoryService

All Known Implementing Classes:

PlanVcsRevisionHistoryServiceImpl

public interface PlanVcsRevisionHistoryService

Provides access to vcs revision information of a Plan

Method Summary

void	cleanupUnusedEntriesForPlan(PlanKey planKey) Removes history entries that are not used in change detection process.
void	clearRevisionHistoryForPlan(PlanKey planKey) Removes all history entries for the plan.
java.lang.String	getLastVcsRevisionKey(PlanKey planKey) The string value representing the last vcs revision checked for relevant changes.
java.lang.String	getLastVcsRevisionKeyBeforeBuildNumber(PlanKey planKey, int buildNumber) Return the last revision checked for relevant changes before given build.
void	markBuildStarted(BuildContext buildContext) Saves the information on started build in the plan's vcs revision history.
void	markChangeDetectionCompleted(PlanKey planKey, int buildNumber, java.lang.String vcsRevisionKey) Saves the information on change detection result in the plan's vcs revision history.
void	revertVcsRevisionForResult(PlanResultKey planResultKey) Removes history entry corresponding to ResultsSummary identified by the key.

Method Detail

getLastVcsRevisionKey

@Nullable
java.lang.String getLastVcsRevisionKey(@NotNull
                                                PlanKey planKey)

The string value representing the last vcs revision checked for relevant changes. Will be null if nothing has been built. The value is parseable by the individual repositories.

Returns:

last revision key for which change detection has been performed

getLastVcsRevisionKeyBeforeBuildNumber

@Nullable
java.lang.String getLastVcsRevisionKeyBeforeBuildNumber(@NotNull
                                                                 PlanKey planKey,
                                                                 int buildNumber)

Return the last revision checked for relevant changes before given build. Can be null. The value is parseable by the individual repositories.

Returns:

last revision key checked before a buildNumber

markChangeDetectionCompleted

void markChangeDetectionCompleted(@NotNull
                                  PlanKey planKey,
                                  int buildNumber,
                                  @Nullable
                                  java.lang.String vcsRevisionKey)

Saves the information on change detection result in the plan's vcs revision history.

Parameters:

planKey -

buildNumber -

vcsRevisionKey -

markBuildStarted

void markBuildStarted(@NotNull
                      BuildContext buildContext)

Saves the information on started build in the plan's vcs revision history. Updates previousVcsRevisionKey in BuildContext

Parameters:

buildContext -

revertVcsRevisionForResult

void revertVcsRevisionForResult(@NotNull
                                PlanResultKey planResultKey)

Removes history entry corresponding to ResultsSummary identified by the key. This allows the change detection to trigger another build for the same changeset.

Parameters:

planResultKey -

clearRevisionHistoryForPlan

void clearRevisionHistoryForPlan(@NotNull
                                 PlanKey planKey)

Removes all history entries for the plan. In effect the next build will behave similar to initial build.

Parameters:

planKey -

cleanupUnusedEntriesForPlan

void cleanupUnusedEntriesForPlan(@NotNull
                                 PlanKey planKey)

Removes history entries that are not used in change detection process.

Parameters:

planKey -