view web/endpoint-plugin/web-service/src/main/java/com/redhat/thermostat/web/endpoint/internal/WebappLauncherCommand.java @ 2049:a92d602216ad

Update copyright license headers for 2017 PR3290 Reviewed-by: jerboaa Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-January/021974.html
author Andrew Azores <aazores@redhat.com>
date Tue, 17 Jan 2017 12:19:56 -0500
parents 31f274ab27a5
children
line wrap: on
line source

/*
 * Copyright 2012-2017 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * Thermostat 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.web.endpoint.internal;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.logging.Logger;

import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceReference;

import com.redhat.thermostat.common.ActionEvent;
import com.redhat.thermostat.common.ActionListener;
import com.redhat.thermostat.common.cli.Console;
import com.redhat.thermostat.common.cli.AbstractStateNotifyingCommand;
import com.redhat.thermostat.common.cli.CommandContext;
import com.redhat.thermostat.common.cli.CommandException;
import com.redhat.thermostat.common.tools.ApplicationState;
import com.redhat.thermostat.common.utils.LoggingUtils;
import com.redhat.thermostat.launcher.Launcher;
import com.redhat.thermostat.shared.config.CommonPaths;
import com.redhat.thermostat.shared.config.SSLConfiguration;
import com.redhat.thermostat.shared.locale.LocalizedString;
import com.redhat.thermostat.shared.locale.Translate;

class WebappLauncherCommand extends AbstractStateNotifyingCommand {

    // The time to wait after the agent finished and before the web endpoint
    // goes down. This increases the chance of emptying the queue.
    private static final long AGENT_SHUTDOWN_PAUSE = 200;
    private static final Translate<LocaleResources> translator = LocaleResources.createLocalizer();
    private static final Logger logger = LoggingUtils.getLogger(WebappLauncherCommand.class);
    private boolean agentStarted = false;

    private final BundleContext context;
    private final List<ActionListener<ApplicationState>> listeners;

    WebappLauncherCommand(BundleContext context) {
        this.context = context;
        listeners = new ArrayList<>();
    }
    
    // PRE: 1. Storage set up with credentials and credentials appropriately
    //         updated in the web archive's web.xml
    //      2. agent.auth file appropriately set up
    //      3. agent/client users appropriately defined in thermostat-users/
    //         thermostat-roles.properties files.
    @Override
    public void run(CommandContext ctx) throws CommandException {
        ServiceReference commonPathsRef = context.getServiceReference(CommonPaths.class.getName());
        if (commonPathsRef == null) {
            getNotifier().fireAction(ApplicationState.FAIL);
            throw new CommandException(new LocalizedString("CommonPaths unavailable"));
        }
        CommonPaths paths = (CommonPaths)context.getService(commonPathsRef);
        ServiceReference launcherRef = context.getServiceReference(Launcher.class.getName());
        if (launcherRef == null) {
            getNotifier().fireAction(ApplicationState.FAIL);
            throw new CommandException(new LocalizedString("Launcher Unavailable"));
        }
        Launcher launcher = (Launcher) context.getService(launcherRef);
        // start storage
        final CountDownLatch storageLatch = new CountDownLatch(1);
        StorageStartedListener storageListener = new StorageStartedListener(storageLatch);
        listeners.add(storageListener);
        String[] storageArgs = new String[] {
                "storage", "--start"
        };
        launcher.run(storageArgs, listeners, false);
        listeners.clear();
        try {
            storageLatch.await();
        } catch (InterruptedException e) {
            getNotifier().fireAction(ApplicationState.FAIL, e);
            throw new CommandException(new LocalizedString("Interrupted waiting for storage"));
        }
        if (storageListener.startupFailed) {
            getNotifier().fireAction(ApplicationState.FAIL);
            throw new CommandException(new LocalizedString("Starting mongodb storage failed"));
        }

        ServiceReference sslConfigRef = context.getServiceReference(SSLConfiguration.class.getName());
        if (sslConfigRef == null) {
            getNotifier().fireAction(ApplicationState.FAIL);
            throw new CommandException(new LocalizedString("SSLConfiguration Unavailable"));
        }
        SSLConfiguration sslConfig = (SSLConfiguration) context.getService(sslConfigRef);

        EmbeddedServletContainerConfiguration config = getConfiguration(paths);
        JettyContainerLauncher jettyLauncher = getJettyContainerLauncher(config, sslConfig);
        CountDownLatch webStartedLatch = new CountDownLatch(1);
        // start web container with the web archive deployed
        jettyLauncher.startContainer(webStartedLatch);
        try {
            webStartedLatch.await();
        } catch (InterruptedException e) {
            // ignore
        }
        if (!jettyLauncher.isStartupSuccessFul()) {
            stopStorage(launcher);
            getNotifier().fireAction(ApplicationState.FAIL);
            throw new CommandException(new LocalizedString("Failed to start embedded jetty instance"));
        }
        
        // start agent
        try {
            listeners.add(new AgentStartedListener(ctx.getConsole()));
            String[] agentArgs = new String[] {
                "agent", "-d", config.getConnectionUrl()
            };
            // This blocks
            launcher.run(agentArgs, listeners, false);
            
            ctx.getConsole().getOutput().println("Waiting " + AGENT_SHUTDOWN_PAUSE + "MS before exiting in order to empty queues");
            // Give the agent some time to finish it's work. Requests are
            // queued and it increases the chance of finishing requests before
            // exiting for sure.
            try {
                Thread.sleep(AGENT_SHUTDOWN_PAUSE);
            } catch (InterruptedException e) { } // ignore
        } finally {
            jettyLauncher.stopContainer();
            stopStorage(launcher);
        };

        if (agentStarted) {
            getNotifier().fireAction(ApplicationState.STOP);
        }
    }
    
    // testing hook
    EmbeddedServletContainerConfiguration getConfiguration(CommonPaths paths) {
        return new EmbeddedServletContainerConfiguration(paths);
    }

    // testing hook
    JettyContainerLauncher getJettyContainerLauncher(EmbeddedServletContainerConfiguration config, SSLConfiguration sslConfig) {
        return new JettyContainerLauncher(config, sslConfig);
    }

    // This fires up the web endpoint. No need to automatically firing up
    // storage.
    @Override
    public boolean isStorageRequired() {
        return false;
    }
    
    private void stopStorage(Launcher launcher) {
        String[] storageStopArgs = new String[] {
                "storage", "--stop"
        };
        launcher.run(storageStopArgs, false);
    }

    private static class StorageStartedListener implements ActionListener<ApplicationState> {

        private final CountDownLatch storageStarted;
        private boolean startupFailed;
        
        private StorageStartedListener(CountDownLatch latch) {
            storageStarted = latch;
            // Assume startup has failed initially, until a
            // START action event is received
            startupFailed = true;
        }
        
        @Override
        public void actionPerformed(ActionEvent<ApplicationState> actionEvent) {
            if (actionEvent.getSource() instanceof AbstractStateNotifyingCommand) {
                ApplicationState state = actionEvent.getActionId();
                switch(state) {
                case START:
                    startupFailed = false;
                    // fall-through
                default:
                    storageStarted.countDown();
                    break;
                }
            }
        }
        
    }

    private class AgentStartedListener implements ActionListener<ApplicationState> {

        private final Console console;

        private AgentStartedListener(Console console) {
            this.console = console;
        }

        @Override
        public void actionPerformed(ActionEvent<ApplicationState> actionEvent) {
            if (actionEvent.getSource() instanceof AbstractStateNotifyingCommand) {
                AbstractStateNotifyingCommand agent = (AbstractStateNotifyingCommand) actionEvent.getSource();
                // Implementation detail: there is a single AgentCommand instance registered
                // as an OSGi service. We remove ourselves as listener so that we don't get
                // notified in the case that the command is invoked by some other means later.
                agent.getNotifier().removeActionListener(this);

                ApplicationState state = actionEvent.getActionId();
                // propagate the Agent ActionEvent if START or FAIL
                switch(state) {
                    case START:
                        agentStarted = true;
                        logger.fine("Agent started via web-storage-service. Agent ID was: " + actionEvent.getPayload());
                        getNotifier().fireAction(ApplicationState.START, actionEvent.getPayload());
                        break;
                    case FAIL:
                        console.getError().println(translator.localize(LocaleResources.STARTING_AGENT_FAILED).getContents());
                        getNotifier().fireAction(ApplicationState.FAIL, actionEvent.getPayload());
                        break;
                    default:
                        throw new AssertionError("Unexpected state " + state);
                }
            }
        }
    }

}