Package jetbrains.buildServer.agent.impl.cache

Class BuildCacheManagerImpl

java.lang.Object

jetbrains.buildServer.agent.impl.cache.BuildCacheManagerImpl

All Implemented Interfaces:

BuildCacheManager

public class BuildCacheManagerImpl
extends Object
implements BuildCacheManager

Constructor Summary

Constructors

Constructor	Description
BuildCacheManagerImpl(BuildAgentConfiguration config, DependencyResolver dependencyResolver, DependencyHttpHelper dependencyHttpHelper, BuildCacheHolder buildCacheHolder, ArtifactDependencyBuildCacheMapper buildCacheMapper, AgentRunningBuildEx build, BuildProgressLogger buildLogger)

Method Summary

Modifier and Type	Method	Description
void	addCachePathForPublishingToRegisteredCache(String cacheName, String cachePath)	Adds a single cache path to be published in a specific build cache.
void	addCachePathForPublishingToRegisteredCache(String cacheName, String cachePath, Collection<String> exclusionRules, Collection<String> inclusionRules)	Adds a single cache path to be published in a specific build cache considering the rules for excluding/including specific directories or files under this cache path.
void	addCachePathsForPublishing(String cacheName, boolean isPublishOnlyChanged, boolean isCalculateFilesChecksum, List<String> cachePaths)	Registers the cache for publishing (overriding isPublishOnlyChanged and isCalculateFilesChecksum if it has been registered already) and adds cache path for publishing to it.
void	addCachePathsForPublishingToRegisteredCache(String cacheName, List<String> cachePaths)	Adds cache paths to be published in a specific build cache.
boolean	isCacheRegisteredForPublishing(String cacheName)	Checks if a cache was registered for publishing via BuildCacheManager.registerCacheForPublishing(String, boolean, boolean).
void	registerCacheForPublishing(String cacheName, boolean isPublishOnlyChanged, boolean isCalculateFilesChecksum)	Registers the specific cache name for publishing at the end of the build.
boolean	restoreCache(String cacheName)	Restores the contents (cached paths) and the metadata of a cache for the specified cacheName.
boolean	restoreCacheMetadataOnly(String cacheName)	Restores the metadata of a cache without restoring the cache contents for the specified cacheName.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildCacheManagerImpl

public BuildCacheManagerImpl(@NotNull
                             BuildAgentConfiguration config,
                             @NotNull
                             DependencyResolver dependencyResolver,
                             @NotNull
                             DependencyHttpHelper dependencyHttpHelper,
                             @NotNull
                             BuildCacheHolder buildCacheHolder,
                             @NotNull
                             ArtifactDependencyBuildCacheMapper buildCacheMapper,
                             @NotNull
                             AgentRunningBuildEx build,
                             @NotNull
                             BuildProgressLogger buildLogger)

Method Detail

restoreCache

public boolean restoreCache(@NotNull
                            String cacheName)

Description copied from interface: BuildCacheManager

Restores the contents (cached paths) and the metadata of a cache for the specified cacheName.

Specified by:

restoreCache in interface BuildCacheManager

Parameters:

cacheName - the name of the cache to restore

Returns:

true if the cache was restored successfully

restoreCacheMetadataOnly

public boolean restoreCacheMetadataOnly(@NotNull
                                        String cacheName)

Description copied from interface: BuildCacheManager

Restores the metadata of a cache without restoring the cache contents for the specified cacheName. This method should be called when only the metadata of the cache is needed, for example, for cache contents comparison when the cache will be published via BuildCacheManager.registerCacheForPublishing(String, boolean, boolean) with isPublishOnlyChanged set to true.

Specified by:

restoreCacheMetadataOnly in interface BuildCacheManager

Parameters:

cacheName - the name of the cache to restore the metadata for

Returns:

true if the cache metadata was restored successfully

registerCacheForPublishing

public void registerCacheForPublishing(@NotNull
                                       String cacheName,
                                       boolean isPublishOnlyChanged,
                                       boolean isCalculateFilesChecksum)

Description copied from interface: BuildCacheManager

