Package jetbrains.buildServer.agent.impl.cache

Class ArtifactsCacheCleanersProvider

java.lang.Object

jetbrains.buildServer.agent.impl.cache.ArtifactsCacheCleanersProvider

All Implemented Interfaces:

AgentDiskSpaceCleanerExtension, AgentExtension, DirectoryCleanersProvider, TeamCityExtension

public class ArtifactsCacheCleanersProvider
extends Object
implements DirectoryCleanersProvider, AgentDiskSpaceCleanerExtension

Constructor Summary

Constructors

Constructor	Description
ArtifactsCacheCleanersProvider(ArtifactCacheProvider provider, AgentIdleTasks agentIdleTasks)

Method Summary

Modifier and Type	Method	Description
void	cleanup(CleanupParameters cleanupParameters)	called when system needs free disk space.
List<File>	getCleanedRoots()	Returns list of directories where plugin stores cache-files.
String	getCleanerName()
void	registerDirectoryCleaners(DirectoryCleanersProviderContext context, DirectoryCleanersRegistry registry)	On every free space clean system collects cleanable items from all registered extensions of this class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArtifactsCacheCleanersProvider

public ArtifactsCacheCleanersProvider(@NotNull
                                      ArtifactCacheProvider provider,
                                      @NotNull
                                      AgentIdleTasks agentIdleTasks)

Method Detail

getCleanedRoots

@NotNull
public List<File> getCleanedRoots()

Description copied from interface: AgentDiskSpaceCleanerExtension

Returns list of directories where plugin stores cache-files. This method always is invoked before AgentDiskSpaceCleanerExtension.cleanup(CleanupParameters).

Specified by:

getCleanedRoots in interface AgentDiskSpaceCleanerExtension

Returns:

List of directories where plugin stores cache-files.

getCleanerName

@NotNull
public String getCleanerName()

Specified by:

getCleanerName in interface AgentDiskSpaceCleanerExtension

Specified by:

getCleanerName in interface DirectoryCleanersProvider

Returns:

cleaner name to be shown in agent and build logs, e.g. 'swabra snapshots cleaner'

registerDirectoryCleaners

public void registerDirectoryCleaners(@NotNull
                                      DirectoryCleanersProviderContext context,
                                      @NotNull
                                      DirectoryCleanersRegistry registry)

Description copied from interface: DirectoryCleanersProvider

On every free space clean system collects cleanable items from all registered extensions of this class. Items are removed till required free space is achieved. System will remove items from rare-used to newer till free space requirement is achieved.

Specified by:

registerDirectoryCleaners in interface DirectoryCleanersProvider

Parameters:

context - call context

registry - cleanup items registry to register cleanable items

cleanup

public void cleanup(@NotNull
                    CleanupParameters cleanupParameters)

Description copied from interface: AgentDiskSpaceCleanerExtension

called when system needs free disk space. This method can be invoked repeatedly with different CleanupParameters. CleanupParameters.getFilesToCleanup() contains some directories which was returned by AgentDiskSpaceCleanerExtension.getCleanedRoots() method. Plugin must remove files and directories specified by CleanupParameters.getFilesToCleanup() if file was not used in specified time frame, see CleanupParameters.getTTL().

Specified by:

cleanup in interface AgentDiskSpaceCleanerExtension

Parameters:

cleanupParameters - CleanupParameters for current cleanup procedure