Package org.apache.maven.plugins.dependency.resolvers

Class 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 java.util.List<java.lang.String> excludeArtifactIds
      List of artifact IDs to exclude.
      protected java.util.List<java.lang.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 java.util.List<java.lang.String> includeArtifactIds
      List of artifact IDs to include.
      protected java.util.List<java.lang.String> includeGroupIds
      List of group IDs to include.
      private boolean outputAbsoluteArtifactFilename
      Output absolute filename for resolved artifacts.
      private java.lang.String outputEncoding
      The encoding of the output file.
      protected java.io.File outputFile
      If specified, this parameter causes the dependencies to be written to the path specified instead of the console.
      private ResolverUtil resolverUtil  

      • 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

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

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

        getLog, getPluginContext, setLog, setPluginContext

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • outputFile

        @Parameter(property="outputFile")
protected java.io.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 java.util.List<java.lang.String> excludeArtifactIds
        List of artifact IDs to exclude.
        Since:
        2.0

      • includeArtifactIds

        @Parameter(property="includeArtifactIds",
           defaultValue="")
protected java.util.List<java.lang.String> includeArtifactIds
        List of artifact IDs to include. Empty list indicates include everything (default).
        Since:
        2.0

      • excludeGroupIds

        @Parameter(property="excludeGroupIds",
           defaultValue="")
protected java.util.List<java.lang.String> excludeGroupIds
        List of group IDs to exclude.
        Since:
        2.0

      • includeGroupIds

        @Parameter(property="includeGroupIds",
           defaultValue="")
protected java.util.List<java.lang.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 java.lang.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

    • Constructor Detail

      • 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 Detail

      • 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 java.util.function.Predicate<org.apache.maven.model.Dependency> getDependencyFilter()

      • getProjectPlugins

        private java.util.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