"); html.append(msg); html.append("
"); response.getWriter().write(html.toString()); } } easyconf-0.9.5/src/java/com/germinus/easyconf/Conventions.java 100644 0 0 3311 10337163174 21564 0 ustar 0 0 /* * Copyright 2004-2005 Germinus XXI * * Licensed under the Apache License, Version 2.0 (the "License") * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.germinus.easyconf; /** * Conventions used by EasyConf that can be expressed as contansts * @author Jorge Ferrer * @version $Revision: 1.7 $ * */ public interface Conventions { char SELECTOR_START = '['; char SELECTOR_END = ']'; char DOT = '.'; char SLASH = '-'; String INCLUDE_PROPERTY = "include-and-override"; String GLOBAL_CONFIGURATION_FILE = "global-configuration"; String DIGESTERRULES_EXTENSION = ".digesterRules.xml"; String XML_EXTENSION = ".xml"; String PROPERTIES_EXTENSION = ".properties"; String DATASOURCE_PREFIX = "datasource:"; String JNDI_PREFIX = "jndi:"; String RELOAD_DELAY_PROPERTY = "easyconf:reload-delay"; String CONFIGURATION_OBJECTS_SOURCE_PROPERTY = "easyconf:configuration-objects-source"; String CONFIGURATION_OBJECTS_TABLE = "easyconf_configuration_objects"; String PROPERTIES_TABLE = "easyconf_properties"; String COMPANY_ID_PROPERTY = "easyconf:companyId"; String COMPONENT_NAME_PROPERTY = "easyconf:componentName"; String PREFIX_SEPARATOR = ":"; String DEFAULT_CONF_OBJECT_NAME = "DEFAULT_CONF_OBJECT"; } easyconf-0.9.5/src/java/com/germinus/easyconf/semantic.cache 100644 0 0 13715 10337163174 21235 0 ustar 0 0 ;; Object semantic.cache ;; SEMANTICDB Tags save file (semanticdb-project-database "semantic.cache" :file "semantic.cache" :tables (list (semanticdb-table "ConfReader.java" :file "ConfReader.java" :pointmax 11728 :major-mode 'jde-mode :tokens '(("com.germinus.easyconf" package nil nil nil [1 31]) ("java.io.IOException" include nil nil nil [33 60]) ("java.net.URL" include nil nil nil [61 81]) ("java.util.*" include nil nil nil [82 101]) ("org.apache.commons.configuration.PropertiesConfiguration" include nil nil nil [103 167]) ("org.apache.commons.configuration.CompositeConfiguration" include nil nil nil [168 231]) ("org.apache.commons.configuration.Configuration" include nil nil nil [232 286]) ("org.apache.commons.digester.Digester" include nil nil nil [287 331]) ("org.apache.commons.digester.Substitutor" include nil nil nil [332 379]) ("org.apache.commons.digester.substitution.MultiVariableExpander" include nil nil nil [380 450]) ("org.apache.commons.digester.substitution.VariableSubstitutor" include nil nil nil [451 519]) ("org.apache.commons.digester.xmlrules.DigesterLoader" include nil nil nil [520 579]) ("org.apache.commons.logging.Log" include nil nil nil [580 618]) ("org.apache.commons.logging.LogFactory" include nil nil nil [619 664]) ("org.xml.sax.SAXException" include nil nil nil [665 697]) ("ConfReader" type "class" (("OVERRIDEN_PROPERTIES_FILES_PROPERTY" variable "String" nil ((typemodifiers "private" "static" "final")) nil ((reparse-symbol . class_body_declarations)) [4279 4368]) ("instance" variable "ConfReader" nil ((typemodifiers "private" "static" "final")) nil ((reparse-symbol . class_body_declarations)) [4370 4430]) ("log" variable "Log" nil ((typemodifiers "private" "static" "final")) nil ((reparse-symbol . class_body_declarations)) [4435 4502]) ("cache" variable "Map" nil ((typemodifiers "private" "static")) nil ((reparse-symbol . class_body_declarations)) [4507 4548]) ("GLOBAL_CONFIGURATION_FILE" variable "String" nil ((typemodifiers "private" "static" "final")) nil ((reparse-symbol . class_body_declarations)) [4553 4632]) ("ENVIRONMENT_NAME_VARIABLE" variable "String" nil ((typemodifiers "private" "static" "final")) nil ((reparse-symbol . class_body_declarations)) [4637 4713]) ("getInstance" function "ConfReader" nil ((typemodifiers "public" "static")) nil ((reparse-symbol . class_body_declarations)) [4719 4790]) ("ConfReader" function nil nil ((typemodifiers "private")) nil ((reparse-symbol . class_body_declarations)) [4796 4824]) ("getComponentConfiguration" function "ComponentConfiguration" (("componentName" variable "String" nil nil nil ((reparse-symbol . formal_parameter_list)) [5013 5033])) ((typemodifiers "public")) nil ((reparse-symbol . class_body_declarations)) [4957 5625]) ("refreshComponent" function "void" (("componentName" variable "String" nil nil nil ((reparse-symbol . formal_parameter_list)) [6013 6033])) ((typemodifiers "public")) nil ((reparse-symbol . class_body_declarations)) [5984 6304]) ("refreshAll" function "void" nil ((typemodifiers "public")) nil ((reparse-symbol . class_body_declarations)) [6657 6787]) ("getConfiguration" function "Configuration" (("componentName" variable "String" nil nil nil ((reparse-symbol . formal_parameter_list)) [7050 7070])) ((typemodifiers "public")) nil ((reparse-symbol . class_body_declarations)) [7012 7181]) ("readComponentConfiguration" function "ComponentConfiguration" (("componentName" variable "String" nil nil nil ((reparse-symbol . formal_parameter_list)) [7333 7353])) ((typemodifiers "private") (throws "IOException" "SAXException")) nil ((reparse-symbol . class_body_declarations)) [7275 7680]) ("readPropertiesConfiguration" function "Properties" (("componentName" variable "String" nil nil nil ((reparse-symbol . formal_parameter_list)) [7737 7757])) ((typemodifiers "private")) nil ((reparse-symbol . class_body_declarations)) [7690 8342]) ("readPropertiesFromFiles" function "CompositeConfiguration" (("fileNames" variable "List" nil nil nil ((reparse-symbol . formal_parameter_list)) [8404 8418])) ((typemodifiers "private")) nil ((reparse-symbol . class_body_declarations)) [8349 9145]) ("getBaseFileNames" function "List" (("componentName" variable "String" nil nil nil ((reparse-symbol . formal_parameter_list)) [9349 9369])) ((typemodifiers "private")) nil ((reparse-symbol . class_body_declarations)) [9319 9560]) ("getEnvironmentFileNames" function "List" (("componentName" variable "String" nil nil nil ((reparse-symbol . formal_parameter_list)) [9771 9791])) ((typemodifiers "private")) nil ((reparse-symbol . class_body_declarations)) [9734 10121]) ("getFilesWithOverriddenProperties" function "List" (("componentConf" variable "Configuration" nil nil nil ((reparse-symbol . formal_parameter_list)) [10173 10200])) ((typemodifiers "private")) nil ((reparse-symbol . class_body_declarations)) [10127 10284]) ("readObjectGraph" function "Object" (("componentName" variable "String" nil nil nil ((reparse-symbol . formal_parameter_list)) [10321 10342]) ("properties" variable "Properties" nil nil nil ((reparse-symbol . formal_parameter_list)) [10355 10376])) ((typemodifiers "private") (throws "IOException" "SAXException")) nil ((reparse-symbol . class_body_declarations)) [10290 11724])) nil ((typemodifiers "public")) nil nil [4249 11727])) :unmatched-syntax '((close-paren 11726 . 11727) (close-paren 10376 . 10377) (open-paren 10320 . 10321) (close-paren 10200 . 10201) (open-paren 10172 . 10173) (close-paren 9791 . 9792) (open-paren 9770 . 9771) (close-paren 9369 . 9370) (open-paren 9348 . 9349) (close-paren 8418 . 8419) (open-paren 8403 . 8404) (close-paren 7757 . 7758) (open-paren 7736 . 7737) (close-paren 7353 . 7354) (open-paren 7332 . 7333) (close-paren 7070 . 7071) (open-paren 7049 . 7050) (close-paren 6680 . 6681) (open-paren 6679 . 6680) (close-paren 6033 . 6034) (open-paren 6012 . 6013) (close-paren 5033 . 5034) (open-paren 5012 . 5013) (close-paren 4815 . 4816) (open-paren 4814 . 4815) (close-paren 4756 . 4757) (open-paren 4755 . 4756) (open-paren 4273 . 4274)) ) ) ) easyconf-0.9.5/src/java/com/germinus/easyconf/FileURLChangedReloadingStrategy.java 100644 0 0 2260 10337163174 25345 0 ustar 0 0 /* * Copyright 2004-2005 Germinus XXI * * Licensed under the Apache License, Version 2.0 (the "License") * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.germinus.easyconf; import java.net.URL; /** * Detects changes in files specified in a URL * @author Jorge Ferrer * @version $Revision: 1.1 $ * */ public class FileURLChangedReloadingStrategy extends FileConfigurationChangedReloadingStrategy { public FileURLChangedReloadingStrategy(URL url) { setSourceURL(url); } public FileURLChangedReloadingStrategy(URL url, long refreshDelay) { this(url); super.setRefreshDelay(refreshDelay); } public boolean reloadingRequired() { return super.reloadingRequired(); } } easyconf-0.9.5/src/java/com/germinus/easyconf/taglib/PropertyTag.java 100644 0 0 23114 10337163174 23024 0 ustar 0 0 /* * Copyright 2004-2005 Germinus XXI * * Licensed under the Apache License, Version 2.0 (the "License") * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.germinus.easyconf.taglib; import com.germinus.easyconf.EasyConf; import com.germinus.easyconf.ComponentProperties; import com.germinus.easyconf.Filter; import javax.servlet.jsp.tagext.BodyTagSupport; import javax.servlet.jsp.JspException; import org.apache.struts.util.RequestUtils; import org.apache.commons.lang.StringUtils; import java.util.List; import java.util.ArrayList; /** * Read a configuration property and expose it as a page variable and attribute * Examples of use: * * >%@ taglib uri="/WEB-INF/tld/easyconf.tld" prefix="easyconf" %> * * >easyconf:property id="registration_list" * component="registration" * property="registration.list" * type="java.util.List"/> * >logic:iterate id="item" name="registration_list"> * >bean:write name="item"/> >br/> * >/logic:iterate> * * >easyconf:property id="registration_disabled" * component="registration" * property="registration.disabled"/> * >logic:equal name="registration_disabled" value="true"> * The registration is disabled * >/logic:equal> * * @jsp.tag name="property" body-content="empty" tei-class="com.germinus.easyconf.taglib.PropertyTei" */ public class PropertyTag extends BodyTagSupport { private static final long serialVersionUID = 3546082471134573881L; private static final String DEFAULT_TYPE = "java.lang.String"; protected String id = null; protected String component = null; protected String property = null; protected String type = DEFAULT_TYPE; protected String selector1 = ""; protected String selector2 = ""; protected String selector3 = ""; protected String selector4 = ""; protected String selector5 = ""; protected String defaultValue; private static final List EMPTY_LIST = new ArrayList(); public PropertyTag() { super(); release(); } /** * @jsp.attribute required="true" rtexprvalue="true" */ public String getId() { return (this.id); } public void setId(String id) { this.id = id; } /** * @jsp.attribute required="true" rtexprvalue="true" */ public String getComponent() { return component; } public void setComponent(String component) { this.component = component; } /** * @jsp.attribute required="true" rtexprvalue="true" */ public String getProperty() { return (this.property); } public void setProperty(String property) { this.property = property; } /** * @jsp.attribute required="false" rtexprvalue="true" */ public String getType() { if (StringUtils.isEmpty(type)) { type = DEFAULT_TYPE; } return (this.type); } /** * @jsp.attribute required="false" rtexprvalue="true" */ public void setType(String type) { if (StringUtils.isNotEmpty(type)) { this.type = type; } } /** * @jsp.attribute required="false" rtexprvalue="true" */ public String getDefaultValue() { return (this.defaultValue); } /** * Note: currently this is only used if type is String * @param defaultValue */ public void setDefaultValue(String defaultValue) { this.defaultValue = defaultValue; } /** * @jsp.attribute required="false" rtexprvalue="true" */ public String getSelector1() { return selector1; } public void setSelector1(String selector1) { this.selector1 = selector1; } /** * @jsp.attribute required="false" rtexprvalue="true" */ public String getSelector2() { return selector2; } public void setSelector2(String selector2) { this.selector2 = selector2; } /** * @jsp.attribute required="false" rtexprvalue="true" */ public String getSelector3() { return selector3; } public void setSelector3(String selector3) { this.selector3 = selector3; } /** * @jsp.attribute required="false" rtexprvalue="true" */ public String getSelector4() { return selector4; } public void setSelector4(String selector4) { this.selector4 = selector4; } /** * @jsp.attribute required="false" rtexprvalue="true" */ public String getSelector5() { return selector5; } public void setSelector5(String selector5) { this.selector5 = selector5; } private String[] getSelectorArray() { List selectors = new ArrayList(); if (StringUtils.isNotEmpty(selector1)) { selectors.add(selector1); } if (StringUtils.isNotEmpty(selector2)) { selectors.add(selector2); } if (StringUtils.isNotEmpty(selector3)) { selectors.add(selector3); } if (StringUtils.isNotEmpty(selector4)) { selectors.add(selector4); } if (StringUtils.isNotEmpty(selector5)) { selectors.add(selector5); } return (String[]) selectors.toArray(new String[0]); } // .................. Taglib methods .................. /** * Check if we need to evaluate the body of the tag * * @exception javax.servlet.jsp.JspException if a JSP exception has occurred */ public int doStartTag() throws JspException { return (EVAL_BODY_BUFFERED); } /** * Save the body content of this tag (if any), or throw a JspException * if the value was already defined. * * @exception JspException if value was defined by an attribute */ public int doAfterBody() throws JspException { return (SKIP_BODY); } /** * Retrieve the required property and expose it as a scripting variable. * * @exception JspException if a JSP exception has occurred */ public int doEndTag() throws JspException { Object value = null; ComponentProperties conf = EasyConf.getConfiguration(component). getProperties(); value = readProperty(conf); if (value == null) { JspException e = new JspException("The value of the property is null"); RequestUtils.saveException(pageContext, e); throw e; } pageContext.setAttribute(id, value); return (EVAL_PAGE); } private Object readProperty(ComponentProperties conf) throws JspException { Object value; if (getType().equals("java.util.List")) { value = conf.getList(property, getPropertyFilter(), EMPTY_LIST); } else if (getType().equals("java.lang.Integer")) { value = conf.getInteger(property, getPropertyFilter(), new Integer(0)); } else if (getType().equals("java.lang.String[]")) { value = conf.getStringArray(property, getPropertyFilter(), new String[0]); } else if (getType().equals("java.lang.String")) { if (defaultValue != null) { value = conf.getString(property, getPropertyFilter(), defaultValue); } else { value = conf.getString(property, getPropertyFilter()); } } else if (getType().equals("java.lang.Double")) { value = new Double(conf.getDouble(property, getPropertyFilter())); } else if (getType().equals("java.lang.Float")) { value = new Float(conf.getFloat(property, getPropertyFilter())); } else if (getType().equals("java.lang.Byte")) { value = new Byte(conf.getByte(property, getPropertyFilter())); } else if (getType().equals("java.math.BigDecimal")) { value = conf.getBigDecimal(property, getPropertyFilter()); } else if (getType().equals("java.lang.BigInteger")) { value = conf.getBigInteger(property, getPropertyFilter()); } else if (getType().equals("java.lang.Boolean")) { value = new Boolean(conf.getBoolean(property, getPropertyFilter())); } else if (getType().equals("java.lang.Short")) { value = new Short(conf.getShort(property, getPropertyFilter())); } else if (getType().equals("java.lang.Long")) { value = new Long(conf.getLong(property, getPropertyFilter())); } else { JspException e = new JspException("Unsupported type: " +type); RequestUtils.saveException(pageContext, e); throw e; } return value; } private Filter getPropertyFilter() { return Filter.by(getSelectorArray()); } public void release() { super.release(); id = null; component = null; property = null; type = null; defaultValue = null; } } easyconf-0.9.5/src/java/com/germinus/easyconf/taglib/ConfigurationObjectTei.java 100644 0 0 2533 10337163174 25126 0 ustar 0 0 /* * Copyright 2004-2005 Germinus XXI * * Licensed under the Apache License, Version 2.0 (the "License") * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.germinus.easyconf.taglib; import javax.servlet.jsp.tagext.TagData; import javax.servlet.jsp.tagext.TagExtraInfo; import javax.servlet.jsp.tagext.VariableInfo; /** * Used to declare the property value as a JSP scripting variable * * @author jferrer */ public class ConfigurationObjectTei extends TagExtraInfo { /** * Return information about the scripting variables to be created. */ public VariableInfo[] getVariableInfo(TagData data) { String type = (String)data.getAttribute("type"); return new VariableInfo[] { new VariableInfo(data.getAttributeString("id"), type, true, VariableInfo.AT_END ) }; } } easyconf-0.9.5/src/java/com/germinus/easyconf/taglib/PropertyTei.java 100644 0 0 2727 10337163174 23021 0 ustar 0 0 /* * Copyright 2004-2005 Germinus XXI * * Licensed under the Apache License, Version 2.0 (the "License") * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.germinus.easyconf.taglib; import org.apache.commons.lang.StringUtils; import javax.servlet.jsp.tagext.TagExtraInfo; import javax.servlet.jsp.tagext.VariableInfo; import javax.servlet.jsp.tagext.TagData; /** * Used to declare the property value as a JSP scripting variable * * @author jferrer */ public class PropertyTei extends TagExtraInfo { /** * Return information about the scripting variables to be created. */ public VariableInfo[] getVariableInfo(TagData data) { String type = (String)data.getAttribute("type"); if (StringUtils.isEmpty(type)) { type = "java.lang.String"; } return new VariableInfo[] { new VariableInfo(data.getAttributeString("id"), type, true, VariableInfo.AT_END ) }; } } easyconf-0.9.5/src/java/com/germinus/easyconf/taglib/ConfigurationObjectTag.java 100644 0 0 7100 10337163174 25113 0 ustar 0 0 /* * Copyright 2004-2005 Germinus XXI * * Licensed under the Apache License, Version 2.0 (the "License") * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.germinus.easyconf.taglib; import com.germinus.easyconf.EasyConf; import javax.servlet.jsp.tagext.BodyTagSupport; import javax.servlet.jsp.JspException; import org.apache.struts.util.RequestUtils; /** * Read a configuration property and expose it as a page variable and attribute * Examples of use: * * >%@ taglib uri="/WEB-INF/tld/easyconf.tld" prefix="easyconf" %> * * >easyconf:configurationObject id="dbConf" * component="test_module" * type="com.germinus.easyconf.example.DatabaseConf"/> * >bean:write name="dbConf" property="tables"/> * * @jsp.tag name="configurationObject" body-content="empty" * tei-class="com.germinus.easyconf.taglib.ConfigurationObjectTei" */ public class ConfigurationObjectTag extends BodyTagSupport { protected String id = null; protected String component = null; protected String type = "java.lang.Object"; /** * @jsp.attribute required="true" rtexprvalue="true" */ public String getId() { return (this.id); } public void setId(String id) { this.id = id; } /** * @jsp.attribute required="true" rtexprvalue="true" */ public String getComponent() { return component; } public void setComponent(String component) { this.component = component; } /** * @jsp.attribute required="false" rtexprvalue="true" */ public String getType() { return (this.type); } public void setType(String type) { this.type = type; } /** * Check if we need to evaluate the body of the tag * * @exception javax.servlet.jsp.JspException if a JSP exception has occurred */ public int doStartTag() throws JspException { return (EVAL_BODY_BUFFERED); } /** * Save the body content of this tag (if any), or throw a JspException * if the value was already defined. * * @exception JspException if value was defined by an attribute */ public int doAfterBody() throws JspException { return (SKIP_BODY); } /** * Retrieve the required property and expose it as a scripting variable. * * @exception JspException if a JSP exception has occurred */ public int doEndTag() throws JspException { Object confObj = EasyConf.getConfiguration(component). getConfigurationObject(); if (confObj == null) { JspException e = new JspException("The value of the configuration object is null. " + "Check the configuration files"); RequestUtils.saveException(pageContext, e); throw e; } pageContext.setAttribute(id, confObj); return (EVAL_PAGE); } public void release() { super.release(); id = null; component = null; type = null; } } easyconf-0.9.5/src/java/com/germinus/easyconf/XstreamSerializer.java 100644 0 0 1315 10337163174 22736 0 ustar 0 0 /* * Created on 06-nov-2005 * * TODO To change the template for this generated file go to * Window - Preferences - Java - Code Style - Code Templates */ package com.germinus.easyconf; import com.thoughtworks.xstream.XStream; /** * @author jorge * * TODO To change the template for this generated type comment go to * Window - Preferences - Java - Code Style - Code Templates */ public class XstreamSerializer extends ConfigurationSerializer { private static final XStream xstream = new XStream(); public Object deserialize(String serializedConf) { return xstream.fromXML(serializedConf); } public String serialize(Object configurationObject) { return xstream.toXML(configurationObject); } } easyconf-0.9.5/src/java/com/germinus/easyconf/Filter.java 100644 0 0 10312 10337163174 20523 0 ustar 0 0 /* * Copyright 2004-2005 Germinus XXI * * Licensed under the Apache License, Version 2.0 (the "License") * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.germinus.easyconf; import java.util.HashMap; import java.util.Map; /** * Builds filters from arrays of strings or up to three string paramters * * @author jferrer */ public class Filter { private String[] selectors; private Map variables; // ............. Constructors ................ private Filter(String[] selectors) { this.selectors = selectors; } private Filter(Map variables) { this.variables = variables; } // ......... static methods ........... public static Filter by(String first) { return new Filter(new String[]{first}); } public static Filter by(String first, String second) { return new Filter(new String[]{first, second}); } public static Filter by(String first, String second, String third) { return new Filter(new String[]{first, second, third}); } public static Filter by(String[] selectors) { return new Filter(selectors); } public static Filter usingVariables(String var1, String value1) { Map vars = new HashMap(); vars.put(var1, value1); return new Filter(vars); } public static Filter usingVariables(String var1, String value1, String var2, String value2) { Map vars = new HashMap(); vars.put(var1, value1); vars.put(var2, value2); return new Filter(vars); } public static Filter usingVariables(String var1, String value1, String var2, String value2, String var3, String value3) { Map vars = new HashMap(); vars.put(var1, value1); vars.put(var2, value2); vars.put(var3, value3); return new Filter(vars); } public static Filter usingVariables(Map vars) { return new Filter(vars); } // .............. instance methods ................ public boolean hasVariables() { return (variables != null) && (!variables.isEmpty()); } public Filter setVariables(Map newVars) { this.variables = newVars; return this; } public Map getVariables() { return variables; } public String[] getSelectors() { return selectors; } public Filter setSelectors(String[] newSelectors) { this.selectors = newSelectors; return this; } public int numOfSelectors() { if (selectors == null) { return 0; } return selectors.length; } /** * Get a fragment of the filter which includes the first 'n' selectors * concatenated. * * Example: if the filter has two selectors (bar and foo). Fragments would * be: *Configuration interface from Jakarta
* Commons Configuration but it is given a different name which makes more sense
* inside EasyConf.
*
* The boolean flag throwExceptionOnMissing controls the behaviour of this class
* when a property that does not exist is queried. If set to true (the default)
* a NoSuchElementException will be thrown if the given key does not
* exist and no default was provided. If set to false, null will be
* returned except for the method getList() which will return an empty
* unmodifyiable list.
*
* @author Jorge Ferrer
* @version $Revision: 1.23 $
*
*/
public class ComponentProperties {
public static final String NULL_STRING = null;
private static final List EMPTY_LIST = Collections
.unmodifiableList(new ArrayList());
private static final Log log = LogFactory.getLog(ComponentProperties.class);
AggregatedProperties properties;
ComponentProperties(AggregatedProperties conf) {
this.properties = conf;
setThrowExceptionOnMissing(false);
}
// .................. Conversion methods ...................
/**
* Returns a decorator of the configuration that implements the Map
* interface. Note that any changes made to this decorator will be made to
* the original configuration and viceversa.
*
* @return a java.util.Map instance
*/
public Map toMap() {
return ConfigurationConverter.getMap(properties);
}
/**
* Returns a decorator of the configuration that can be used as a DynaBean.
* Note that any changes made to this decorator will be made to the original
* configuration and viceversa.
*
* @return a DynaBean instance
*/
public DynaBean toDynaBean() {
return new ConfigurationDynaBean(properties);
}
/**
* Returns a decorator of the configuration of type
* org.apache.commons.configuration.Configuration Note that any
* changes made to this decorator will be made to the original configuration
* and viceversa.
*
* @return a Configuration instance
*/
public Configuration toConfiguration() {
return properties;
}
/**
* Returns a decorator of the configuration of type
* org.apache.commons.configuration.DataConfiguration. This
* decorator has many extra methods for retrieving typed properties such as
* color, URL, locale, Calendar and lists and array of any of these types.
*
* Note that any changes made to this decorator will be made to the original
* configuration and viceversa.
*
* @return a DataConfiguration instance
*/
public DataConfiguration toDataConfiguration() {
return new DataConfiguration(properties);
}
/**
* Returns a copy of the configuration into a
* java.util.Properties class. Multivalued properties will be
* converted to comma-separated strings. Any changes made to the
* configuration will not be available to the Properties and
* viceversa.
*
* @return a Properties instance
*/
public java.util.Properties getProperties() {
return ConfigurationConverter.getProperties(properties);
}
public Object getProperty(String key) {
return properties.getProperty(key);
}
// ..................... Delegated methods ...............
public boolean containsKey(String key) {
return properties.containsKey(key);
}
public boolean equals(Object obj) {
return properties.equals(obj);
}
public Iterator getKeys() {
return properties.getKeys();
}
public Iterator getKeys(String prefix) {
return properties.getKeys(prefix);
}
public int hashCode() {
return properties.hashCode();
}
public boolean isEmpty() {
return properties.isEmpty();
}
public void setProperty(String key, Object value) {
properties.setProperty(key, value);
}
public Configuration subset(String prefix) {
return properties.subset(prefix);
}
public String toString() {
return properties.toString();
}
// ..................... BigDecimal ......................
public BigDecimal getBigDecimal(String key) {
return properties.getBigDecimal(key);
}
public BigDecimal getBigDecimal(String key, BigDecimal defaultValue) {
return properties.getBigDecimal(key, defaultValue);
}
public BigDecimal getBigDecimal(String key, Filter filter) {
BigDecimal value = getBigDecimal(key, filter, null);
validateValue(key, value);
return value;
}
public BigDecimal getBigDecimal(String key, Filter filter,
BigDecimal defaultValue) {
return (BigDecimal) getPropertyWithFilter(key, filter,
BigDecimal.class, defaultValue);
}
// ..................... BigInteger ......................
public BigInteger getBigInteger(String key) {
return properties.getBigInteger(key);
}
public BigInteger getBigInteger(String key, BigInteger defaultValue) {
return properties.getBigInteger(key, defaultValue);
}
public BigInteger getBigInteger(String key, Filter filter) {
BigInteger value = getBigInteger(key, filter, null);
validateValue(key, value);
return value;
}
public BigInteger getBigInteger(String key, Filter filter,
BigInteger defaultValue) {
return (BigInteger) getPropertyWithFilter(key, filter,
BigInteger.class, defaultValue);
}
// ..................... Boolean ......................
public boolean getBoolean(String key) {
return properties.getBoolean(key);
}
public boolean getBoolean(String key, boolean defaultValue) {
return properties.getBoolean(key, defaultValue);
}
public Boolean getBoolean(String key, Boolean defaultValue)
throws NoClassDefFoundError {
return properties.getBoolean(key, defaultValue);
}
public boolean getBoolean(String key, Filter filter) {
Boolean value = getBoolean(key, filter, null);
validateValue(key, value);
return value.booleanValue();
}
public Boolean getBoolean(String key, Filter filter, Boolean defaultValue)
throws NoClassDefFoundError {
return (Boolean) getPropertyWithFilter(key, filter, Boolean.class,
defaultValue);
}
public boolean getBoolean(String key, Filter filter, boolean defaultValue) {
return getBoolean(key, filter, new Boolean(defaultValue))
.booleanValue();
}
// ..................... Byte ......................
public byte getByte(String key) {
return properties.getByte(key);
}
public byte getByte(String key, byte defaultValue) {
return properties.getByte(key, defaultValue);
}
public Byte getByte(String key, Byte defaultValue) {
return properties.getByte(key, defaultValue);
}
public byte getByte(String key, Filter filter) {
Byte value = getByte(key, filter, null);
validateValue(key, value);
return value.byteValue();
}
public Byte getByte(String key, Filter filter, Byte defaultValue) {
return (Byte) getPropertyWithFilter(key, filter, Byte.class,
defaultValue);
}
public byte getByte(String key, Filter filter, byte defaultValue) {
return getByte(key, filter, new Byte(defaultValue)).byteValue();
}
// ..................... Double ......................
public double getDouble(String key) {
return properties.getDouble(key);
}
public double getDouble(String key, double defaultValue) {
return properties.getDouble(key, defaultValue);
}
public Double getDouble(String key, Double defaultValue) {
return properties.getDouble(key, defaultValue);
}
public double getDouble(String key, Filter filter) {
Double value = getDouble(key, filter, null);
validateValue(key, value);
return value.doubleValue();
}
public Double getDouble(String key, Filter filter, Double defaultValue) {
return (Double) getPropertyWithFilter(key, filter, Double.class,
defaultValue);
}
public double getDouble(String key, Filter filter, double defaultValue) {
return getDouble(key, filter, new Double(defaultValue)).doubleValue();
}
// ..................... Class ......................
/**
* Get the Class representation of the class name specified
* in the given property
*
* @throws ClassNotFoundException
* if the specified class is not found
*/
public Class getClass(String key) throws ClassNotFoundException {
String className = getString(key);
return ClasspathUtil.locateClass(className);
}
/**
* Get the Class representation of the class name specified
* in the given property. Or the defaultValue if no value has
* been given to the property.
*
* @throws ClassNotFoundException
* if a class has been configured but it is not found
*/
public Class getClass(String key, Class defaultValue)
throws ClassNotFoundException {
String defaultStringValue = null;
String className = getString(key, defaultStringValue);
if (className == defaultStringValue) {
return defaultValue;
}
return ClasspathUtil.locateClass(className);
}
/**
* Similar to the previous methods but complementing the property key with
* the given filter
*/
public Class getClass(String key, Filter filter)
throws ClassNotFoundException {
String className = getString(key, filter);
return ClasspathUtil.locateClass(className);
}
/**
* Equivalent to the previous method but giving a default value which will
* be used if no value has been specified in the configurations file
*/
public Class getClass(String key, Filter filter, Class defaultValue)
throws ClassNotFoundException {
String defaultStringValue = null;
String className = getString(key, filter, null);
if (className == defaultStringValue) {
return defaultValue;
}
return ClasspathUtil.locateClass(className);
}
// ..................... Class ......................
/**
* Get an array of Class objects for the class names
* specified in the given property
*
* @throws ClassNotFoundException
* if the any of the configured classes is not found
*/
public Class[] getClassArray(String key) throws ClassNotFoundException {
String[] classNames = getStringArray(key);
return ClasspathUtil.locateClasses(classNames);
}
/**
* Get an array of Class objects for the class names
* specified in the given property. Or the defaultValue if no
* value has been given to the property.
*
* @throws ClassNotFoundException
* if the any of the configured classes is not found
*/
public Class[] getClassArray(String key, Class[] defaultValue)
throws ClassNotFoundException {
String[] defaultStringArrayValue = null;
String[] classNames = getStringArray(key, defaultStringArrayValue);
if (classNames == defaultStringArrayValue) {
return defaultValue;
}
return ClasspathUtil.locateClasses(classNames);
}
/**
* Similar to the previous methods but complementing the property key with
* the given filter
*/
public Class[] getClassArray(String key, Filter filter)
throws ClassNotFoundException {
String[] classNames = getStringArray(key, filter);
return ClasspathUtil.locateClasses(classNames);
}
/**
* Equivalent to the previous method but giving a default value which will
* be used if no value has been specified in the configurations file
*/
public Class[] getClassArray(String key, Filter filter, Class[] defaultValue)
throws ClassNotFoundException {
String[] defaultStringArrayValue = null;
String[] classNames = getStringArray(key, filter,
defaultStringArrayValue);
if (classNames == defaultStringArrayValue) {
return defaultValue;
}
return ClasspathUtil.locateClasses(classNames);
}
// ..................... Float ......................
public float getFloat(String key) {
return properties.getFloat(key);
}
public float getFloat(String key, float defaultValue) {
return properties.getFloat(key, defaultValue);
}
public Float getFloat(String key, Float defaultValue) {
return properties.getFloat(key, defaultValue);
}
public float getFloat(String key, Filter filter) {
Float value = getFloat(key, filter, null);
validateValue(key, value);
return value.floatValue();
}
public Float getFloat(String key, Filter filter, Float defaultValue) {
return (Float) getPropertyWithFilter(key, filter, Float.class,
defaultValue);
}
public float getFloat(String key, Filter filter, float defaultValue) {
return getFloat(key, filter, new Float(defaultValue)).floatValue();
}
// ..................... Integer ......................
public int getInt(String key) {
return properties.getInt(key);
}
public int getInt(String key, int defaultValue) {
return properties.getInt(key, defaultValue);
}
public Integer getInteger(String key, Integer defaultValue) {
return properties.getInteger(key, defaultValue);
}
public int getInt(String key, Filter filter) {
Integer value = getInteger(key, filter, null);
validateValue(key, value);
return value.intValue();
}
public Integer getInteger(String key, Filter filter, Integer defaultValue) {
return (Integer) getPropertyWithFilter(key, filter, Integer.class,
defaultValue);
}
public int getInt(String key, Filter filter, int defaultValue) {
return getInteger(key, filter, new Integer(defaultValue)).intValue();
}
// ..................... List ......................
public List getList(String key) {
return properties.getList(key);
}
public List getList(String key, List defaultValue) {
return properties.getList(key, defaultValue);
}
public List getList(String key, Filter filter) {
List value = (List) getPropertyWithFilter(key, filter, List.class, null);
validateValue(key, value);
if (value == null) {
value = EMPTY_LIST;
}
return value;
}
public List getList(String key, Filter filter, List defaultValue) {
return (List) getPropertyWithFilter(key, filter, List.class,
defaultValue);
}
// ..................... Long ......................
public long getLong(String key) {
return properties.getLong(key);
}
public Long getLong(String key, Long defaultValue) {
return properties.getLong(key, defaultValue);
}
public long getLong(String key, long defaultValue) {
return properties.getLong(key, defaultValue);
}
public long getLong(String key, Filter filter) {
Long value = getLong(key, filter, null);
validateValue(key, value);
return value.longValue();
}
public Long getLong(String key, Filter filter, Long defaultValue) {
return (Long) getPropertyWithFilter(key, filter, Long.class,
defaultValue);
}
public long getLong(String key, Filter filter, long defaultValue) {
return getLong(key, filter, new Long(defaultValue)).longValue();
}
// ..................... Short ......................
public short getShort(String key) {
return properties.getShort(key);
}
public Short getShort(String key, Short defaultValue) {
return properties.getShort(key, defaultValue);
}
public short getShort(String key, short defaultValue) {
return properties.getShort(key, defaultValue);
}
public short getShort(String key, Filter filter) {
Short value = getShort(key, filter, null);
validateValue(key, value);
return value.shortValue();
}
public Short getShort(String key, Filter filter, Short defaultValue) {
return (Short) getPropertyWithFilter(key, filter, Short.class,
defaultValue);
}
public short getShort(String key, Filter filter, short defaultValue) {
return getShort(key, filter, new Short(defaultValue)).shortValue();
}
// ..................... String ......................
/**
* Get the String value of the given key. If it contains a list of values,
* they will be serialized to a comma-separated format (use getList or
* getStringArray if you want separated list items)
*/
public String getString(String key) {
Object value = properties.getProperty(key);
String result;
if (value instanceof List) {
result = listToString((List) value);
} else {
result = properties.getString(key);
}
return result;
// return properties.getString(key);
}
public String getString(String key, String defaultValue) {
return properties.getString(key, defaultValue);
}
public String getString(String key, Filter filter) {
String value = getString(key, filter, null);
validateValue(key, value);
return value;
}
public String getString(String key, Filter filter, String defaultValue) {
return (String) getPropertyWithFilter(key, filter, String.class,
defaultValue);
}
// ..................... StringArray ......................
public String[] getStringArray(String key) {
return properties.getStringArray(key);
}
public String[] getStringArray(String key, Filter filter) {
List value = getList(key, filter);
return (String[]) value.toArray(new String[0]);
}
public String[] getStringArray(String key, Filter filter,
String[] defaultValue) {
List defaultList = null;
if (defaultValue != null) {
defaultList = Arrays.asList(defaultValue);
}
List value = getList(key, filter, defaultList);
if (value == null) { //This should never happen
return null;
} else {
return (String[]) value.toArray(new String[0]);
}
}
public String[] getStringArray(String key, String[] defaultValue) {
List defaultList = null;
if (defaultValue != null) {
defaultList = Arrays.asList(defaultValue);
}
List value = getList(key, defaultList);
if (value == null) {
return null;
} else {
return (String[]) value.toArray(new String[0]);
}
}
// ................. Control methods .....................
public boolean hasBaseConfiguration() {
return properties.hasBaseConfiguration();
}
/**
* Get a list of the sources which have been loaded for this component
*/
public List getLoadedSources() {
return properties.loadedSources();
}
/**
* Set the flag throwExceptionOnMissing. See the class documentation for
* more details.
*/
public void setThrowExceptionOnMissing(boolean throwExceptionOnMissing) {
properties.setThrowExceptionOnMissing(throwExceptionOnMissing);
}
public boolean isThrowExceptionOnMissing() {
return properties.isThrowExceptionOnMissing();
}
/**
* Returned the configured delay period for this component or null if
* reloading is not being performed
*/
public Long getDelayPeriod() {
Long nullLong = null;
return getLong(Conventions.RELOAD_DELAY_PROPERTY, nullLong);
}
public String getComponentName() {
return properties.getComponentName();
}
// ............. Helper methods ......................
protected Object getPropertyWithFilter(String key, Filter filter,
Class theClass, Object defaultValue) {
CompositeConfiguration filteredConf = properties;
Object value = null;
for (int i = filter.numOfSelectors(); (i >= 0) && (value == null); i--) {
MapConfiguration varsConf = null;
if (filter.hasVariables()) {
varsConf = new MapConfiguration(filter.getVariables());
filteredConf = new CompositeConfiguration();
filteredConf.addConfiguration(varsConf);
filteredConf.addConfiguration(properties);
}
value = getTypedPropertyWithDefault(
key + filter.getFilterSuffix(i), theClass, filteredConf,
null);
if (varsConf != null) {
properties.removeConfiguration(varsConf);
}
log.debug("Value for " + key + filter.getFilterSuffix(i) + "="
+ value);
}
if (value == null) {
value = defaultValue;
}
return value;
}
protected static Object getTypedPropertyWithDefault(
String key,
Class theClass,
Configuration properties,
Object defaultValue) {
if (theClass.equals(Float.class)) {
return properties.getFloat(key, (Float) defaultValue);
} else if (theClass.equals(Integer.class)) {
return properties.getInteger(key, (Integer) defaultValue);
} else if (theClass.equals(String.class)) {
return properties.getString(key, (String) defaultValue);
} else if (theClass.equals(Double.class)) {
return properties.getDouble(key, (Double) defaultValue);
} else if (theClass.equals(Long.class)) {
return properties.getLong(key, (Long) defaultValue);
} else if (theClass.equals(Boolean.class)) {
return properties.getBoolean(key, (Boolean) defaultValue);
} else if (theClass.equals(List.class)) {
return properties.getList(key, (List) defaultValue);
} else if (theClass.equals(BigInteger.class)) {
return properties.getBigInteger(key, (BigInteger) defaultValue);
} else if (theClass.equals(BigDecimal.class)) {
return properties.getBigDecimal(key, (BigDecimal) defaultValue);
} else if (theClass.equals(Byte.class)) {
return properties.getByte(key, (Byte) defaultValue);
} else if (theClass.equals(Short.class)) {
return properties.getShort(key, (Short) defaultValue);
}
throw new IllegalArgumentException("Class " + theClass + " is not"
+ "supported for properties");
}
protected void validateValue(String key, Object value) {
if ((value == null) && isThrowExceptionOnMissing()) {
throw new NoSuchElementException("Property with key=" + key
+ " was not found");
}
}
protected String listToString(List list) {
StringBuffer property = new StringBuffer();
Iterator it = list.iterator();
while (it.hasNext()) {
property.append(String.valueOf(it.next()));
if (it.hasNext()) {
property.append(",");
}
}
return property.toString();
}
}
easyconf-0.9.5/src/java/com/germinus/easyconf/ConfigurationObjectCache.java 100644 0 0 5610 10337163174 24145 0 ustar 0 0 /*
* Copyright 2004-2005 Germinus XXI
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.germinus.easyconf;
import java.net.URL;
import org.apache.commons.configuration.reloading.InvariantReloadingStrategy;
import org.apache.commons.configuration.reloading.ReloadingStrategy;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Holds a configuration object and reloads it when necessary
*
* @author Jorge Ferrer
* @version $Revision: 1.4 $
*
*/
public class ConfigurationObjectCache {
Object configurationObject;
ReloadingStrategy reloadingStrategy = new InvariantReloadingStrategy();
Object reloadLock = new Object();
ConfigurationLoader loader = new ConfigurationLoader();
private static final Log log = LogFactory.getLog(ConfigurationObjectCache.class);
private URL confFileUrl;
private ComponentProperties properties;
private String confName;
public ConfigurationObjectCache(Object confObj, URL confFileUrl, ComponentProperties properties, String confName) {
this.configurationObject = confObj;
this.confFileUrl = confFileUrl;
this.properties = properties;
this.confName = confName;
}
public Object getConfigurationObject() {
reload();
return configurationObject;
}
public String getConfName() {
// if (confName == null) {
// try {
// confName = (String) BeanUtils.getSimpleProperty(configurationObject, "id");
// } catch (Exception e) {
// confName = Conventions.DEFAULT_CONF_OBJECT_NAME;
// }
// }
return confName;
}
private void reload() {
if (confFileUrl == null) {
return;
}
synchronized (reloadLock) {
if (reloadingStrategy.reloadingRequired()) {
try {
configurationObject = loader.loadXMLFile(confFileUrl, properties);
reloadingStrategy.reloadingPerformed();
}
catch (Exception e) {
log.error("Error loading " + confFileUrl, e);
}
}
}
}
private ReloadingStrategy getReloadingStrategy() {
return reloadingStrategy;
}
public void setReloadingStrategy(ReloadingStrategy strategy) {
this.reloadingStrategy = strategy;
}
}
easyconf-0.9.5/src/java/com/germinus/easyconf/ConfigurationSerializer.java 100644 0 0 1337 10337163174 24126 0 ustar 0 0 package com.germinus.easyconf;
/**
* Factory class which creates serializer subclasses based on
* availability of external classes in the classpath
*
* @author Jorge Ferrer
*
*/
public abstract class ConfigurationSerializer {
public static ConfigurationSerializer getSerializer() {
return new XstreamSerializer();
}
/**
* Deserialize the configuration object from a String
* @param serializedConf
* @return A configuration object
*/
public abstract Object deserialize(String serializedConf);
/**
* Serialize a configuration object to a String
* @param configurationObject
* @return An string representing the configuration object
*/
public abstract String serialize(Object configurationObject);
}
easyconf-0.9.5/src/java/com/germinus/easyconf/EasyConf.java 100644 0 0 11614 10337163174 21013 0 ustar 0 0 /*
* Copyright 2004-2005 Germinus XXI
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.germinus.easyconf;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Map;
/**
* Main class to obtain the configuration of a software component.
*
* The main method is getConfiguration which must be
* given the name of a component.
*
* @author jferrer@germinus.com
*/
public class EasyConf {
private static final Log log = LogFactory.getLog(EasyConf.class);
private static Map cache = new HashMap();
private EasyConf() {
}
/**
* Get the full configuration of the given component.
*
* The configuration will be cached so that next calls will not need
* to reload the properties or XML files again.
* @param componentName any String which can be used to identified a
* configuration component.
* @return a ComponentConf instance
*/
public static ComponentConfiguration getConfiguration(String componentName) {
try {
ComponentConfiguration componentConf = (ComponentConfiguration)
cache.get(componentName);
if (componentConf == null) {
componentConf = new ComponentConfiguration(componentName);
cache.put(componentName, componentConf);
}
return componentConf;
} catch (ConfigurationException e) {
throw e;
} catch (Exception e) {
throw new ConfigurationException(componentName,
"Error reading the configuration", e);
}
}
/**
* Get the full configuration of the given component, for the given company.
* This method should be used when the application is to be deployed in
* an ASP model where several companies want different configurations for
* the same running applications
*
*
* The configuration will be cached so that next calls will not need
* to reload the properties or XML files again.
* @param companyId the identifier of the company whose specific
* configuration should be read
* @param componentName any String which can be used to identified a
* configuration component.
* @return a ComponentConf instance
*/
public static ComponentConfiguration getConfiguration(String companyId,
String componentName) {
try {
final String cacheKey = companyId + componentName;
ComponentConfiguration componentConf = (ComponentConfiguration)
cache.get(cacheKey);
if (componentConf == null) {
componentConf = new ComponentConfiguration(companyId, componentName);
cache.put(cacheKey, componentConf);
}
return componentConf;
} catch (ConfigurationException e) {
throw e;
} catch (Exception e) {
throw new ConfigurationException(componentName,
"Error reading the configuration for " + companyId, e);
}
}
/**
* Refresh the configuration of the given component
*
* KNOWN BUG: this method does not refresh the properties configuration because the underlying
* library Jakarta Commons Configuration also contains a cache which is not refreshable. This
* issue is scheduled to be solved after version 1.0 of such library.
*/
public static void refreshComponent(String componentName) {
ComponentConfiguration componentConf = (ComponentConfiguration) cache.get(componentName);
if (componentConf != null) {
cache.remove(componentName);
log.info("Refreshed the configuration of component " + componentName);
}
}
/**
* Refresh the configuration of all components
*
* KNOWN BUG: this method does not refresh the properties configuration because the underlying
* library Jakarta Commons Configuration also contains a cache which is not refreshable. This
* issue is scheduled to be solved after version 1.0 of such library.
*/
public static void refreshAll() {
cache = new HashMap();
log.info("Refreshed the configuration of all components");
}
// ************************** Deprecated methods ***************************
}
easyconf-0.9.5/src/java/com/germinus/easyconf/DatasourceURL.java 100644 0 0 7416 10337163174 21746 0 ustar 0 0 /*
* Copyright 2004-2005 Germinus XXI
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.germinus.easyconf;
import javax.naming.InitialContext;
import javax.naming.NameNotFoundException;
import javax.naming.NamingException;
import javax.sql.DataSource;
import org.apache.commons.configuration.DatabaseConfiguration;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Represents the URL to a datasource as specified in a properties file
* @author Jorge Ferrer
*/
public class DatasourceURL {
private static final Log log = LogFactory.getLog(DatasourceURL.class);
private static final String DATASOURCE_PREFIX = Conventions.DATASOURCE_PREFIX;
public static final String CONFIGURATION_OBJECTS_TABLE = Conventions.CONFIGURATION_OBJECTS_TABLE;
public static final String PROPERTIES_TABLE = Conventions.PROPERTIES_TABLE;
private static InitialContext ctx = null;
private String dataSourceName;
private String companyId;
private String componentName;
private String tableName;
public DatasourceURL(String datasourcePath, String companyId,
String componentName, String tableName) {
this.dataSourceName = datasourcePath.substring(DATASOURCE_PREFIX.length());
this.companyId = companyId;
this.componentName = componentName;
this.tableName = tableName;
}
public DataSource getDatasource() {
try {
DataSource ds = null;
String[] dsFinders = {
"java:/comp/env/" + dataSourceName,
dataSourceName,
};
for (int i = 0; i < dsFinders.length; i++) {
try {
ds = (DataSource)getContext().lookup(dsFinders[i]);
break;
} catch (NameNotFoundException e) {
if (log.isDebugEnabled()) {
log.debug("Datasource " + dataSourceName + " not found", e);
}
}
}
if (ds == null) {
throw new ConfigurationException("Cannot find datasource: " + dataSourceName);
}
return ds;
} catch (NamingException e) {
throw new ConfigurationException("Error loading datasource " + dataSourceName);
}
}
private synchronized InitialContext getContext() throws NamingException {
if (ctx == null) {
ctx = new InitialContext();
}
return ctx;
}
protected String getTableName() {
return tableName;
}
protected String getComponentColumnName() {
return "component";
}
protected String getKeyColumnName() {
return "key";
}
protected String getValueColumnName() {
return "value";
}
public static boolean isDatasource(String fileName) {
if (fileName == null) return false;
return fileName.startsWith(DATASOURCE_PREFIX);
}
public DatabaseConfiguration getConfiguration() {
return new DatabaseConfiguration(getDatasource(),
getTableName(),
getComponentColumnName(),
getKeyColumnName(),
getValueColumnName(),
getCompanyComponentValue());
}
private String getCompanyComponentValue() {
if (companyId != null) {
return companyId + ":" + componentName;
} else {
return componentName;
}
}
}
easyconf-0.9.5/src/java/com/germinus/easyconf/ConfUtil.java 100644 0 0 2323 10337163174 21004 0 ustar 0 0 /*
* Copyright 2004-2005 Germinus XXI
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.germinus.easyconf;
import org.apache.commons.configuration.Configuration;
import java.util.Iterator;
/**
* Utility methods
*
* @author jferrer
*/
class ConfUtil {
public static String toString(Configuration configuration) {
Iterator it = configuration.getKeys();
StringBuffer result = new StringBuffer();
result.append("{");
while (it.hasNext()) {
String key = (String) it.next();
result.append(key + "=" + configuration.getProperty(key));
result.append(", ");
}
result.append("}");
return result.toString();
}
}
easyconf-0.9.5/src/java/com/germinus/easyconf/InvalidPropertyException.java 100644 0 0 2521 10337163174 24273 0 ustar 0 0 /*
* Copyright 2004-2005 Germinus XXI
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.germinus.easyconf;
/**
* Thrown when an XML configuration file contains a variable which either
* is not of the form ${variableName} or is not
* defined in any of the properties files associated with its component
*
* @author Jorge Ferrer
* @version $Revision: 1.2 $
*
*/
public class InvalidPropertyException extends ConfigurationException {
public InvalidPropertyException(String componentName, Throwable e) {
super(componentName, e);
}
public String getMessage() {
return super.getMessage() + ". A variable is either malformed or " +
"makes a reference to " +
"a property which is not defined for this component in " +
"any of its configuration files.";
}
}
easyconf-0.9.5/src/java/com/germinus/easyconf/AggregatedProperties.java 100644 0 0 16730 10337163174 23417 0 ustar 0 0 /*
* Copyright 2004-2005 Germinus XXI
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.germinus.easyconf;
import org.apache.commons.configuration.AbstractFileConfiguration;
import org.apache.commons.configuration.CompositeConfiguration;
import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.FileConfiguration;
import org.apache.commons.configuration.JNDIConfiguration;
import org.apache.commons.configuration.PropertiesConfiguration;
import org.apache.commons.configuration.SubsetConfiguration;
import org.apache.commons.configuration.SystemConfiguration;
import org.apache.commons.configuration.reloading.FileChangedReloadingStrategy;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.net.URL;
import java.util.*;
/**
* Provides configuration properties from several sources making distintion
* from:
* invoke method.
*/
public static final String RELOAD_OPERATION_NAME = "reloadConfiguration";
/**
* Name of the newProperty operations. Used when invoking
* invoke method.
*/
public static final String NEW_PROPERTY_OPERATION_NAME = "newProperty";
/**
* Signature of the reloadConfiguration operation. Used when invoking
* invoke method.
*/
public static final String[] RELOAD_OPERATION_SIGNATURE = new String[0];
/**
* Signature of the newProperty operation with one parameter.
* Used when invoking invoke method.
*/
public static final String[] NEW_PROPERTY_OPERATION_SIGNATURE_1 =
new String[] { String.class.toString() };
/**
* Signature of the newProperty operation with two parameters.
* Used when invoking invoke method.
*/
public static final String[] NEW_PROPERTY_OPERATION_SIGNATURE_2 =
new String[] {String.class.toString(), Object.class.toString() };
private static final String NEW_PROPERTY_OPERATION_DESCRIPTION_1 =
"Add new property to the Configuration Component. " +
"The Param is the property name. Must not" +
" exists another property with the same name.";
private static final String NEW_PROPERTY_OPERATION_DESCRIPTION_2 =
NEW_PROPERTY_OPERATION_DESCRIPTION_1 +
" The second param is the initial value of the new property";
private static final String RELOAD_OPERATION_DESCRIPTION =
"Reloads the configuration";
private static final String CONSTRUCTOR_DESCRIPTION_1 =
"Constructs new MBean with the configuration of the named Component";
private String componentName;
private ComponentConfiguration componentConfiguration;
private MBeanAttributeInfo[] attributesInfo;
private Map modifiedProperties;
private Map newPropeties;
private MBeanOperationInfo[] operationInfo;
private MBeanConstructorInfo[] constructorsInfo;
/**
* Create a MBean wraping some loaded ComponentConfiguration
* @param component
*/
public ComponentConfigurationDynamicMBean
(ComponentConfiguration component) {
super();
this.componentName=component.getComponentName();
this.componentConfiguration=component;
init();
}
/**
* Loads and wraps a ComponentConfiguration
* @param componentName
*/
public ComponentConfigurationDynamicMBean(String componentName) {
super();
this.componentName = componentName;
this.componentConfiguration = EasyConf.getConfiguration(componentName);
init();
}
/**
* Some initializations common to both constructors
*/
private void init(){
this.modifiedProperties = new HashMap();
this.newPropeties = new HashMap();
}
/**
* Obtains the component attributes from the ComponentCongiguration
*
* @see javax.management.DynamicMBean#getAttribute(java.lang.String)
*/
public Object getAttribute(String attributeName)
throws AttributeNotFoundException, MBeanException,
ReflectionException {
ComponentProperties prop = componentConfiguration.getProperties();
if (modifiedProperties.containsKey(attributeName))
return modifiedProperties.get(attributeName);
if (prop.containsKey(attributeName))
return prop.getProperty(attributeName);
else if (newPropeties.containsKey(attributeName))
return newPropeties.get(attributeName);
else
throw new AttributeNotFoundException(attributeName);
}
/**
* Sets an attribute
*
* @see javax.management.DynamicMBean#setAttribute(javax.management.Attribute)
*/
public void setAttribute(Attribute attribute)
throws AttributeNotFoundException, InvalidAttributeValueException,
MBeanException, ReflectionException {
if (componentConfiguration.getProperties().containsKey(
attribute.getName()))
modifiedProperties.put(attribute.getName(), attribute.getValue());
else if (newPropeties.containsKey(attribute.getName()))
newPropeties.put(attribute.getName(), attribute.getValue());
else
throw new AttributeNotFoundException(attribute.getName());
}
/**
* List named attributes
*
* @see javax.management.DynamicMBean#getAttributes(java.lang.String[])
*/
public AttributeList getAttributes(String[] attributesNames) {
Set includedAttributeNames = new HashSet();
AttributeList attributeList = new AttributeList();
for (int i = 0; i < attributesNames.length; i++) {
String attributeName = attributesNames[i];
if (!includedAttributeNames.contains(attributeName)) {
includedAttributeNames.add(attributeName);
try {
Object value = getAttribute(attributeName);
Attribute attribute = new Attribute(attributeName, value);
attributeList.add(attribute);
} catch (AttributeNotFoundException e) {
// Ignoring attribute
} catch (MBeanException e) {
} catch (ReflectionException e) {
}
}
}
return attributeList;
}
/**
* Set named attributes
*
* @see javax.management.DynamicMBean#setAttributes(javax.management.AttributeList)
*/
public AttributeList setAttributes(AttributeList attributes) {
AttributeList modifieds = new AttributeList();
Iterator it = attributes.iterator();
while (it.hasNext()) {
Attribute attribute = (Attribute) it.next();
try {
setAttribute(attribute);
modifieds.add(attribute);
} catch (AttributeNotFoundException e) {
} catch (InvalidAttributeValueException e) {
} catch (MBeanException e) {
} catch (ReflectionException e) {
}
}
return modifieds;
}
/**
* Invoke one of the operations exposed by the MBeanas.
* This Operations could be one of:
* void newProperty(String propertyName)void newProperty(String propertyName, String initialValue)
*
* void reloadConfiguration()Class instance
*/
public static Class locateClass(String name) throws ClassNotFoundException {
Class foundClass = null;
if (foundClass == null) {
ClassLoader loader = Thread.currentThread().getContextClassLoader();
try {
foundClass = loader.loadClass(name);
log.debug("Class loaded from the context classpath (" + name + ")");
} catch (ClassNotFoundException ignore) {
}
}
if (foundClass == null) {
try {
foundClass = ClassLoader.getSystemClassLoader().loadClass(name);
log.debug("Class loaded from the system classpath (" + name + ")");
} catch (ClassNotFoundException ignore) {
}
}
if (foundClass == null) {
throw new ClassNotFoundException("Class " + name + " was not found " +
"in context classpath nor system classpath");
}
return foundClass;
}
/**
* Return an array of Class objects for each of the class names specified. Each
* class will be searched for using the locateClass method.
* If any of the class names does not exist a ClassNotFoundException
* will be thrown
*
* @param classNames the names of the classes to load
*
* @return the Class[] array
*/
public static Class[] locateClasses(String[] classNames) throws ClassNotFoundException {
Class[] classes = new Class[classNames.length];
for (int i = 0; i < classes.length; i++) {
classes[i] = locateClass(classNames[i]);
}
return classes;
}
/**
* Return the location of the specified resource by searching the user home
* directory, the current classpath and the system classpath.
*
* @param base the base path of the resource
* @param name the name of the resource
*
* @return the location of the resource or null if it has not
* been found
*/
public static URL locateResource(String base, String name) {
return ConfigurationUtils.locate(base, name);
}
/**
* Return the location of the specified resource by searching the user home
* directory, the current classpath and the system classpath.
*
* @param name the name of the resource
*
* @return the location of the resource or null if it has not
* been found
*/
public static URL locateResource(String name) {
return ConfigurationUtils.locate(null, name);
}
}
easyconf-0.9.5/src/java/overview.html 100644 0 0 30020 10337163174 14747 0 ustar 0 0
getConfiguration
which must be
given the name of a component. The name of the component can be any String
which can be used to identify it within easyconf.
ComponentConfiguration conf = ConfReader.getConfiguration("my-component");
The result is an object with the configuration of the given
component. The component configuration contains a properties based configuration
and a XML based configuration. Let's start with the first one. Note that we'll asume from
now on that we'll be working with the configuration of a component called
my-component.
ComponentConfiguration
you can just read the property values which are automatically converted to
integers, booleans, lists, etc. Following are two examples of how to read typed
properties:
List portlets = conf.getProperties().getList("static.portlets");
boolean disable = conf.getProperties().getBoolean("registration.disable");
On the other hand the XML configuration can be converted to any object
by filling a digester rules file. The XML configuration of the previous example
will be read from a file named my-component.xml and its digester
rules from my-component.digesterRules.xml. The XML parsing converts
the configuration to a set of user defined object classes. For example
imagine that we want to configure some databases specifying it's tables and
types of tables. We define two classes: DatabaseConf and
Table. Then we write the XML configuration in
my-component.xml, for example:
<database>
<tables>
<table tableType="type1"/>
</tables>
</database>
Next we write the Digester rules in my-component.digesterRules.xml:
<!DOCTYPE digester-rules PUBLIC
"-//Jakarta Apache //DTD digester-rules XML V1.0//EN"
"digester-rules.dtd">
<digester-rules>
<pattern value="database">
<object-create-rule classname="com.foo.bar.DatabaseConf"/>
<pattern value="tables/table">
<object-create-rule classname="com.foo.bar.Table"/>
<set-properties-rule/>
<set-next-rule methodname="addTable" paramtype="com.foo.bar.Table"/>
</pattern>
</pattern>
</digester-rules>
Finally, just one line of code is necesary to obtain the objects which
have resulted from parsing the configuration. Easyconf calls the result an
object graph because it returns one object which can contain other objects
inside, which can contain even more objects, etc. Here is an example of code
of retrieving and using the object graph of the previous XML configuration:
DatabaseConf dbconf = (DatabaseConf) conf.getConfigurationObject();
Table firstTable = dbconf.getTables().get(0);
String tableType = firstTable.getTableType();
For more information about how to write the rules files check the digester xml rules documentation A variant of this example is using properties from the properties based configuration in the XML file. For example:
<database>
<tables>
<table tableType="${table.type1}"/>
</tables>
</database>
Where table.type1 is defined in a properties file as:
table.type1=type1This allows to change this value for different environments.
In a next section is a more detailed description of a component configurations.
<%@ taglib uri="/WEB-INF/tld/easyconf.tld" prefix="easyconf" %>
<easyconf:property id="static_portlets"
component="xpression-ui"
property="static.portlets"
type="java.util.List"/>
<logic:iterate id="item" name="static_portlets">
<bean:write name="item"/>
</logic:iterate>
<easyconf:property id="registration_disabled"
component="my-component"
property="registration.disabled"/>
<logic:equal name="registration_disabled" value="true">
<bean:message key="registration.disabled"/>
</logic:equal>
Los valores soportados en el parametro type son: java.util.List, java.lang.Integer , java.lang.String
java.lang.Double, java.lang.Float, java.lang.Byte
java.math.BigDecimal, java.lang.BigInteger, java.lang.Boolean
java.lang.Short y java.lang.Long.
ComponentConfiguration which is
composed of:
ComponentProperties
object from serveral 'properties' files.
${componentName}.xml: Contains the specific XML with the
configuration of the component.
${componentName}.digesterRules.xml: Contains the rules which
the parser should use to convert the XML file to objects
${variableName}.
For example, the following XML fragment can be used:
<welcome-msg>
Bienvenido a ${server.name}
</welcome-msg>
server.name as explained next.
include-and-override. This property is multivaluated
so that several files can be included. In case of collision of values among the
included files the ones specified last will override the previous ones.
A usual pattern is to include the following properties in
global-configuration.properties:
include-and-override=global-configuration-env.properties
include-and-override=global-configuration-prj.properties
java ......... -Dinstallation-dir=/opt/application
readme.file.path=${installation-dir}/README
java ......... -Dconfiguration-environment=production
global-configuration.properties you can set the following
property:
include-and-override=global-configuration-${configuration-environment}.properties
global-configuration-production.properties. Using this pattern
you can have an application EAR, WAR or JAR which contains the configuration
for all the environments and then set a system property when running the
application to select which configuration should be used.
As usual, the referenced files that do not exist they will be silently ignored.
If the JVM property is not defined no file will be loaded.
long-property=5
boolean-poroperty=true
List. For example:
valid-values=one,two,three,four
Important:
if the value of a property contains a comma but you do not want
it converted to a list the comma should be scaped with a double
slash. For example:
a-property=Once upon a time\\, there was a princess...
database-type=oracle
sql-file=insert-${database-type}.sql
ComponentConfiguration which is
composed of:
ComponentProperties
object from serveral 'properties' files.
${componentName}.xml: Contains the specific XML with the
configuration of the component.
${componentName}.digesterRules.xml: Contains the rules which
the parser should use to convert the XML file to objects
${variableName}<