org.tentackle.maven.plugin.jlink.ArtifactCreator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tentackle-jlink-maven-plugin Show documentation
Maven Plugin to Create Self-Contained Applications
There is a newer version: 21.16.1.0
Show newest version
/*
 * Tentackle - https://tentackle.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.tentackle.maven.plugin.jlink;

import org.apache.maven.plugin.MojoExecutionException;

import org.tentackle.common.ServiceFactory;

import java.io.File;


interface ArtifactCreatorHolder {
  ArtifactCreator INSTANCE = ServiceFactory.createService(ArtifactCreator.class, DefaultArtifactCreator.class, false);
}

/**
 * Modifies, creates and attaches the artifacts to be deployed.

 * May be replaced via @{@link org.tentackle.common.Service} annotation from within an application-specific plugin dependency.
 * For example, to further modify the files or create a bunch of artifacts with different configurations.
 * 
 * Example:
 * 
 *   @Service(ArtifactCreator.class)
 *   public class SpecialArtifactCreator implements ArtifactCreator {
 *
 *     @Override
 *     public void createAndAttachArtifact(JlinkMojo mojo) throws MojoExecutionException {
 *       ...
 *     }
 *   }
 * 
 *
 * Add as plugin dependency:
 *
 *  *   <plugin>
 *     <groupId>org.tentackle</groupId>
 *     <artifactId>tentackle-jlink-maven-plugin</artifactId>
 *     <dependencies>
 *       <dependency>
 *         <groupId>com.example</groupId>
 *         <artifactId>special-creator</artifactId>
 *         <version>1.0</version>
 *       </dependency>
 *     </dependencies>
 *     <configuration>
 *       ...
 *     </configuration>
 *   </plugin>
 * 
 */
public interface ArtifactCreator {

  /**
   * The singleton.
   *
   * @return the singleton
   */
  static ArtifactCreator getInstance() {
    return ArtifactCreatorHolder.INSTANCE;
  }

  /**
   * Creates and attaches the ZIP file created by the jlink goal.

   * This also provides the option to modify the created jlink directory before zipping it.
   *
   * @param mojo the jlink mojo
   * @throws MojoExecutionException if failed
   */
  void createAndAttachArtifact(JLinkMojo mojo) throws MojoExecutionException;

  /**
   * Processes the created application image.
   *
   * @param mojo the jpackage mojo
   * @param imageDir the directory of the application image created by the jpackage tool
   * @throws MojoExecutionException if failed
   */
  void processApplicationImage(JPackageMojo mojo, File imageDir) throws MojoExecutionException;

  /**
   * Attaches the installers created by the jpackage goal.
   *
   * @param mojo the jpackage mojo
   * @param minTime the minimum creating time of the artifacts
   * @throws MojoExecutionException if failed
   */
  void attachInstallers(JPackageMojo mojo, long minTime) throws MojoExecutionException;

  /**
   * Creates and attaches the update ZIP file created by the jpackage goal.

   * Invoked only if update feature is enabled.
   *
   * @param mojo the jpackage mojo
   * @param appImageDir the application image directory
   * @throws MojoExecutionException if failed
   * @see AbstractJLinkMojo#isWithUpdater()
   */
  void createAndAttachArtifact(JPackageMojo mojo, File appImageDir) throws MojoExecutionException;

}