Registers the specific cache name for publishing at the end of the build. The actual publishing happens after all build steps of the build have finished. If isPublishOnlyChanged is set to true, the metadata of the current cache should be restored in advance by calling BuildCacheManager.restoreCache(String) or BuildCacheManager.restoreCacheMetadataOnly(String) (othewise it is impossible to detect changes).

Specified by:

registerCacheForPublishing in interface BuildCacheManager

Parameters:

cacheName - the name of the cache to publish

isPublishOnlyChanged - when set to true the cache will be published only if its contents changed; cache metadata should be available in this case

isCalculateFilesChecksum - indicates whether to calculate the checksum of cache contents

isCacheRegisteredForPublishing

public boolean isCacheRegisteredForPublishing(@NotNull
                                              String cacheName)

Description copied from interface: BuildCacheManager

Checks if a cache was registered for publishing via BuildCacheManager.registerCacheForPublishing(String, boolean, boolean).

Specified by:

isCacheRegisteredForPublishing in interface BuildCacheManager

Parameters:

cacheName - the name of the cache

Returns:

true if the cache is registered for publishing

addCachePathsForPublishingToRegisteredCache

public void addCachePathsForPublishingToRegisteredCache(@NotNull
                                                        String cacheName,
                                                        @NotNull
                                                        List<String> cachePaths)

Description copied from interface: BuildCacheManager

Adds cache paths to be published in a specific build cache. The build cache with this name should be registered for publishing via BuildCacheManager.registerCacheForPublishing(String, boolean, boolean) before calling this method.

Specified by:

addCachePathsForPublishingToRegisteredCache in interface BuildCacheManager

Parameters:

cacheName - the name of the build cache

cachePaths - the list of paths to include in the cache

addCachePathForPublishingToRegisteredCache

public void addCachePathForPublishingToRegisteredCache(@NotNull
                                                       String cacheName,
                                                       @NotNull
                                                       String cachePath)

Description copied from interface: BuildCacheManager

Adds a single cache path to be published in a specific build cache. The build cache with this name should be registered for publishing via BuildCacheManager.registerCacheForPublishing(String, boolean, boolean) before calling this method.

Specified by:

addCachePathForPublishingToRegisteredCache in interface BuildCacheManager

Parameters:

cacheName - the name of the build cache

cachePath - the path to include in the cache

addCachePathForPublishingToRegisteredCache

public void addCachePathForPublishingToRegisteredCache(@NotNull
                                                       String cacheName,
                                                       @NotNull
                                                       String cachePath,
                                                       @NotNull
                                                       Collection<String> exclusionRules,
                                                       @NotNull
                                                       Collection<String> inclusionRules)

Description copied from interface: BuildCacheManager

Adds a single cache path to be published in a specific build cache considering the rules for excluding/including specific directories or files under this cache path. The build cache with this name should be registered for publishing via BuildCacheManager.registerCacheForPublishing(String, boolean, boolean) before calling this method.

Specified by:

addCachePathForPublishingToRegisteredCache in interface BuildCacheManager

Parameters:

cacheName - the name of the build cache

cachePath - the path to include in the cache

exclusionRules - the list of exclusion rules

inclusionRules - the list of inclusion rules

addCachePathsForPublishing

public void addCachePathsForPublishing(@NotNull
                                       String cacheName,
                                       boolean isPublishOnlyChanged,
                                       boolean isCalculateFilesChecksum,
                                       @NotNull
                                       List<String> cachePaths)

Description copied from interface: BuildCacheManager

Registers the cache for publishing (overriding isPublishOnlyChanged and isCalculateFilesChecksum if it has been registered already) and adds cache path for publishing to it. Basically, works as BuildCacheManager.registerCacheForPublishing(String, boolean, boolean) and BuildCacheManager.addCachePathsForPublishingToRegisteredCache(String, List) combined.

Specified by:

addCachePathsForPublishing in interface BuildCacheManager

Parameters:

cacheName - the name of the cache to publish

isPublishOnlyChanged - when set to true the cache will be published only if its contents changed; cache metadata should be available in this case

isCalculateFilesChecksum - indicates whether to calculate the checksum of cache contents

cachePaths - the list of paths to include in the cache