Package jetbrains.buildServer.serverSide

Interface LVcsStatusLogger

All Known Subinterfaces:

VcsStatusLogger, VcsStatusProvider

All Known Implementing Classes:

VcsStatusLoggerImpl, VcsStatusProviderImpl

public interface LVcsStatusLogger

Created 26.08.13 16:39

Author:

Eugene Petrenko (eugene.petrenko@jetbrains.com)

Method Summary

Modifier and Type	Method	Description
void	connectionFailed(Collection<LVcsRootInstanceHolder> buildTypes, VcsRoot root, Throwable problem)	Notifies that connection is failed for specified VCS root and a number of build configurations.
void	connectionFailed(LVcsRootInstanceHolder buildType, VcsRoot root, Throwable problem)	Notifies that connection is failed for specified VCS root and build configuration.
void	connectionSuccessful(LVcsRootInstanceHolder buildType, VcsRoot root)	Clears last failure for specified VCS root and build configuration.
void	currentStateFailedForVcsRoot(VcsRoot vcsRoot, Throwable throwable)	Should be called if attempt to get current state for the specified VCS root failed.
void	currentStateSuccessfulForVcsRoot(VcsRoot vcsRoot)	Should be called if attempt to get current state for the specified VCS root was successful.
VcsConnectionStatus	getConnectionStatus(LVcsRootInstanceHolder buildType, VcsRoot root)	Returns last connection status for specified build configuration and VCS root
boolean	isVcsRootHasGoodStatus(VcsRoot root)	Check if VCS root has good status in every configuration it attached to
boolean	isVcsRootHasGoodStatus(VcsRoot root, Set<String> buildTypeIntIds)	Checks if the given VCS root has a good status in the build configurations with the internal id from the specified set.

Method Detail

connectionFailed

void connectionFailed(@NotNull
                      LVcsRootInstanceHolder buildType,
                      @NotNull
                      VcsRoot root,
                      @NotNull
                      Throwable problem)

Notifies that connection is failed for specified VCS root and build configuration.

Parameters:

buildType - build configuration for which to store connection status. If build configuration is null, then error is stored for all build configurations where this root is used.

root - VCS root for which to store connection status

problem - error

Since:

6.5

connectionFailed

void connectionFailed(@NotNull
                      Collection<LVcsRootInstanceHolder> buildTypes,
                      @NotNull
                      VcsRoot root,
                      @NotNull
                      Throwable problem)

Notifies that connection is failed for specified VCS root and a number of build configurations.

Parameters:

buildTypes - build configurations for which to update the connection status.

root - VCS root for which to update connection status

problem - error

Since:

2021.2

connectionSuccessful

void connectionSuccessful(@NotNull
                          LVcsRootInstanceHolder buildType,
                          @NotNull
                          VcsRoot root)

Clears last failure for specified VCS root and build configuration.

Parameters:

buildType - build configuration to clear error for. If build configuration is null, then error is cleared for all build configurations where this root is used.

root - VCS root

Since:

6.5

getConnectionStatus

@NotNull
VcsConnectionStatus getConnectionStatus(@NotNull
                                        LVcsRootInstanceHolder buildType,
                                        @NotNull
                                        VcsRoot root)

Returns last connection status for specified build configuration and VCS root

Parameters:

buildType - build configuration

root - VCS root

Returns:

VCS connection status

Since:

6.5

isVcsRootHasGoodStatus

boolean isVcsRootHasGoodStatus(@NotNull
                               VcsRoot root)

Check if VCS root has good status in every configuration it attached to

Parameters:

root - VCS root of interest

Returns:

see above

Since:

7.0

isVcsRootHasGoodStatus

boolean isVcsRootHasGoodStatus(@NotNull
                               VcsRoot root,
                               @NotNull
                               Set<String> buildTypeIntIds)

Checks if the given VCS root has a good status in the build configurations with the internal id from the specified set. If there is no information about a status in some configuration it is assumed that status is good

Parameters:

root - VCS root of interest

buildTypeIntIds - ids of buildTypes where status should be checked

Returns:

see above

Since:

10.0

currentStateFailedForVcsRoot

void currentStateFailedForVcsRoot(@NotNull
                                  VcsRoot vcsRoot,
                                  @NotNull
                                  Throwable throwable)

Should be called if attempt to get current state for the specified VCS root failed.

Parameters:

vcsRoot - VCS root

throwable - if exception occurs

Since:

2018.2.3

currentStateSuccessfulForVcsRoot

void currentStateSuccessfulForVcsRoot(@NotNull
                                      VcsRoot vcsRoot)

Should be called if attempt to get current state for the specified VCS root was successful.

Parameters:

vcsRoot - VCS root

Since:

2018.2.3