org.apache.maven.reporting.exec

Class DefaultMavenReportExecutor

java.lang.Object

org.apache.maven.reporting.exec.DefaultMavenReportExecutor

All Implemented Interfaces:

MavenReportExecutor

@Component(role=MavenReportExecutor.class)
public class DefaultMavenReportExecutor
extends java.lang.Object
implements MavenReportExecutor

This component will build some MavenReportExecution from MavenReportExecutorRequest. If a MavenReport needs to fork a lifecycle, this fork is executed here. It will ask the core to get some informations in order to correctly setup MavenReport.

Note if no version is defined in the report plugin, the version will be searched with resolvePluginVersion(...) method:

1. use the one defined in the reportPlugin configuration,
2. search similar (same groupId and artifactId) plugin in the build/plugins section of the pom,
3. search similar (same groupId and artifactId) plugin in the build/pluginManagement section of the pom,
4. ask PluginVersionResolver to get a fallback version (display a warning as it's not a recommended use).

Following steps are done:

• get PluginDescriptor from the MavenPluginManager (through MavenPluginManagerHelper.getPluginDescriptor(...) to protect from core API change)
• setup a ClassLoader, with the Site plugin classloader as parent for the report execution.
  Notice that some classes are imported from the current Site plugin ClassRealm: see IMPORTS. Corresponding artifacts are excluded from the artifact resolution: doxia-site-renderer, doxia-sink-api and maven-reporting-api.
  Work is done using MavenPluginManager (through MavenPluginManagerHelper.setupPluginRealm(...) to protect from core API change)
• setup the mojo using MavenPluginManager.getConfiguredMojo(...)
• verify with LifecycleExecutor.calculateForkedExecutions(...) if any forked execution is needed: if yes, execute the forked execution here

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultMavenReportExecutor.GoalWithConf

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.List<java.lang.String>	EXCLUDES
private static java.util.List<java.lang.String>	IMPORTS
protected org.apache.maven.lifecycle.LifecycleExecutor	lifecycleExecutor
private org.codehaus.plexus.logging.Logger	logger
protected org.apache.maven.plugin.MavenPluginManager	mavenPluginManager
protected MavenPluginManagerHelper	mavenPluginManagerHelper
protected org.apache.maven.plugin.version.PluginVersionResolver	pluginVersionResolver

Constructor Summary

Constructors

Constructor and Description
DefaultMavenReportExecutor()

Method Summary

Modifier and Type	Method and Description
java.util.List<MavenReportExecution>	buildMavenReports(MavenReportExecutorRequest mavenReportExecutorRequest) Build the MavenReports, with associated forked executions if necessary.
protected java.util.List<MavenReportExecution>	buildReportPlugin(MavenReportExecutorRequest mavenReportExecutorRequest, ReportPlugin reportPlugin)
private boolean	canAggregate(org.apache.maven.project.MavenProject project)
private org.codehaus.plexus.util.xml.Xpp3Dom	convert(org.codehaus.plexus.configuration.PlexusConfiguration config)
private org.apache.maven.model.Plugin	find(ReportPlugin reportPlugin, java.util.List<org.apache.maven.model.Plugin> plugins) Search similar (same groupId and artifactId) plugin as a given report plugin.
private org.apache.maven.reporting.MavenReport	getConfiguredMavenReport(org.apache.maven.plugin.MojoExecution mojoExecution, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor, MavenReportExecutorRequest mavenReportExecutorRequest)
private org.codehaus.plexus.logging.Logger	getLog()
private boolean	isMavenReport(org.apache.maven.plugin.MojoExecution mojoExecution, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
private org.codehaus.plexus.util.xml.Xpp3Dom	mergeConfiguration(org.codehaus.plexus.configuration.PlexusConfiguration mojoConf, org.codehaus.plexus.util.xml.Xpp3Dom pluginMgmtConfig, org.codehaus.plexus.configuration.PlexusConfiguration pluginConf, org.codehaus.plexus.configuration.PlexusConfiguration reportSetConf, java.util.Set<java.lang.String> parameters) Merge plugin configuration and reportset configuration to mojo configuration to get effective mojo configuration.
private void	mergePluginToReportPlugin(MavenReportExecutorRequest mavenReportExecutorRequest, org.apache.maven.model.Plugin buildPlugin, ReportPlugin reportPlugin) TODO other stuff to merge ?
private boolean	prepareGoals(ReportPlugin reportPlugin, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor, java.util.List<DefaultMavenReportExecutor.GoalWithConf> goalsWithConfiguration)
private MavenReportExecution	prepareReportExecution(MavenReportExecutorRequest mavenReportExecutorRequest, DefaultMavenReportExecutor.GoalWithConf report, boolean hasUserDefinedReports)
protected java.lang.String	resolvePluginVersion(ReportPlugin reportPlugin, MavenReportExecutorRequest mavenReportExecutorRequest) Resolve report plugin version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

@Requirement
private org.codehaus.plexus.logging.Logger logger

mavenPluginManager

@Requirement
protected org.apache.maven.plugin.MavenPluginManager mavenPluginManager

mavenPluginManagerHelper

@Requirement
protected MavenPluginManagerHelper mavenPluginManagerHelper

lifecycleExecutor

@Requirement
protected org.apache.maven.lifecycle.LifecycleExecutor lifecycleExecutor

pluginVersionResolver

@Requirement
protected org.apache.maven.plugin.version.PluginVersionResolver pluginVersionResolver

IMPORTS

private static final java.util.List<java.lang.String> IMPORTS

EXCLUDES

private static final java.util.List<java.lang.String> EXCLUDES

Constructor Detail

DefaultMavenReportExecutor

public DefaultMavenReportExecutor()

Method Detail

buildMavenReports

public java.util.List<MavenReportExecution> buildMavenReports(MavenReportExecutorRequest mavenReportExecutorRequest)
                                                       throws org.apache.maven.plugin.MojoExecutionException

Description copied from interface: MavenReportExecutor

Build the MavenReports, with associated forked executions if necessary.

Specified by:

buildMavenReports in interface MavenReportExecutor

Returns:

a list or prepared Maven report executions

Throws:

org.apache.maven.plugin.MojoExecutionException

buildReportPlugin

protected java.util.List<MavenReportExecution> buildReportPlugin(MavenReportExecutorRequest mavenReportExecutorRequest,
                                                                 ReportPlugin reportPlugin)
                                                          throws java.lang.Exception

Throws:

java.lang.Exception

prepareGoals

private boolean prepareGoals(ReportPlugin reportPlugin,
                             org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor,
                             java.util.List<DefaultMavenReportExecutor.GoalWithConf> goalsWithConfiguration)

prepareReportExecution

private MavenReportExecution prepareReportExecution(MavenReportExecutorRequest mavenReportExecutorRequest,
                                                    DefaultMavenReportExecutor.GoalWithConf report,
                                                    boolean hasUserDefinedReports)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

canAggregate

private boolean canAggregate(org.apache.maven.project.MavenProject project)

getConfiguredMavenReport

private org.apache.maven.reporting.MavenReport getConfiguredMavenReport(org.apache.maven.plugin.MojoExecution mojoExecution,
                                                                        org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor,
                                                                        MavenReportExecutorRequest mavenReportExecutorRequest)
                                                                 throws org.apache.maven.plugin.PluginContainerException,
                                                                        org.apache.maven.plugin.PluginConfigurationException

Throws:

org.apache.maven.plugin.PluginContainerException

org.apache.maven.plugin.PluginConfigurationException

isMavenReport

private boolean isMavenReport(org.apache.maven.plugin.MojoExecution mojoExecution,
                              org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)

mergeConfiguration

private org.codehaus.plexus.util.xml.Xpp3Dom mergeConfiguration(org.codehaus.plexus.configuration.PlexusConfiguration mojoConf,
                                                                org.codehaus.plexus.util.xml.Xpp3Dom pluginMgmtConfig,
                                                                org.codehaus.plexus.configuration.PlexusConfiguration pluginConf,
                                                                org.codehaus.plexus.configuration.PlexusConfiguration reportSetConf,
                                                                java.util.Set<java.lang.String> parameters)

Merge plugin configuration and reportset configuration to mojo configuration to get effective mojo configuration.

Parameters:

mojoConf - configuration done at mojo descriptor level

pluginMgmtConfig - configuration done at build.pluginManagement level

pluginConf - configuration done at reporting plugin level

reportSetConf - configuration done at reportSet level

parameters - set of supported parameters: any other parameter will be removed

Returns:

the effective configuration to be used

convert

private org.codehaus.plexus.util.xml.Xpp3Dom convert(org.codehaus.plexus.configuration.PlexusConfiguration config)

getLog

private org.codehaus.plexus.logging.Logger getLog()

resolvePluginVersion

protected java.lang.String resolvePluginVersion(ReportPlugin reportPlugin,
                                                MavenReportExecutorRequest mavenReportExecutorRequest)
                                         throws org.apache.maven.plugin.version.PluginVersionResolutionException

Resolve report plugin version. Steps to find a plugin version stop after each step if a non null value has been found:

1. use the one defined in the reportPlugin configuration,
2. search similar (same groupId and artifactId) mojo in the build/plugins section of the pom,
3. search similar (same groupId and artifactId) mojo in the build/pluginManagement section of the pom,
4. ask PluginVersionResolver to get a fallback version and display a warning as it's not a recommended use.

Parameters:

reportPlugin - the report plugin to resolve the version

mavenReportExecutorRequest - the current report execution context

Returns:

the report plugin version

Throws:

org.apache.maven.plugin.version.PluginVersionResolutionException

find

private org.apache.maven.model.Plugin find(ReportPlugin reportPlugin,
                                           java.util.List<org.apache.maven.model.Plugin> plugins)

Search similar (same groupId and artifactId) plugin as a given report plugin.

Parameters:

reportPlugin - the report plugin to search for a similar plugin

plugins - the candidate plugins

Returns:

the first similar plugin

mergePluginToReportPlugin

private void mergePluginToReportPlugin(MavenReportExecutorRequest mavenReportExecutorRequest,
                                       org.apache.maven.model.Plugin buildPlugin,
                                       ReportPlugin reportPlugin)

TODO other stuff to merge ?

this method will "merge" some part of the plugin declaration existing in the build section to the fake plugin build for report execution:

• dependencies

Parameters:

mavenReportExecutorRequest -

buildPlugin -

reportPlugin -