io.joshworks.snappy.maven.StopMojo Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012-2015 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.joshworks.snappy.maven;

import org.apache.maven.plugin.AbstractMojo;
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.project.MavenProject;

import javax.management.InstanceNotFoundException;
import javax.management.MBeanServerConnection;
import javax.management.remote.JMXConnector;
import java.io.IOException;
import java.lang.management.ManagementFactory;

/**
 * Stop a spring application that has been started by the "start" goal. Typically invoked
 * once a test suite has completed.
 *
 * @author Stephane Nicoll
 * @since 1.3.0
 */
@Mojo(name = "stop", requiresProject = true, defaultPhase = LifecyclePhase.POST_INTEGRATION_TEST)
public class StopMojo extends AbstractMojo {

    /**
     * The Maven project.
     *
     * @since 1.4.1
     */
    @Parameter(defaultValue = "${project}", readonly = true, required = true)
    private MavenProject project;

    /**
     * Flag to indicate if process to stop was forked. By default, the value is inherited
     * from the {@link MavenProject}. If it is set, it must match the value used to
     * {@link StartMojo start} the process.
     *
     * @since 1.3
     */
    @Parameter(property = "fork")
    private Boolean fork;

    /**
     * The JMX name of the automatically deployed MBean managing the lifecycle of the
     * application.
     */
    @Parameter
    private String jmxName = SpringApplicationAdminClient.DEFAULT_OBJECT_NAME;

    /**
     * The port to use to lookup the platform MBeanServer if the application has been
     * forked.
     */
    @Parameter
    private int jmxPort = 9001;

    /**
     * Skip the execution.
     *
     * @since 1.3.2
     */
    @Parameter(defaultValue = "false")
    private boolean skip;

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        if (this.skip) {
            getLog().debug("skipping stop as per configuration.");
            return;
        }
        getLog().info("Stopping application...");
        try {
            if (isForked()) {
                stopForkedProcess();
            } else {
                stop();
            }
        } catch (IOException ex) {
            // The response won't be received as the server has died - ignoring
            getLog().debug("Service is not reachable anymore (" + ex.getMessage() + ")");
        }
    }

    private boolean isForked() {
        if (this.fork != null) {
            return this.fork;
        }
        String property = this.project.getProperties()
                .getProperty("_spring.boot.fork.enabled");
        return Boolean.valueOf(property);
    }

    private void stopForkedProcess()
            throws IOException, MojoFailureException, MojoExecutionException {
        JMXConnector connector = SpringApplicationAdminClient.connect(this.jmxPort);
        try {
            MBeanServerConnection connection = connector.getMBeanServerConnection();
            doStop(connection);
        } finally {
            connector.close();
        }
    }

    private void stop() throws IOException, MojoFailureException, MojoExecutionException {
        doStop(ManagementFactory.getPlatformMBeanServer());
    }

    private void doStop(MBeanServerConnection connection)
            throws IOException, MojoExecutionException {
        try {
            new SpringApplicationAdminClient(connection, this.jmxName).stop();
        } catch (InstanceNotFoundException ex) {
            throw new MojoExecutionException(
                    "Spring application lifecycle JMX bean not found (fork is " + ""
                            + this.fork + "). Could not stop application gracefully",
                    ex);
        }
    }

}