Class UnpackSourcesMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

    @Mojo(name="unpack-sources",
          requiresDependencyResolution=RUNTIME,
          defaultPhase=PROCESS_RESOURCES,
          requiresProject=true)
    public final class UnpackSourcesMojo
    extends org.apache.maven.plugin.AbstractMojo
    Resolves and unpack corresponding sources of project dependencies.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager
      To look up Archiver/UnArchiver implementations.
      private boolean attachSources
      Attach the generated artifact to the maven project.
      private java.lang.String excludeArtifactIds
      Comma separated list of Artifact names to exclude.
      private java.lang.String excludeClassifiers
      Comma Separated list of Classifiers to exclude.
      private java.lang.String excludeGroupIds
      Comma separated list of GroupId Names to exclude.
      private java.lang.String excludes
      Comma separated list of include patterns.
      private java.lang.String excludeScope
      Scope to exclude.
      private boolean excludeTransitive
      If we should exclude transitive dependencies.
      private java.lang.String excludeTypes
      Comma Separated list of Types to exclude.
      private java.lang.String includeArtifactIds
      Comma separated list of Artifact names to include.
      private java.lang.String includeClassifiers
      Comma Separated list of Classifiers to include.
      private java.lang.String includeGroupIds
      Comma separated list of GroupIds to include.
      private java.lang.String includes
      Comma separated list of include patterns.
      private java.lang.String includeScope
      Scope to include.
      private java.lang.String includeTypes
      Comma Separated list of Types to include.
      private java.io.File outputDirectory
      Directory where the sources artifacts are unpacked.
      private org.apache.maven.project.MavenProject project
      The maven project.
      private static java.lang.String PROPERTY_PREFIX
      Parameters property prefix.
      private java.util.List<org.eclipse.aether.repository.RemoteRepository> remoteRepos
      The project remote repositories to use.
      private org.eclipse.aether.RepositorySystemSession repoSession
      The current repository/network configuration of Maven.
      private org.eclipse.aether.RepositorySystem repoSystem
      The entry point to Aether.
      private boolean silent
      Verbosity.
      private boolean skip
      Skip this mojo.
      • Fields inherited from interface org.apache.maven.plugin.Mojo

        ROLE
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void execute()  
      • 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

      • PROPERTY_PREFIX

        private static final java.lang.String PROPERTY_PREFIX
        Parameters property prefix.
        See Also:
        Constant Field Values
      • project

        @Parameter(defaultValue="${project}",
                   required=true,
                   readonly=true)
        private org.apache.maven.project.MavenProject project
        The maven project.
      • repoSystem

        @Component
        private org.eclipse.aether.RepositorySystem repoSystem
        The entry point to Aether.
      • repoSession

        @Parameter(defaultValue="${repositorySystemSession}",
                   readonly=true)
        private org.eclipse.aether.RepositorySystemSession repoSession
        The current repository/network configuration of Maven.
      • remoteRepos

        @Parameter(defaultValue="${project.remoteProjectRepositories}",
                   readonly=true)
        private java.util.List<org.eclipse.aether.repository.RemoteRepository> remoteRepos
        The project remote repositories to use.
      • archiverManager

        @Component
        private org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager
        To look up Archiver/UnArchiver implementations.
      • includes

        @Parameter(property="gfbuild.unpackincludes")
        private java.lang.String includes
        Comma separated list of include patterns.
      • excludes

        @Parameter(property="gfbuild.unpackexcludes")
        private java.lang.String excludes
        Comma separated list of include patterns.
      • excludeTransitive

        @Parameter(property="gfbuild.unpackexcludeTransitive",
                   defaultValue="",
                   required=false)
        private boolean excludeTransitive
        If we should exclude transitive dependencies.
      • includeTypes

        @Parameter(property="gfbuild.unpackincludeTypes",
                   defaultValue="",
                   required=false)
        private java.lang.String includeTypes
        Comma Separated list of Types to include. Empty String indicates include everything (default).
      • excludeTypes

        @Parameter(property="gfbuild.unpackexcludeTypes",
                   defaultValue="",
                   required=false)
        private java.lang.String excludeTypes
        Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).
      • includeScope

        @Parameter(property="gfbuild.unpackincludeScope",
                   defaultValue="",
                   required=false)
        private java.lang.String includeScope
        Scope to include. An Empty string indicates all scopes (default).
      • excludeScope

        @Parameter(property="gfbuild.unpackexcludeScope",
                   defaultValue="",
                   required=false)
        private java.lang.String excludeScope
        Scope to exclude. An Empty string indicates no scopes (default).
      • includeClassifiers

        @Parameter(property="gfbuild.unpackincludeClassifiers",
                   defaultValue="",
                   required=false)
        private java.lang.String includeClassifiers
        Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
      • excludeClassifiers

        @Parameter(property="gfbuild.unpackexcludeClassifiers",
                   defaultValue="",
                   required=false)
        private java.lang.String excludeClassifiers
        Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
      • excludeArtifactIds

        @Parameter(property="gfbuild.unpackexcludeArtifactIds",
                   defaultValue="",
                   required=false)
        private java.lang.String excludeArtifactIds
        Comma separated list of Artifact names to exclude.
      • includeArtifactIds

        @Parameter(property="gfbuild.unpackincludeArtifactIds",
                   defaultValue="")
        private java.lang.String includeArtifactIds
        Comma separated list of Artifact names to include.
      • excludeGroupIds

        @Parameter(property="gfbuild.unpackexcludeGroupIds",
                   defaultValue="")
        private java.lang.String excludeGroupIds
        Comma separated list of GroupId Names to exclude.
      • includeGroupIds

        @Parameter(property="gfbuild.unpackincludeGroupIds",
                   defaultValue="")
        private java.lang.String includeGroupIds
        Comma separated list of GroupIds to include.
      • outputDirectory

        @Parameter(property="gfbuild.unpackoutputDirectory",
                   defaultValue="${project.build.directory}/sources-dependency")
        private java.io.File outputDirectory
        Directory where the sources artifacts are unpacked.
      • silent

        @Parameter(property="gfbuild.unpacksilent",
                   defaultValue="false")
        private boolean silent
        Verbosity.
      • attachSources

        @Parameter(property="gfbuild.unpackattach-sources",
                   defaultValue="false")
        private boolean attachSources
        Attach the generated artifact to the maven project.
      • skip

        @Parameter(property="gfbuild.unpackskip",
                   defaultValue="false")
        private boolean skip
        Skip this mojo.
    • Constructor Detail

      • UnpackSourcesMojo

        public UnpackSourcesMojo()
    • Method Detail

      • execute

        public void execute()
                     throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException