org.apache.maven.plugin

Interface PluginRealmCache

All Known Implementing Classes:

DefaultPluginRealmCache

public interface PluginRealmCache

Caches plugin class realms. 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 and Description
static class	PluginRealmCache.CacheRecord CacheRecord
static interface	PluginRealmCache.Key A cache key.

Method Summary

Modifier and Type	Method and Description
PluginRealmCache.Key	createKey(Plugin plugin, ClassLoader parentRealm, Map<String,ClassLoader> foreignImports, DependencyFilter dependencyFilter, List<RemoteRepository> repositories, RepositorySystemSession session)
void	flush()
PluginRealmCache.CacheRecord	get(PluginRealmCache.Key key)
PluginRealmCache.CacheRecord	put(PluginRealmCache.Key key, ClassRealm pluginRealm, List<Artifact> pluginArtifacts)
void	register(MavenProject project, PluginRealmCache.Key key, PluginRealmCache.CacheRecord record) Registers the specified cache record for usage with the given project.

Method Detail

createKey

PluginRealmCache.Key createKey(Plugin plugin,
                               ClassLoader parentRealm,
                               Map<String,ClassLoader> foreignImports,
                               DependencyFilter dependencyFilter,
                               List<RemoteRepository> repositories,
                               RepositorySystemSession session)

get

PluginRealmCache.CacheRecord get(PluginRealmCache.Key key)

put

PluginRealmCache.CacheRecord put(PluginRealmCache.Key key,
                                 ClassRealm pluginRealm,
                                 List<Artifact> pluginArtifacts)

flush

void flush()

register

void register(MavenProject project,
              PluginRealmCache.Key key,
              PluginRealmCache.CacheRecord record)

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.

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