CFG - Vorbelegen von Systemkonfigurationen in der Datenbank

Bei Systemkonfigurationen verhält es sich ähnlich wie bei den I18N Labeln. Zum Zeitpunkt der Programmierung muß man sich die Konfigurations Keys überlegen und üblicherweise Konfigurationsdateien, oder Datenbankeinträge anlegen, um die entsprechende Funktion zu überprüfen. Mein CFG Tool stellt eine statische Funktion zur Verfügung, die das Konfigurationshandling zumindest teilweise automatisch erledigt.

Typischerweise findet man Konfigurationen in XML oder Property Files auf der Festplatte, die dann spätestens zum Test des neuen Konfigurationsparameters editiert werden müssen. ZK unterstützt User Konfigurationen in der ZK.xml Konfigurationsdatei. Im laufenden Betrieb sind sie aber eher unhandlich, da man auf dem Webserver Dateien editieren muss - dennoch haben Konfigurationsdateien in einigen Situationen ihren Sinn. In vielen Fällen jedoch ist eine komfortabel über ein Webinterface editierbare Konfiguration die bessere Wahl.

CFG ist ein Singleton, das die Systemkonfiguration zentral für die Webapplikation verwaltet. Neben der statischen FunktionString CFG.get(String key),die einfach versucht einen Konfigurationsparameter für den Key zu finden, gibt es die FunktionString CFG.get(String key, String defaultValue). Diese sucht zuerst im Config cache, dann in der Datenbank und zuletzt in der zk.xml Konfigurationdatei. Ist der Key dort noch nicht vorhanden, wird der default Wert im Cache und in der Datenbank angelegt. Der Programmierer kann sofort mit den für Test und Inbetriebnahme sinnvollen default Werten arbeiten.

Ein Konfigurations Webfront kann zum editieren der Werte in der Datenbank benutzt werden und muß dann auch den Cache updaten.

CFG.java

package net.empego.zk.util;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.zkoss.zk.ui.Executions;
import org.zkoss.zk.ui.WebApp;
import org.zkoss.zk.ui.util.Configuration;

import net.empego.core.hbm.NodeConfiguration;
import net.empego.core.util.HibUtil;

/**
 * singleton Configuration provider for empego.net webapp config
 * 
 * @author Thomas Mueller - empego.net
 *
 */
public class CFG {
	static final CFG cfg = new CFG();
	Map <String, String> configuration = new HashMap<String, String>();
	
	
	
	/**
	 * @param key
	 * @return the configuration value for key or null when not found
	 */
	public static String get(String key){
		return cfg.configuration.get(key);
	}

	/**
	 * get the configuration value for key or the default value is returned, 
	 * when not found and defaultValue is stored in DB
	 * 
	 * @param key
	 * @param defaultValue
	 * @return the configuration value for key or default value, when not found
	 */
	public static String get(String key, String defaultValue){
		if(cfg.configuration.get(key) == null){
			cfg.configuration.put(key, defaultValue);
			NodeConfiguration preference = new NodeConfiguration(key, defaultValue);
			HibUtil.currentSession().saveOrUpdate(preference);
		}
		return cfg.configuration.get(key);
	}

	/**
	 * set configuration and store new config in DB
	 * @param key
	 * @param value
	 */
	public static void set(String key, String value){
		cfg.configuration.put(key, value);
		
		NodeConfiguration preference = new NodeConfiguration(key, value);
		HibUtil.currentSession().saveOrUpdate(preference);
	}

	
	public static void initCfg(WebApp wapp){
		cfg.loadConfigFromWebappCFG(wapp);
		cfg.loadConfigFromDB();
		cfg.storeConfigInDB();
	}
	
	public static void restoreDefaultCfg(WebApp wapp){
		cfg.loadConfigFromDB();
		cfg.loadConfigFromWebappCFG(wapp);
		cfg.storeConfigInDB();
	}

	
	private void loadConfigFromDB(){
		List <NodeConfiguration> result = (List <NodeConfiguration>)HibUtil
						.currentSession().createQuery("from NodeConfiguration").list();
		
		for (NodeConfiguration nodeCfg : result) {
			configuration.put(nodeCfg.getConfigKey(), nodeCfg.getConfigValue());
		}
	}

	private void loadConfigFromWebappCFG(WebApp wapp){
		Configuration webappCFG = wapp.getConfiguration();
		if(webappCFG == null)
			return;
		
		for(String preferenceName : (Set<String>)webappCFG.getPreferenceNames()){
			if(preferenceName.startsWith("net.empego")){
				configuration.put(preferenceName.split("empego\\.")[1], webappCFG.getPreference(preferenceName, null));
			}
		}
	}
	
	private void storeConfigInDB(){
		for(String key: configuration.keySet()){
			NodeConfiguration preference = (NodeConfiguration)HibUtil.currentSession().get(NodeConfiguration.class, key);
			
			if(preference == null)
				preference = new NodeConfiguration(key, configuration.get(key));
			else
				preference.setConfigValue(configuration.get(key));
			HibUtil.currentSession().saveOrUpdate(preference);
		}
	}

}