Package com.atlassian.bamboo.plan.vcsRevision

Interface PlanVcsRevisionHistoryService

All Known Implementing Classes:

PlanVcsRevisionHistoryServiceImpl

@Internal
public interface PlanVcsRevisionHistoryService

Provides access to vcs revision information of a Plan

Method Summary

Modifier and Type	Method	Description
void	cleanupUnusedEntriesForPlan(@NotNull PlanKey planKey)	Removes history entries that are not used in change detection process.
void	clearRevisionHistoryForPlan(@NotNull PlanKey planKey)	Removes all history entries for the plan.
@NotNull PlanVcsRevisionDataSet	getLastVcsRevisionKeys(@NotNull PlanKey planKey)	Return the mapping between repository ids and strings representing the vcs revisions which were result of last performed change detection.
void	markBuildStarted(@NotNull BuildContext buildContext)	Saves the information on started build in the plan's vcs revision history.
void	markChangeDetectionCompleted(@NotNull PlanKey planKey, int buildNumber, @NotNull PlanVcsRevisionData revisionData, long repositoryId)	Saves the information on change detection result in the plan's vcs revision history.
void	moveRevisionHistoryForPlan(@NotNull PlanKey originalPlanKey, @NotNull PlanKey planKey)	Moves history entries that are related to a moved plan.

Method Detail

getLastVcsRevisionKeys

@NotNull
@NotNull PlanVcsRevisionDataSet getLastVcsRevisionKeys(@NotNull
                                                       @NotNull PlanKey planKey)

Return the mapping between repository ids and strings representing the vcs revisions which were result of last performed change detection. Will be empty if nothing has been built. The values are parseable by the individual repositories.

Returns:

mapping between repository id and corresponding revision key.

markChangeDetectionCompleted

void markChangeDetectionCompleted(@NotNull
                                  @NotNull PlanKey planKey,
                                  int buildNumber,
                                  @NotNull
                                  @NotNull PlanVcsRevisionData revisionData,
                                  long repositoryId)

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

Parameters:

planKey -

buildNumber -

markBuildStarted

void markBuildStarted(@NotNull
                      @NotNull BuildContext buildContext)

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

Parameters:

buildContext -

clearRevisionHistoryForPlan

void clearRevisionHistoryForPlan(@NotNull
                                 @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
                                 @NotNull PlanKey planKey)

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

Parameters:

planKey -

moveRevisionHistoryForPlan

void moveRevisionHistoryForPlan(@NotNull
                                @NotNull PlanKey originalPlanKey,
                                @NotNull
                                @NotNull PlanKey planKey)

Moves history entries that are related to a moved plan. Used when plan is moved/renamed.

Since:

5.6