com.atlassian.bamboo.plan.vcsRevision
Interface PlanVcsRevisionHistoryManager

All Known Implementing Classes:

PlanVcsRevisionHistoryManagerImpl

public interface PlanVcsRevisionHistoryManager

Method Summary

void	cleanupUnusedEntriesForPlan(PlanKey planKey) Removes history entries that are not used in change detection process.
void	clearRevisionHistoryForPlanNewTx(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	markBuildStartedNewTx(BuildContext buildContext) Saves the information on started build in the plan's vcs revision history.
void	markChangeDetectionCompletedNewTx(PlanKey planKey, int buildNumber, java.lang.String vcsRevisionKey) Saves the information on change detection result in the plan's vcs revision history.
void	revertVcsRevisionForResultNewTx(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

markBuildStartedNewTx

void markBuildStartedNewTx(@NotNull
                           BuildContext buildContext)

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

Parameters:

buildContext -

markChangeDetectionCompletedNewTx

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

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

Parameters:

planKey -

buildNumber -

vcsRevisionKey -

revertVcsRevisionForResultNewTx

void revertVcsRevisionForResultNewTx(@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. Enforces new transaction.

Parameters:

planResultKey -

clearRevisionHistoryForPlanNewTx

void clearRevisionHistoryForPlanNewTx(@NotNull
                                      PlanKey planKey)

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

Parameters:

planKey -

cleanupUnusedEntriesForPlan

void cleanupUnusedEntriesForPlan(@NotNull
                                 PlanKey planKey)

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

Parameters:

planKey -