org.wildfly.plugin.server.ShutdownMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wildfly-maven-plugin Show documentation
A maven plugin that allows various management operations to be executed on WildFly Application Server.
The newest version!
/*
 * Copyright The WildFly Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package org.wildfly.plugin.server;

import java.io.IOException;
import java.util.concurrent.TimeUnit;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.jboss.as.controller.client.ModelControllerClient;
import org.wildfly.plugin.common.AbstractServerConnection;
import org.wildfly.plugin.common.PropertyNames;
import org.wildfly.plugin.common.ServerOperations;
import org.wildfly.plugin.tools.server.ServerManager;

/**
 * Shuts down a running WildFly Application Server.
 * 
 * Can also be used to issue a reload instead of a full shutdown. If a reload is executed the process will wait for the
 * serer to be available before returning.
 *
 * @author James R. Perkins
 */
@Mojo(name = "shutdown")
public class ShutdownMojo extends AbstractServerConnection {

    /**
     * Set to {@code true} if a {@code reload} operation should be invoked instead of a {@code shutdown}. For domain
     * servers this executes a {@code reload-servers} operation. If set to {@code true} the process will wait up to the
     * {@code timeout} limit for the server to be available before returning.
     */
    @Parameter(defaultValue = "false", property = PropertyNames.RELOAD)
    private boolean reload;

    /**
     * Set to {@code true} if you want to skip server shutdown, otherwise {@code false}.
     */
    @Parameter(defaultValue = "false", property = PropertyNames.SKIP)
    private boolean skip;

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        if (skip) {
            getLog().debug("Skipping server shutdown");
            return;
        }
        try (ModelControllerClient client = createClient()) {
            if (ServerManager.isRunning(client)) {
                final ServerManager serverManager = ServerManager.builder().client(client).build().get(timeout,
                        TimeUnit.SECONDS);
                if (reload) {
                    if (serverManager.containerDescription().isDomain()) {
                        client.execute(ServerOperations.createOperation("reload-servers"));
                    } else {
                        client.execute(ServerOperations.createOperation(ServerOperations.RELOAD));
                    }
                    serverManager.waitFor(timeout, TimeUnit.SECONDS);
                } else {
                    serverManager.shutdown();
                }
                // Bad hack to get maven to complete it's message output
                try {
                    TimeUnit.MILLISECONDS.sleep(500L);
                } catch (InterruptedException ignore) {
                    ignore.printStackTrace();
                    // no-op
                }
            }
        } catch (IOException e) {
            throw new MojoExecutionException(String.format("Please make sure a server is running before executing goal " +
                    "%s. Reason: %s", goal(), e.getMessage()), e);
        } catch (Exception e) {
            throw new MojoExecutionException(String.format("Could not execute goal %s. Reason: %s", goal(), e.getMessage()), e);
        }
    }

    @Override
    public String goal() {
        return "shutdown";
    }
}