Class ResolvePluginsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.dependency.AbstractDependencyMojo

org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo

org.apache.maven.plugins.dependency.resolvers.AbstractResolveMojo

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 AbstractResolveMojo

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

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	outputAbsoluteArtifactFilename	Output absolute filename for resolved artifacts
private String	outputEncoding

Fields inherited from class AbstractResolveMojo

appendOutput, excludeReactor, outputFile

Fields inherited from class AbstractDependencyFilterMojo

classifier, excludeArtifactIds, excludeClassifiers, excludeGroupIds, excludeScope, excludeTransitive, excludeTypes, includeArtifactIds, includeClassifiers, includeGroupIds, includeScope, includeTypes, markersDirectory, overWriteIfNewer, overWriteReleases, overWriteSnapshots, prependGroupId, type

Fields inherited from class AbstractDependencyMojo

reactorProjects, session

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

ROLE

Constructor Summary

Constructors

Constructor	Description
ResolvePluginsMojo()

Method Summary

Modifier and Type	Method	Description
protected void	doExecute()	Main entry into mojo.
private org.apache.maven.shared.artifact.filter.collection.FilterArtifacts	getArtifactsFilter()
protected org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter	getMarkedArtifactFilter()	Return an ArtifactsFilter indicating which artifacts must be filtered out.
private Set<org.apache.maven.artifact.Artifact>	resolveArtifactDependencies(org.apache.maven.shared.transfer.dependencies.DependableCoordinate artifact)	This method resolves all transitive dependencies of an artifact.
private Set<org.apache.maven.artifact.Artifact>	resolvePluginArtifacts()	This method resolves the plugin artifacts from the project.

Methods inherited from class AbstractDependencyFilterMojo

filterMarkedDependencies, getDependencyResolver, getDependencySets, getDependencySets, getMarkersDirectory, getRepositoryManager, getResolvedDependencies, getResolverUtil, isPrependGroupId, setMarkersDirectory, setPrependGroupId

Methods inherited from class AbstractDependencyMojo

execute, getProject, isSilent, isSkip, newResolveArtifactProjectBuildingRequest, newResolvePluginProjectBuildingRequest, 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

outputEncoding

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

outputAbsoluteArtifactFilename

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

Output absolute filename for resolved artifacts

Since:

2.0

Constructor Details

ResolvePluginsMojo

public ResolvePluginsMojo()

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.

resolveArtifactDependencies

private Set<org.apache.maven.artifact.Artifact> resolveArtifactDependencies(org.apache.maven.shared.transfer.dependencies.DependableCoordinate artifact)
                                                                     throws org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolverException

This method resolves all transitive dependencies of an artifact.

Parameters:

artifact - the artifact used to retrieve dependencies

Returns:

resolved set of dependencies

Throws:

org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolverException - in case of error while resolving artifacts.

getArtifactsFilter

private org.apache.maven.shared.artifact.filter.collection.FilterArtifacts getArtifactsFilter()

Returns:

FilterArtifacts

resolvePluginArtifacts

private Set<org.apache.maven.artifact.Artifact> resolvePluginArtifacts()
                                                                throws org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException,
org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException,
org.eclipse.aether.resolution.ArtifactResolutionException

This method resolves the plugin artifacts from the project.

Returns:

set of resolved plugin artifacts

Throws:

org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException - in case of an error

org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException - in case of an error

org.eclipse.aether.resolution.ArtifactResolutionException

getMarkedArtifactFilter

protected org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter getMarkedArtifactFilter()

Description copied from class: AbstractDependencyFilterMojo

Return an ArtifactsFilter indicating which artifacts must be filtered out.

Specified by:

getMarkedArtifactFilter in class AbstractDependencyFilterMojo

Returns:

an ArtifactsFilter indicating which artifacts must be filtered out.