com.github.blindpirate.gogradle.core.cache

Interface GlobalCacheManager

All Known Implementing Classes:

DefaultGlobalCacheManager

public interface GlobalCacheManager

Manages global cache which users should never know. Typically, global cache exists in ~/.gradle/go with following structure:
+ ~/.gradle/go
|
|-- gopath stores global go repository cache, e.g., golang.org/x/tools.
|
|-- binary stores go distributions.
|
\-- metadata stores metadata of global go repository cache, e.g. repo url and last update time. The metadata also acts as a lock in synchronization of multiple JVM process.

Method Summary

Modifier and Type	Method and Description
boolean	currentRepositoryIsUpToDate(NotationDependency dependency) Check if the repository corresponding to a dependency package has been updated recently in global cache.
void	ensureGlobalCacheExistAndWritable() Ensures global cache exists and is writable.
java.nio.file.Path	getGlobalGoBinCache(java.lang.String relativePath) Get the path which locates in relativePath relative to ~/.gradle/go/binary
java.nio.file.Path	getGlobalPackageCachePath(java.lang.String packagePath) Get the go repository in global cache corresponding to packagePath
java.util.Optional<GlobalCacheMetadata>	getMetadata(java.nio.file.Path packagePath) Get the metadata of a package specified by packagePath
<T> T	runWithGlobalCacheLock(GolangDependency dependency, java.util.concurrent.Callable<T> callable) Locks global cache directory of dependency, and call the callable
void	updateCurrentDependencyLock(GolangDependency dependency) Updates corresponding metadata (i.e.

Method Detail

ensureGlobalCacheExistAndWritable

void ensureGlobalCacheExistAndWritable()

Ensures global cache exists and is writable.

getGlobalPackageCachePath

java.nio.file.Path getGlobalPackageCachePath(java.lang.String packagePath)

Get the go repository in global cache corresponding to packagePath

Parameters:

packagePath - import path of the package

Returns:

the location of that repository in global cache

getGlobalGoBinCache

java.nio.file.Path getGlobalGoBinCache(java.lang.String relativePath)

Get the path which locates in relativePath relative to ~/.gradle/go/binary

Parameters:

relativePath - the relative path to ~/.gradle/go/binary

Returns:

the path

getMetadata

java.util.Optional<GlobalCacheMetadata> getMetadata(java.nio.file.Path packagePath)

Get the metadata of a package specified by packagePath

Parameters:

packagePath - import path of the package

Returns:

the metadata if that package exists in global cache, Optional.empty() otherwise.

runWithGlobalCacheLock

<T> T runWithGlobalCacheLock(GolangDependency dependency,
                             java.util.concurrent.Callable<T> callable)
                      throws java.lang.Exception

Locks global cache directory of dependency, and call the callable

Type Parameters:

T - return value type of callable

Parameters:

dependency - dependency to be locked

callable - code to be executed under lock

Returns:

the return value of callable

Throws:

java.lang.Exception - exception thrown by callable

updateCurrentDependencyLock

void updateCurrentDependencyLock(GolangDependency dependency)

Updates corresponding metadata (i.e. the lock) file of a dependency package.

Parameters:

dependency - the dependency package

currentRepositoryIsUpToDate

boolean currentRepositoryIsUpToDate(NotationDependency dependency)

Check if the repository corresponding to a dependency package has been updated recently in global cache.

Parameters:

dependency - the dependency package

Returns:

true if the package is up-to-date, false otherwise.

See Also:

GolangPluginSetting.getGlobalCacheSecond()