Package org.apache.maven.plugin

Interface PluginArtifactsCache

All Known Implementing Classes:

DefaultPluginArtifactsCache

public interface PluginArtifactsCache

Caches plugin artifacts. Warning: This is an internal utility interface that is only public for technical reasons, it is not part of the public API. In particular, this interface can be changed or deleted without prior notice.

Author:

Igor Fedorenko, Benjamin Bentmann

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PluginArtifactsCache.CacheRecord	CacheRecord
static interface	PluginArtifactsCache.Key	A cache key.

Method Summary

Modifier and Type	Method	Description
PluginArtifactsCache.Key	createKey(org.apache.maven.model.Plugin plugin, org.eclipse.aether.graph.DependencyFilter extensionFilter, java.util.List<org.eclipse.aether.repository.RemoteRepository> repositories, org.eclipse.aether.RepositorySystemSession session)
void	flush()
PluginArtifactsCache.CacheRecord	get(PluginArtifactsCache.Key key)
PluginArtifactsCache.CacheRecord	put(PluginArtifactsCache.Key key, java.util.List<org.apache.maven.artifact.Artifact> pluginArtifacts)
PluginArtifactsCache.CacheRecord	put(PluginArtifactsCache.Key key, PluginResolutionException e)
void	register(MavenProject project, PluginArtifactsCache.Key cacheKey, PluginArtifactsCache.CacheRecord rcrd)	Registers the specified cache record for usage with the given project.

Method Detail

createKey

PluginArtifactsCache.Key createKey(org.apache.maven.model.Plugin plugin,
                                   org.eclipse.aether.graph.DependencyFilter extensionFilter,
                                   java.util.List<org.eclipse.aether.repository.RemoteRepository> repositories,
                                   org.eclipse.aether.RepositorySystemSession session)

get

PluginArtifactsCache.CacheRecord get(PluginArtifactsCache.Key key)
                              throws PluginResolutionException

Throws:

PluginResolutionException

put

PluginArtifactsCache.CacheRecord put(PluginArtifactsCache.Key key,
                                     java.util.List<org.apache.maven.artifact.Artifact> pluginArtifacts)

put

PluginArtifactsCache.CacheRecord put(PluginArtifactsCache.Key key,
                                     PluginResolutionException e)

flush

void flush()

register

void register(MavenProject project,
              PluginArtifactsCache.Key cacheKey,
              PluginArtifactsCache.CacheRecord rcrd)

Registers the specified cache record for usage with the given project. Integrators can use the information collected from this method in combination with a custom cache implementation to dispose unused records from the cache.

Parameters:

project - The project that employs the plugin realm, must not be null.

rcrd - The cache record being used for the project, must not be null.