BaseSetupController.java

/* ==================================================================
 * BaseSetupController.java - Jun 1, 2010 3:08:42 PM
 * 
 * Copyright 2007-2010 SolarNetwork.net Dev Team
 * 
 * This program 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 of 
 * the License, or (at your option) any later version.
 * 
 * This program 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 this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 * 02111-1307 USA
 * ==================================================================
 * $Id$
 * ==================================================================
 */

package net.solarnetwork.node.setup.web;

import org.osgi.framework.BundleContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import net.solarnetwork.node.IdentityService;
import net.solarnetwork.node.setup.SetupService;

/**
 * Base class for setup controllers.
 * 
 * <p>
 * The configurable properties of this class are:
 * </p>
 * 
 * <dl class="class-properties">
 * <dt>setupBiz</dt>
 * <dd>The {@link SetupService} to use for querying/storing application state
 * information.</dd>
 * 
 * <dt>identityService</dt>
 * <dd>The {@link IdentityService} to use for querying identity
 * information.</dd>
 * </dl>
 * 
 * @author matt
 * @version 1.1
 */
public class BaseSetupController {

	protected final Logger log = LoggerFactory.getLogger(getClass());

	@Autowired
	private SetupService setupBiz;

	@Autowired
	private IdentityService identityService;

	@Autowired(required = false)
	private BundleContext bundleContext;

	/**
	 * Shutdown SolarNode in the near future.
	 * 
	 * This can be used during the setup process, when restoring backups for
	 * example. By shutting down we assume some external watchdog process will
	 * bring SolarNode back up, such as {@code systemd} or Monit.
	 * 
	 * @since 1.1
	 */
	protected void shutdownSoon() {
		final BundleContext ctx = bundleContext;
		if ( ctx != null ) {
			new Thread(new Runnable() {

				@Override
				public void run() {
					try {
						Thread.sleep(2000);
					} catch ( Exception e ) {
						// ignore
					}

					final Thread shutdownThread = Thread.currentThread();
					final long start = System.currentTimeMillis();

					// start another thread to monitor the shutdown process, in case OSGi takes too long or gets hung up
					Thread shutdownMonitorThread = new Thread(new Runnable() {

						@Override
						public void run() {
							try {
								shutdownThread.join(8000);
								final long end = (System.currentTimeMillis() - start);
								if ( end < 900 ) {
									Thread.sleep(2000);
								}
							} catch ( Exception e ) {
								// ignore
							} finally {
								System.err.println("Exiting from shutdown request.");
								System.exit(0);
							}
						}
					}, "Backup Restore Shutdown Monitor");
					shutdownMonitorThread.setDaemon(true);
					shutdownMonitorThread.start();

					try {
						log.warn("Stopping OSGi from shutdown request...");
						ctx.getBundle(0).stop(org.osgi.framework.Bundle.STOP_TRANSIENT);
					} catch ( Exception e ) {
						System.err.println("Exception shutting down OSGi: " + e);
					}
				}
			}, "Backup Restore Shutdown").start();
		}
	}

	public SetupService getSetupBiz() {
		return setupBiz;
	}

	public void setSetupBiz(SetupService setupBiz) {
		this.setupBiz = setupBiz;
	}

	public IdentityService getIdentityService() {
		return identityService;
	}

	public void setIdentityService(IdentityService identityService) {
		this.identityService = identityService;
	}

}