Package org.ovirt.maven.plugin.jbossmodules

Class AttachModulesMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.ovirt.maven.plugin.jbossmodules.AttachModulesMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
@Mojo(name="attach-modules", defaultPhase=PACKAGE, requiresDependencyCollection=COMPILE) public class AttachModulesMojo extends org.apache.maven.plugin.AbstractMojo
This mojo creates a .zip file containing the .jar file of the project and the module.xml files available in the src/main/modules directory. This .zip file is then attached to the project using zip as the type and a classifier composed by the optional category parameter and the modules word.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    category
    Category of the module.
    private boolean
    generateIndex
    This is parameter is no longer used, index generation has been removed.
    private String
    moduleName
    The name of the module.
    private List<Module>
    modules
    The list of modules to generate.
    private File
    modulesDir
    The temporary directory where modules will be stored.
    private String
    moduleSlot
    The slot of the module.
    private org.apache.maven.project.MavenProject
    project
    The maven project.
    private org.apache.maven.project.MavenProjectHelper
    projectHelper
    The project helper.

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

    ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    AttachModulesMojo()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    private void
    createModule(Module module)
     
    void
    execute()
     
    private String
    makeArchiveName()
    Computes the name of the archive that contains the modules.
    private String
    makeClassifier()
    Computes the classifier of the archive that contains the modules.

    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 Details

    • project

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

    • projectHelper

      @Component private org.apache.maven.project.MavenProjectHelper projectHelper
      The project helper.

    • moduleName

      @Parameter(property="moduleName", required=false) private String moduleName
      The name of the module.

    • moduleSlot

      @Parameter(property="moduleSlot", required=false, defaultValue="main") private String moduleSlot
      The slot of the module.

    • modules

      @Parameter(property="modules") private List<Module> modules
      The list of modules to generate.

    • generateIndex

      @Parameter(property="generateIndex", defaultValue="false") private boolean generateIndex
      This is parameter is no longer used, index generation has been removed.

    • category

      @Parameter(property="category", defaultValue="") private String category
      Category of the module. If given the value is added as a prefix to the classifier and to the name of the artifact. For example, if the value is common then the classifier will be common-modules and the name of the attached artifact will be common-modules.zip.

    • modulesDir

      private File modulesDir
      The temporary directory where modules will be stored.

  • Constructor Details

    • AttachModulesMojo

      public AttachModulesMojo()

  • Method Details

    • execute

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

    • makeArchiveName

      private String makeArchiveName()
      Computes the name of the archive that contains the modules. It will be final name of the build, followed by the optional category and then modules.zip, with dashes as separators where needed.

    • makeClassifier

      private String makeClassifier()
      Computes the classifier of the archive that contains the modules. It will be the optional category followed by the word modules, with a dash as separator if needed.

    • createModule

      private void createModule(Module module) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException