DefaultMavenPluginManager (Maven Core 3.5.0-alpha-1 API)

java.lang.Object
- org.apache.maven.plugin.internal.DefaultMavenPluginManager

All Implemented Interfaces:

MavenPluginManager
```
@Component(role=MavenPluginManager.class)
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

Author:

Benjamin Bentmann

Field Summary

Fields
Modifier and Type Field and Description

static String KEY_EXTENSIONS_REALMS
PluginId=>ExtensionRealmCache.CacheRecord map MavenProject context value key.

Fields
Modifier and Type	Field and Description
`static String`	`KEY_EXTENSIONS_REALMS` PluginId=>ExtensionRealmCache.CacheRecord map MavenProject context value key.

Constructor Summary

Constructors
Constructor and Description

DefaultMavenPluginManager()

Constructors
Constructor and Description
`DefaultMavenPluginManager()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkRequiredMavenVersion(PluginDescriptor pluginDescriptor)` Verifies the specified plugin is compatible with the current Maven runtime.
`<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.
`MojoDescriptor`	`getMojoDescriptor(Plugin plugin, String goal, List<RemoteRepository> repositories, RepositorySystemSession session)` Retrieves the descriptor for the specified plugin goal from the plugin's main artifact.
`PluginDescriptor`	`getPluginDescriptor(Plugin plugin, List<RemoteRepository> repositories, 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.
`ExtensionRealmCache.CacheRecord`	`setupExtensionsRealm(MavenProject project, Plugin plugin, RepositorySystemSession session)` Sets up class realm for the specified build extensions plugin.
`void`	`setupPluginRealm(PluginDescriptor pluginDescriptor, MavenSession session, ClassLoader parent, List<String> imports, DependencyFilter filter)` Sets up the class realm for the specified plugin.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_EXTENSIONS_REALMS
```
public static final String 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.
    
    Since:
    
    3.3.0
    
    Provisional:
    
    This is part of internal implementation and may be changed or removed without notice
- Constructor Detail
  - DefaultMavenPluginManager
```
public DefaultMavenPluginManager()
```
- Method Detail
  - getPluginDescriptor
```
public PluginDescriptor getPluginDescriptor(Plugin plugin,
                                   List<RemoteRepository> repositories,
                                   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 interface MavenPluginManager
    
    Parameters:
    plugin - The plugin whose descriptor should be retrieved, must not be null.
    repositories - The plugin repositories to use for resolving the plugin's main artifact, must not be null.
    session - The repository session to use for resolving the plugin's main artifact, must not be null.
    
    Returns:
    The plugin descriptor, never null.
    
    Throws:
    
    PluginResolutionException
    
    PluginDescriptorParsingException
    
    InvalidPluginDescriptorException
  - getMojoDescriptor
```
public MojoDescriptor getMojoDescriptor(Plugin plugin,
                               String goal,
                               List<RemoteRepository> repositories,
                               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 interface MavenPluginManager
    
    Parameters:
    plugin - The plugin whose mojo descriptor should be retrieved, must not be null.
    goal - The simple name of the mojo whose descriptor should be retrieved, must not be null.
    repositories - The plugin repositories to use for resolving the plugin's main artifact, must not be null.
    session - The repository session to use for resolving the plugin's main artifact, must not be null.
    
    Returns:
    The mojo descriptor, never null.
    
    Throws:
    
    MojoNotFoundException
    
    PluginResolutionException
    
    PluginDescriptorParsingException
    
    InvalidPluginDescriptorException
  - checkRequiredMavenVersion
```
public void checkRequiredMavenVersion(PluginDescriptor pluginDescriptor)
                               throws PluginIncompatibleException
```
    Description copied from interface: MavenPluginManager
    
    Verifies the specified plugin is compatible with the current Maven runtime.
    
    Specified by:
    
    checkRequiredMavenVersion in interface MavenPluginManager
    
    Parameters:
    pluginDescriptor - The descriptor of the plugin to check, must not be null.
    
    Throws:
    
    PluginIncompatibleException
  - setupPluginRealm
```
public void setupPluginRealm(PluginDescriptor pluginDescriptor,
                    MavenSession session,
                    ClassLoader parent,
                    List<String> imports,
                    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 interface MavenPluginManager
    
    Parameters:
    pluginDescriptor - The plugin descriptor in which to save the class realm and the plugin artifacts, must not be null.
    session - The build session from which to pick the current project and repository settings, must not be null.
    parent - The parent class realm for the plugin, may be null to use the Maven core realm.
    imports - The packages/types to import from the parent realm, may be null.
    filter - The filter used to exclude certain plugin dependencies, may be null.
    
    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 lookup the mojo from. Warning: The returned mojo instance must be released via MavenPluginManager.releaseMojo(Object, MojoExecution) when the mojo is no longer needed to free any resources allocated for it.
    
    Specified by:
    
    getConfiguredMojo in interface MavenPluginManager
    
    Parameters:
    mojoInterface - The component role of the mojo, must not be null.
    session - The build session in whose context the mojo will be used, must not be null.
    mojoExecution - The mojo execution to retrieve the mojo for, must not be null.
    
    Returns:
    The ready-to-execute mojo, never null.
    
    Throws:
    
    PluginConfigurationException
    
    PluginContainerException
  - releaseMojo
```
public void releaseMojo(Object mojo,
               MojoExecution mojoExecution)
```
    Description copied from interface: MavenPluginManager
    
    Releases the specified mojo back to the container.
    
    Specified by:
    
    releaseMojo in interface MavenPluginManager
    
    Parameters:
    mojo - The mojo to release, may be null.
    mojoExecution - The mojo execution the mojo was originally retrieved for, must not be null.
  - setupExtensionsRealm
```
public ExtensionRealmCache.CacheRecord setupExtensionsRealm(MavenProject project,
                                                   Plugin plugin,
                                                   RepositorySystemSession session)
                                                     throws PluginManagerException
```
    Description copied from interface: MavenPluginManager
    
    Sets up class realm for the specified build extensions plugin.
    
    Specified by:
    
    setupExtensionsRealm in interface MavenPluginManager
    
    Throws:
    
    PluginManagerException

Class DefaultMavenPluginManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_EXTENSIONS_REALMS

Constructor Detail

DefaultMavenPluginManager

Method Detail

getPluginDescriptor

getMojoDescriptor

checkRequiredMavenVersion

setupPluginRealm

getConfiguredMojo

releaseMojo

setupExtensionsRealm