fish.payara.maven.plugins.micro.BundleMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro-maven-plugin Show documentation
Payara Micro Maven Plugin that incorporates payara-micro with the produced artifact
There is a newer version: 2.4
Show newest version
/*
 *
 * Copyright (c) 2017-2018 Payara Foundation and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/master/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * The Payara Foundation designates this particular file as subject to the "Classpath"
 * exception as provided by the Payara Foundation in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package fish.payara.maven.plugins.micro;

import fish.payara.maven.plugins.micro.processor.*;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.dependency.fromConfiguration.ArtifactItem;
import org.twdata.maven.mojoexecutor.MojoExecutor;

import java.util.List;

/**
 * Bundle mojo incorporates payara-micro with the produced artifact by following steps given as follows:
 * 
 *  Fetch payara-micro from repository and open it to a folder. The default version is 5.182. Specific
 *  version can be provided with @{code payaraVersion} parameter
 *  Fetch user specified jars from repository
 *  Copy any existing {@code domain.xml}, {@code keystore.jks}, {@code login.conf } and {@code login.properties} files from resources folder into /MICRO-INF/domain folder
 *  Copy any existing {@code pre-boot-commands.txt}, {@code post-boot-commands.txt} and {@code post-deploy-commands.txt} files from resources folder into /MICRO-INF folder
 *  Copy produced artifact into /MICRO-INF/deploy folder if its extension is war
 *  Copy user specified artifacts into /MICRO-INF/deploy folder
 *  Replace {@code Start-Class} entry in the manifest file with a custom bootstrap class if it's provided by user
 *  Append system properties to @{code MICRO-INF/payara-boot.properties}
 *  Bundle aggregated content as artifactName-microbundle.jar under target folder
 * 
 * 
 * If {@code autoDeployArtifact} is {@code true}, then the context root of the application is constructed as:
 * 
 *  If {@code autoDeployContextRoot} is specified then it's the context root
 *  
If {@code autoDeployEmptyContextRoot} is {@code true} (default value) then the context root 
 *     is empty. In other words, the application path is just '/'
 *  If project's {@code finalName} is specified then the context root is equal to its value
 *  If nothing is specified then the context root is derived from the artifact metadata
 * 
 *
 * If context root is 'ROOT' then the application path is just '/' (same as if {@code autoDeployEmptyContextRoot} is set to {@code true}).
 * 
 * @author mertcaliskan
 */
@Mojo(name = "bundle", defaultPhase = LifecyclePhase.INSTALL)
public class BundleMojo extends BasePayaraMojo {

    /**
     * By default this mojo fetches payara-micro with version 5.182. It can be overridden with this parameter.
     */
    @Parameter(property = "payaraVersion", defaultValue = "5.182")
    private String payaraVersion;

    /**
     * User specified jars that will be copied into the MICRO-INF/lib directory
     */
    @Parameter
    private List customJars;

    /**
     * User specified artifacts that will be deployed by copying into the MICRO-INF/deploy directory
     */
    @Parameter
    private List deployArtifacts;

    /**
     * If the extension of the produced artifact is war, it will be copied automatically to MICRO-INF/deploy folder.
     * This behaviour can be disabled by setting @{code autoDeployArtifact} to false.
     */
    @Parameter(property = "autoDeployArtifact", defaultValue =  "true")
    private Boolean autoDeployArtifact;

    /**
     * Replaces the @{code Start-Class} definition that resides in MANIFEST.MF file with the provided class.
     */
    @Parameter(property = "startClass")
    private String startClass;
    
    /**
     * Sets context root of the deployed artifact to / which means there's no context root. Default true. 
     * If set to false, context root is derived from artifact name or finalName. Value of autoDeployContextRoot overrides this.
     */
    @Parameter(property = "autoDeployEmptyContextRoot", defaultValue = "true")
    private Boolean autoDeployEmptyContextRoot;

    /**
     * Sets context root of the deployed artifact if autoDeployArtifact is true
     */
    @Parameter(property = "autoDeployContextRoot", defaultValue = "")
    private String autoDeployContextRoot;

    /**
     * Appends all system properties defined into the @{code payara-boot.properties} file
     */
    @Parameter(property = "appendSystemProperties", defaultValue = "true")
    private Boolean appendSystemProperties;


    public void execute() throws MojoExecutionException, MojoFailureException {
        if (skip) {
            getLog().info("Bundle mojo execution is skipped");
            return;
        }

        MojoExecutor.ExecutionEnvironment environment = getEnvironment();
        BaseProcessor processor = constructProcessorChain();
        processor.handle(environment);
    }

    private BaseProcessor constructProcessorChain() throws MojoExecutionException {
        MicroUnpackProcessor microUnpackProcessor = new MicroUnpackProcessor();
        CustomJarCopyProcessor customJarCopyProcessor = new CustomJarCopyProcessor();
        CustomFileCopyProcessor customFileCopyProcessor = new CustomFileCopyProcessor();
        BootCommandFileCopyProcessor bootCommandFileCopyProcessor = new BootCommandFileCopyProcessor();
        DefinedArtifactDeployProcessor definedArtifactDeployProcessor = new DefinedArtifactDeployProcessor();
        ArtifactDeployProcessor artifactDeployProcessor = new ArtifactDeployProcessor();
        StartClassReplaceProcessor startClassReplaceProcessor = new StartClassReplaceProcessor();
        SystemPropAppendProcessor systemPropAppendProcessor = new SystemPropAppendProcessor();
        MicroJarBundleProcessor microJarBundleProcessor = new MicroJarBundleProcessor();

        microUnpackProcessor.set(payaraVersion).next(customJarCopyProcessor);
        customJarCopyProcessor.set(customJars).next(customFileCopyProcessor);
        customFileCopyProcessor.next(bootCommandFileCopyProcessor);
        bootCommandFileCopyProcessor.next(definedArtifactDeployProcessor);
        definedArtifactDeployProcessor.set(deployArtifacts).next(artifactDeployProcessor);
        artifactDeployProcessor.set(autoDeployArtifact, autoDeployContextRoot, 
                autoDeployEmptyContextRoot, mavenProject.getPackaging()).next(startClassReplaceProcessor);
        startClassReplaceProcessor.set(startClass).next(systemPropAppendProcessor);
        systemPropAppendProcessor.set(appendSystemProperties).next(microJarBundleProcessor);

        return microUnpackProcessor;
    }
}