org.moskito.control.plugins.PluginRepository Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of moskito-control-plugins Show documentation
The newest version!
package org.moskito.control.plugins;

import org.moskito.control.config.MoskitoControlConfiguration;
import org.moskito.control.config.PluginConfig;
import org.moskito.control.config.PluginsConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

/**
 * Manages and controls plugins at runtime.
 *
 * @author lrosenberg
 * @since 19.03.13 15:47
 */
public final class PluginRepository {

	/**
	 * Logger.
	 */
	private static Logger log = LoggerFactory.getLogger(PluginRepository.class);

	/**
	 * Plugins.
	 */
	private ConcurrentMap plugins = new ConcurrentHashMap<>();

	/**
	 * Cached configs.
	 */
	private ConcurrentMap configs = new ConcurrentHashMap<>();


	/**
	 * Returns plugin repository singleton instance.
	 * @return the instance of this repository.
	 */
	public static PluginRepository getInstance(){
		return PluginRepositoryHolder.instance;
	}

	/**
	 * Private constructor.
	 */
	private PluginRepository(){
	}

	private void setup(){
		PluginsConfig config = MoskitoControlConfiguration.getConfiguration().getPluginsConfig();
		if (config.getPlugins()==null)
			return;
		for (PluginConfig pc : config.getPlugins()){
			log.info("Loading plugin "+pc);
			try {
				MoskitoControlPlugin plugin = MoskitoControlPlugin.class.cast(
						Class.forName(pc.getClassName()).newInstance()
				);
				plugin.setConfigurationName(pc.getConfigurationName());
				addPlugin(pc.getName(), plugin, pc);
			} catch (InstantiationException e) {
				log.warn("Couldn't initialize plugin "+pc, e);
			} catch (IllegalAccessException e) {
				log.warn("Couldn't initialize plugin " + pc, e);
			} catch (ClassNotFoundException e) {
				log.warn("Couldn't initialize plugin " + pc, e);
			}


		}
	}

	/**
	 * Adds a new loaded plugin.
	 * @param name name of the plugin for ui.
	 * @param plugin the plugin instance.
	 * @param config plugin config which was used to load the plugin.
	 */
	public void addPlugin(String name, MoskitoControlPlugin plugin, PluginConfig config){
		plugins.put(name, plugin);
		try{
			plugin.initialize();
			configs.put(name, config);
		}catch(Exception e){
			log.warn("couldn't initialize plugin "+name+" - "+plugin+", removing", e);
			plugins.remove(name);
		}
	}

	/**
	 * Removes a plugin. This call will call deInitialize on the plugin. The plugin is responsible to
	 * free all used resources and un-register itself from listening.
	 * @param name name of the plugin.
	 */
	public void removePlugin(String name){
		configs.remove(name);
		MoskitoControlPlugin plugin = plugins.remove(name);
		if (plugin==null){
			log.warn("Trying to remove not registered plugin "+name);
			return;
		}
		try{
			plugin.deInitialize();
		}catch(Exception e){
			log.warn("Couldn't de-initialize plugin "+name+" - "+plugin,e );
		}
	}

	/**
	 * Returns the names of the active plugins.
	 * @return list of loaded plugins names.
	 */
	public List getPluginNames() {
		ArrayList ret = new ArrayList(plugins.keySet());
		return ret;
	}

	/**
	 * Returns all active plugins.
	 * @return list of loaded plugins.
	 */
	public List getPlugins() {
		ArrayList ret = new ArrayList(plugins.values());
		return ret;
	}

	/**
	 * Returns loaded plugin by name.
	 * @param name name of the plugin.
	 * @return Plugin by name.
	 */
	public MoskitoControlPlugin getPlugin(String name){
		return plugins.get(name);
	}

	/**
	 * Returns pluginconfig for the loaded plugin.
	 * @param name nane of the plugin.
	 * @return PluginConfig for specified plugin.
	 */
	public PluginConfig getConfig(String name){
		return configs.get(name);
	}

	/**
	 * Singletonhelper.
	 */
	private static class PluginRepositoryHolder{
		/**
		 * Instance of the PluginRepository.
		 */
		private static final PluginRepository instance = new PluginRepository();
		static{
			instance.setup();
		}
	}
}