Package jetbrains.buildServer.serverSide

Interface VcsSettingsTracker

All Superinterfaces:

LVcsSettingsTracker

All Known Implementing Classes:

VcsSettingsTrackerImpl

public interface VcsSettingsTracker
extends LVcsSettingsTracker

Associates VCS revision with VCS settings in a build type. VCS revision is updated only if VCS settings change. This service holds first revision detected by VCS for current VCS settings.

Method Summary

Modifier and Type	Method	Description
void	forgetSettingsRevisions(SBuildType buildType)	Forgets all VCS settings revisions stored for the specified build type
void	forgetSettingsRevisions(SBuildType buildType, SVcsRoot parentRoot)	Forgets VCS settings revisions for the specified build type and vcs root.
RepositoryVersion	getFirstRevision(SBuildType buildType, VcsRootInstanceEntry vcsRootEntry)	Returns the first detected revision for specified build configuration and root entry.
String	getFirstRevision(SBuildType buildType, VcsRootInstanceEntry entry, String vcsBranch)	Returns first revision detected in branch for the given buildType, VCS root entry and the vcs branch or null if no revision is found
Map<String,String>	getSettingsChangeRevisions(SBuildType buildType, VcsRootInstanceEntry entry)	Returns branch revisions detected after settings change
VcsModificationOrder	settingsChanged(SBuildType buildType, VcsRootInstanceEntry vcsRootEntry, String revision)	Compares specified revision and revision of the first checking for changes made with the specified build configuration and VCS root instance.

Methods inherited from interface jetbrains.buildServer.serverSide.LVcsSettingsTracker

forgetSettings, updateRevisions

Method Detail

getFirstRevision

@Nullable
RepositoryVersion getFirstRevision(@NotNull
                                   SBuildType buildType,
                                   @NotNull
                                   VcsRootInstanceEntry vcsRootEntry)

Returns the first detected revision for specified build configuration and root entry. For DAG based VCS roots getFirstRevision(SBuildType, VcsRootInstanceEntry, String) should be used, however since we did not always store first/settings revisions per branch, this one can still be used as a fallback.

Parameters:

buildType -

vcsRootEntry -

Returns:

forgetSettingsRevisions

void forgetSettingsRevisions(@NotNull
                             SBuildType buildType,
                             @NotNull
                             SVcsRoot parentRoot)

Forgets VCS settings revisions for the specified build type and vcs root.

Parameters:

buildType - build type

vcsRoot - vcs root

forgetSettingsRevisions

void forgetSettingsRevisions(@NotNull
                             SBuildType buildType)

Forgets all VCS settings revisions stored for the specified build type

Parameters:

buildType - build type

settingsChanged

@NotNull
VcsModificationOrder settingsChanged(@NotNull
                                     SBuildType buildType,
                                     @NotNull
                                     VcsRootInstanceEntry vcsRootEntry,
                                     @NotNull
                                     String revision)

Compares specified revision and revision of the first checking for changes made with the specified build configuration and VCS root instance. This method works for linear VCS roots only. For DAG based VCS roots the result is always VcsModificationOrder.UNKNOWN.

• If revision of the first checking for changes was made before the specified revision returns VcsModificationOrder.BEFORE.
• If revision of the first checking for changes was made after the specified revision, returns VcsModificationOrder.AFTER.
• If for some reason revisions cannot be compared returns VcsModificationOrder.UNKNOWN.

Parameters:

buildType - build type

vcsRoot - vcs root

revision - revision to compare

Returns:

see above

getFirstRevision

@Nullable
String getFirstRevision(@NotNull
                        SBuildType buildType,
                        @NotNull
                        VcsRootInstanceEntry entry,
                        @NotNull
                        String vcsBranch)

Returns first revision detected in branch for the given buildType, VCS root entry and the vcs branch or null if no revision is found

Parameters:

buildType - buildType of interest

entry - root entry of interest

vcsBranch - vcs branch name

Returns:

see above

getSettingsChangeRevisions

@NotNull
Map<String,String> getSettingsChangeRevisions(@NotNull
                                                    SBuildType buildType,
                                                    @NotNull
                                                    VcsRootInstanceEntry entry)

Returns branch revisions detected after settings change