org.crsh.plugin.PluginLifeCycle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of crash.shell Show documentation
The Shell module
The newest version!
/*
 * Copyright (C) 2012 eXo Platform SAS.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.crsh.plugin;

import org.crsh.vfs.Resource;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.util.Iterator;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * The base class for managing the CRaSH life cycle.
 */
public abstract class PluginLifeCycle {

  /** . */
  protected final Logger log = Logger.getLogger(getClass().getName());

  /** . */
  private PluginContext context;

  /** . */
  private Properties config;

  public Properties getConfig() {
    return config;
  }

  public void setConfig(Properties config) {
    this.config = config;
  }

  public PluginContext getContext() {
    return context;
  }

  protected final void start(PluginContext context) throws IllegalStateException {
    if (this.context != null) {
      throw new IllegalStateException("Already started");
    }
    
    // Get properties from system properties
    Properties config = new Properties();

    // Load properties from configuration file
    Resource res = context.loadResource("crash.properties", ResourceKind.CONFIG);
    if (res != null) {
      try {
        config.load(new ByteArrayInputStream(res.getContent()));
        log.log(Level.FINE, "Loaded properties from " + config);
      } catch (IOException e) {
        log.log(Level.WARNING, "Could not configure from crash.properties", e);
      }
    } else {
      log.log(Level.FINE, "Could not find crash.properties file");
    }

    // Override default properties from external config
    if (this.config != null) {
      config.putAll(this.config);
    }

    // Override default properties from command line
    for (PropertyDescriptor desc : PropertyDescriptor.ALL.values()) {
      configureProperty(context, config, desc);
    }

    // Override default properties from plugin defined properties.
    for (final CRaSHPlugin plugin : context.manager.getPlugins()) {
      Iterable> capabilities = plugin.getConfigurationCapabilities();
      Iterator> i = capabilities.iterator();
      if (i.hasNext()) {
        while (i.hasNext()) {
          PropertyDescriptor descriptor = i.next();
          log.fine("Adding plugin " + plugin + " property " + descriptor.getName());
          configureProperty(context, config, descriptor);
        }
      } else {
        log.fine("Plugin " + plugin + " does not declare any configuration property");
      }
    }

    //
    context.start();

    //
    this.context = context;
  }

  public final void stop() throws IllegalStateException {
    if (context == null) {
      throw new IllegalStateException("Not started");
    }
    PluginContext context = this.context;
    this.context = null;
    context.stop();
  }

  private void configureProperty(PluginContext context, Properties props, PropertyDescriptor desc) {
    String key = "crash." + desc.name;
    String value = props.getProperty(key);
    if (value != null) {
      try {
        if (context.getProperty(desc) == null) {
          log.log(Level.INFO, "Configuring property " + desc.name + "=" + value + " from properties");
          context.setProperty(desc, value);
        }
      }
      catch (IllegalArgumentException e) {
        log.log(Level.SEVERE, "Could not configure property", e);
      }
    }
  }
}