Class ResolvePluginsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.dependency.AbstractDependencyMojo

org.apache.maven.plugins.dependency.resolvers.ResolvePluginsMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="resolve-plugins",
      defaultPhase=GENERATE_SOURCES,
      threadSafe=true)
public class ResolvePluginsMojo
extends AbstractDependencyMojo

Goal that resolves all project plugins and reports and their dependencies.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	appendOutput	Whether to append outputs into the output file or overwrite it.
protected List<String>	excludeArtifactIds	List of artifact IDs to exclude.
protected List<String>	excludeGroupIds	List of group IDs to exclude.
protected boolean	excludeReactor	Don't resolve plugins that are in the current reactor.
protected boolean	excludeTransitive	If we should exclude transitive dependencies.
protected List<String>	includeArtifactIds	List of artifact IDs to include.
protected List<String>	includeGroupIds	List of group IDs to include.
private boolean	outputAbsoluteArtifactFilename	Output absolute filename for resolved artifacts.
private String	outputEncoding	The encoding of the output file.
protected File	outputFile	If specified, this parameter causes the dependencies to be written to the path specified instead of the console.
private final ResolverUtil	resolverUtil

Fields inherited from class AbstractDependencyMojo

session

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
ResolvePluginsMojo(org.apache.maven.execution.MavenSession session, org.sonatype.plexus.build.incremental.BuildContext buildContext, org.apache.maven.project.MavenProject project, ResolverUtil resolverUtil)

Method Summary

Modifier and Type	Method	Description
protected void	doExecute()	Main entry into mojo.
private Predicate<org.apache.maven.model.Dependency>	getDependencyFilter()
private Set<org.apache.maven.model.Plugin>	getProjectPlugins()	This return plugin list of the project after applying the include/exclude filters.

Methods inherited from class AbstractDependencyMojo

execute, getProject, isSilent, isSkip, setSilent, setSkip

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

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

Field Details

outputFile

@Parameter(property="outputFile")
protected File outputFile

If specified, this parameter causes the dependencies to be written to the path specified instead of the console.

Since:

2.0

excludeTransitive

@Parameter(property="excludeTransitive",
           defaultValue="false")
protected boolean excludeTransitive

If we should exclude transitive dependencies. This means only the plugin artifacts itself will be resolved not plugin dependencies.

Since:

2.0

excludeArtifactIds

@Parameter(property="excludeArtifactIds",
           defaultValue="")
protected List<String> excludeArtifactIds

List of artifact IDs to exclude.

Since:

2.0

includeArtifactIds

@Parameter(property="includeArtifactIds",
           defaultValue="")
protected List<String> includeArtifactIds

List of artifact IDs to include. Empty list indicates include everything (default).

Since:

2.0

excludeGroupIds

@Parameter(property="excludeGroupIds",
           defaultValue="")
protected List<String> excludeGroupIds

List of group IDs to exclude.

Since:

2.0

includeGroupIds

@Parameter(property="includeGroupIds",
           defaultValue="")
protected List<String> includeGroupIds

List of group IDs to include. Empty list indicates include everything (default).

Since:

2.0

appendOutput

@Parameter(property="appendOutput",
           defaultValue="false")
protected boolean appendOutput

Whether to append outputs into the output file or overwrite it.

Since:

2.2

excludeReactor

@Parameter(property="excludeReactor",
           defaultValue="true")
protected boolean excludeReactor

Don't resolve plugins that are in the current reactor.

Since:

2.7

outputEncoding

@Parameter(property="outputEncoding",
           defaultValue="${project.reporting.outputEncoding}")
private String outputEncoding

The encoding of the output file.

Since:

3.2.0

outputAbsoluteArtifactFilename

@Parameter(property="outputAbsoluteArtifactFilename",
           defaultValue="false")
private boolean outputAbsoluteArtifactFilename

Output absolute filename for resolved artifacts.

Since:

2.0

resolverUtil

private final ResolverUtil resolverUtil

Constructor Details

ResolvePluginsMojo

@Inject
public ResolvePluginsMojo(org.apache.maven.execution.MavenSession session,
 org.sonatype.plexus.build.incremental.BuildContext buildContext,
 org.apache.maven.project.MavenProject project,
 ResolverUtil resolverUtil)

Method Details

doExecute

protected void doExecute()
                  throws org.apache.maven.plugin.MojoExecutionException

Main entry into mojo. Gets the list of dependencies and iterates through displaying the resolved version.

Specified by:

doExecute in class AbstractDependencyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - with a message if an error occurs

getDependencyFilter

private Predicate<org.apache.maven.model.Dependency> getDependencyFilter()

getProjectPlugins

private Set<org.apache.maven.model.Plugin> getProjectPlugins()

This return plugin list of the project after applying the include/exclude filters.

Returns:

set of project plugin