jetbrains.buildServer.serverSide.cleanup

Interface CleanupExtension

All Superinterfaces:

ServerExtension, TeamCityExtension

All Known Implementing Classes:

CleanupExtensionAdapter

public interface CleanupExtension
extends ServerExtension

Instances of this cleanup extension are called during cleanup.

Since:

8.0

Method Summary

Modifier and Type	Method and Description
default void	afterCleanup(CleanupProcessState cleanupState) Invoked upon finishing of the main cleanup process.
default void	cleanupBuildsData(BuildCleanupContext cleanupContext) Invoked for each build which is to be cleaned up.

Method Detail

cleanupBuildsData

default void cleanupBuildsData(@NotNull
                               BuildCleanupContext cleanupContext)
                        throws java.lang.Exception

Invoked for each build which is to be cleaned up. At this point data this build_id may be partially deleted, but history entry and test info still exists. Note: DataCleaner is invoked when cleanup is proceeding and it should perform db operations in current thread otherwise deadlock will occur. Extension must check cleanup process state and if it is interrupted, complete it's operations and return as quick as possible.

Parameters:

cleanupContext - cleanup context

Throws:

java.lang.Exception - on any error

afterCleanup

default void afterCleanup(@NotNull
                          CleanupProcessState cleanupState)
                   throws java.lang.Exception

Invoked upon finishing of the main cleanup process. At this point all data for specific build_id's is deleted. Note: This extension might not be called for every cleanup run as cleanup process can be interrupted earlier. Extension must check cleanup process state and if it is interrupted, complete it's operations and return as quick as possible.

Parameters:

cleanupState - cleanup process state

Throws:

java.lang.Exception - on any error