Package org.apache.maven.plugin.internal
Class DefaultMavenPluginManager
java.lang.Object
org.apache.maven.plugin.internal.DefaultMavenPluginManager
- All Implemented Interfaces:
MavenPluginManager
@Named
@Singleton
public class DefaultMavenPluginManager
extends Object
implements MavenPluginManager
Provides basic services to manage Maven plugins and their mojos. This component is kept general in its design such
that the plugins/mojos can be used in arbitrary contexts. In particular, the mojos can be used for ordinary build
plugins as well as special purpose plugins like reports.
- Since:
- 3.0
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
PluginId => ExtensionRealmCache.CacheRecord map MavenProject context value key. -
Constructor Summary
ConstructorDescriptionDefaultMavenPluginManager
(org.codehaus.plexus.PlexusContainer container, ClassRealmManager classRealmManager, PluginDescriptorCache pluginDescriptorCache, PluginRealmCache pluginRealmCache, PluginDependenciesResolver pluginDependenciesResolver, ExtensionRealmCache extensionRealmCache, PluginVersionResolver pluginVersionResolver, PluginArtifactsCache pluginArtifactsCache, MavenPluginValidator pluginValidator, List<MavenPluginConfigurationValidator> configurationValidators, PluginValidationManager pluginValidationManager, List<MavenPluginPrerequisitesChecker> prerequisitesCheckers) -
Method Summary
Modifier and TypeMethodDescriptionvoid
checkPrerequisites
(PluginDescriptor pluginDescriptor) Verifies that the specified plugin's prerequisites are met.void
checkRequiredMavenVersion
(PluginDescriptor pluginDescriptor) Deprecated.<T> T
getConfiguredMojo
(Class<T> mojoInterface, MavenSession session, MojoExecution mojoExecution) Looks up the mojo for the specified mojo execution and populates its parameters from the configuration given by the mojo execution.getMojoDescriptor
(Plugin plugin, String goal, List<org.eclipse.aether.repository.RemoteRepository> repositories, org.eclipse.aether.RepositorySystemSession session) Retrieves the descriptor for the specified plugin goal from the plugin's main artifact.getPluginDescriptor
(Plugin plugin, List<org.eclipse.aether.repository.RemoteRepository> repositories, org.eclipse.aether.RepositorySystemSession session) Retrieves the descriptor for the specified plugin from its main artifact.void
releaseMojo
(Object mojo, MojoExecution mojoExecution) Releases the specified mojo back to the container.setupExtensionsRealm
(MavenProject project, Plugin plugin, org.eclipse.aether.RepositorySystemSession session) Sets up class realm for the specified build extensions plugin.void
setupPluginRealm
(PluginDescriptor pluginDescriptor, MavenSession session, ClassLoader parent, List<String> imports, org.eclipse.aether.graph.DependencyFilter filter) Sets up the class realm for the specified plugin.
-
Field Details
-
KEY_EXTENSIONS_REALMS
PluginId => ExtensionRealmCache.CacheRecord map MavenProject context value key. The map is used to ensure the same class realm is used to load build extensions and load mojos for extensions=true plugins.
Note: This is part of internal implementation and may be changed or removed without notice- Since:
- 3.3.0
-
-
Constructor Details
-
DefaultMavenPluginManager
@Inject public DefaultMavenPluginManager(org.codehaus.plexus.PlexusContainer container, ClassRealmManager classRealmManager, PluginDescriptorCache pluginDescriptorCache, PluginRealmCache pluginRealmCache, PluginDependenciesResolver pluginDependenciesResolver, ExtensionRealmCache extensionRealmCache, PluginVersionResolver pluginVersionResolver, PluginArtifactsCache pluginArtifactsCache, MavenPluginValidator pluginValidator, List<MavenPluginConfigurationValidator> configurationValidators, PluginValidationManager pluginValidationManager, List<MavenPluginPrerequisitesChecker> prerequisitesCheckers)
-
-
Method Details
-
getPluginDescriptor
public PluginDescriptor getPluginDescriptor(Plugin plugin, List<org.eclipse.aether.repository.RemoteRepository> repositories, org.eclipse.aether.RepositorySystemSession session) throws PluginResolutionException, PluginDescriptorParsingException, InvalidPluginDescriptorException Description copied from interface:MavenPluginManager
Retrieves the descriptor for the specified plugin from its main artifact.- Specified by:
getPluginDescriptor
in interfaceMavenPluginManager
- Parameters:
plugin
- The plugin whose descriptor should be retrieved, must not benull
.repositories
- The plugin repositories to use for resolving the plugin's main artifact, must not benull
.session
- The repository session to use for resolving the plugin's main artifact, must not benull
.- Returns:
- The plugin descriptor, never
null
. - Throws:
PluginResolutionException
PluginDescriptorParsingException
InvalidPluginDescriptorException
-
getMojoDescriptor
public MojoDescriptor getMojoDescriptor(Plugin plugin, String goal, List<org.eclipse.aether.repository.RemoteRepository> repositories, org.eclipse.aether.RepositorySystemSession session) throws MojoNotFoundException, PluginResolutionException, PluginDescriptorParsingException, InvalidPluginDescriptorException Description copied from interface:MavenPluginManager
Retrieves the descriptor for the specified plugin goal from the plugin's main artifact.- Specified by:
getMojoDescriptor
in interfaceMavenPluginManager
- Parameters:
plugin
- The plugin whose mojo descriptor should be retrieved, must not benull
.goal
- The simple name of the mojo whose descriptor should be retrieved, must not benull
.repositories
- The plugin repositories to use for resolving the plugin's main artifact, must not benull
.session
- The repository session to use for resolving the plugin's main artifact, must not benull
.- Returns:
- The mojo descriptor, never
null
. - Throws:
MojoNotFoundException
PluginResolutionException
PluginDescriptorParsingException
InvalidPluginDescriptorException
-
checkPrerequisites
public void checkPrerequisites(PluginDescriptor pluginDescriptor) throws PluginIncompatibleException Description copied from interface:MavenPluginManager
Verifies that the specified plugin's prerequisites are met.- Specified by:
checkPrerequisites
in interfaceMavenPluginManager
- Parameters:
pluginDescriptor
- The descriptor of the plugin to check, must not benull
.- Throws:
PluginIncompatibleException
-
checkRequiredMavenVersion
@Deprecated public void checkRequiredMavenVersion(PluginDescriptor pluginDescriptor) throws PluginIncompatibleException Deprecated.Description copied from interface:MavenPluginManager
Verifies the specified plugin is compatible with the current Maven runtime.- Specified by:
checkRequiredMavenVersion
in interfaceMavenPluginManager
- Parameters:
pluginDescriptor
- The descriptor of the plugin to check, must not benull
.- Throws:
PluginIncompatibleException
-
setupPluginRealm
public void setupPluginRealm(PluginDescriptor pluginDescriptor, MavenSession session, ClassLoader parent, List<String> imports, org.eclipse.aether.graph.DependencyFilter filter) throws PluginResolutionException, PluginContainerException Description copied from interface:MavenPluginManager
Sets up the class realm for the specified plugin. Both the class realm and the plugin artifacts that constitute it will be stored in the plugin descriptor.- Specified by:
setupPluginRealm
in interfaceMavenPluginManager
- Parameters:
pluginDescriptor
- The plugin descriptor in which to save the class realm and the plugin artifacts, must not benull
.session
- The build session from which to pick the current project and repository settings, must not benull
.parent
- The parent class realm for the plugin, may benull
to use the Maven core realm.imports
- The packages/types to import from the parent realm, may benull
.filter
- The filter used to exclude certain plugin dependencies, may benull
.- Throws:
PluginResolutionException
PluginContainerException
-
getConfiguredMojo
public <T> T getConfiguredMojo(Class<T> mojoInterface, MavenSession session, MojoExecution mojoExecution) throws PluginConfigurationException, PluginContainerException Description copied from interface:MavenPluginManager
Looks up the mojo for the specified mojo execution and populates its parameters from the configuration given by the mojo execution. The mojo/plugin descriptor associated with the mojo execution provides the class realm to look up the mojo from. Warning: The returned mojo instance must be released viaMavenPluginManager.releaseMojo(Object, MojoExecution)
when the mojo is no longer needed to free any resources allocated for it.- Specified by:
getConfiguredMojo
in interfaceMavenPluginManager
- Parameters:
mojoInterface
- The component role of the mojo, must not benull
.session
- The build session in whose context the mojo will be used, must not benull
.mojoExecution
- The mojo execution to retrieve the mojo for, must not benull
.- Returns:
- The ready-to-execute mojo, never
null
. - Throws:
PluginConfigurationException
PluginContainerException
-
releaseMojo
Description copied from interface:MavenPluginManager
Releases the specified mojo back to the container.- Specified by:
releaseMojo
in interfaceMavenPluginManager
- Parameters:
mojo
- The mojo to release, may benull
.mojoExecution
- The mojo execution the mojo was originally retrieved for, must not benull
.
-
setupExtensionsRealm
public ExtensionRealmCache.CacheRecord setupExtensionsRealm(MavenProject project, Plugin plugin, org.eclipse.aether.RepositorySystemSession session) throws PluginManagerException Description copied from interface:MavenPluginManager
Sets up class realm for the specified build extensions plugin.- Specified by:
setupExtensionsRealm
in interfaceMavenPluginManager
- Throws:
PluginManagerException
-