Class PackageUpdateSiteMojo

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

    @Mojo(name="update-site-packaging")
    public class PackageUpdateSiteMojo
    extends org.apache.maven.plugin.AbstractMojo
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean archiveSite
      If true, create site assembly zip file.
      protected org.apache.maven.project.MavenProject project  
      private org.apache.maven.project.MavenProjectHelper projectHelper
      Used for attaching assembled update site to the project.
      private java.io.File target
      Generated update site location (must match update-site mojo configuration)
      • 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

      • project

        @Parameter(property="project",
                   required=true,
                   readonly=true)
        protected org.apache.maven.project.MavenProject project
      • target

        @Parameter(defaultValue="${project.build.directory}/site")
        private java.io.File target
        Generated update site location (must match update-site mojo configuration)
      • archiveSite

        @Parameter(defaultValue="false")
        private boolean archiveSite
        If true, create site assembly zip file. If false (the default), do not create site assembly zip file. Please note that the project's main artifact that will be deployed/installed to maven repository is a zip only containing the site.xml. However, if this parameter is set to true an additional result file classified as 'assembly' containing a full packaged update site will be created and installed.
      • projectHelper

        @Component
        private org.apache.maven.project.MavenProjectHelper projectHelper
        Used for attaching assembled update site to the project.
    • Constructor Detail

      • PackageUpdateSiteMojo

        public PackageUpdateSiteMojo()
    • Method Detail

      • execute

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