Examples of org.apache.commons.configuration.SubnodeConfiguration

Package org.apache.commons.configuration

Examples of org.apache.commons.configuration.SubnodeConfiguration

org.apache.commons.configuration.SubnodeConfiguration
A specialized hierarchical configuration class that wraps a single node of its parent configuration.

Configurations of this type are initialized with a parent configuration and a configuration node of this configuration. This node becomes the root node of the subnode configuration. All property accessor methods are evaluated relative to this root node. A good use case for a SubnodeConfiguration is when multiple properties from a specific sub tree of the whole configuration need to be accessed. Then a SubnodeConfiguration can be created with the parent node of the affected sub tree as root node. This allows for simpler property keys and is also more efficient.

A subnode configuration and its parent configuration operate on the same hierarchy of configuration nodes. So if modifications are performed at the subnode configuration, these changes are immideately visible in the parent configuration. Analogously will updates of the parent configuration affect the subnode configuration if the sub tree spanned by the subnode configuration's root node is involved.

There are however changes at the parent configuration, which cause the subnode configuration to become detached. An example for such a change is a reload operation of a file-based configuration, which replaces all nodes of the parent configuration. The subnode configuration per default still references the old nodes. Another example are list structures: a subnode configuration can be created to point on the ith element of the list. Now list elements can be added or removed, so that the list elements' indices change. In such a scenario the subnode configuration would always point to the same list element, regardless of its current index.

To solve these problems and make a subnode configuration aware of such structural changes of its parent, it is possible to associate a subnode configuration with a configuration key. This can be done by calling the setSubnodeKey() method. If here a key is set, the subnode configuration will evaluate it on each access, thus ensuring that it is always in sync with its parent. In this mode the subnode configuration really behaves like a live-view on its parent. The price for this is a decreased performance because now an additional evaluation has to be performed on each property access. So this mode should only be used if necessary; if for instance a subnode configuration is only used for a temporary convenient access to a complex configuration, there is no need to make it aware for structural changes of its parent. If a subnode configuration is created using the {@link HierarchicalConfiguration#configurationAt(String,boolean) configurationAt()} method of HierarchicalConfiguration (which should be the preferred way), with an additional boolean parameter it can be specified whether the resulting subnode configuration should be aware of structural changes or not. Then the configuration key will be automatically set.

Note: At the moment support for creating a subnode configuration that is aware of structural changes of its parent from another subnode configuration (a "sub subnode configuration") is limited. This only works if
1. the subnode configuration that serves as the parent for the new subnode configuration is itself associated with a configuration key and
2. the key passed in to create the new subnode configuration is not too complex (if configuration keys are used that contain indices, a corresponding key that is valid from the parent configuration's point of view cannot be constructed).
When a subnode configuration is created, it inherits the settings of its parent configuration, e.g. some flags like the throwExceptionOnMissing flag or the settings for handling list delimiters) or the expression engine. If these settings are changed later in either the subnode or the parent configuration, the changes are not visible for each other. So you could create a subnode configuration, change its expression engine without affecting the parent configuration.

From its purpose this class is quite similar to {@link SubsetConfiguration}. The difference is that a subset configuration of a hierarchical configuration may combine multiple configuration nodes from different sub trees of the configuration, while all nodes in a subnode configuration belong to the same sub tree. If an application can live with this limitation, it is recommended to use this class instead of SubsetConfiguration because creating a subset configuration is more expensive than creating a subnode configuration.
@since 1.3 @author Oliver Heger @version $Id: SubnodeConfiguration.java 531254 2007-04-22 18:54:57Z oheger $

     * Tests whether manipulations of a subnode configuration trigger correct
     * events.
     */
    public void testSubnodeChangedEvent()
    {
        SubnodeConfiguration sub = ((HierarchicalConfiguration) config)
                .configurationAt(EXIST_PROPERTY);
        sub.addProperty("newProp", "newValue");
        checkSubnodeEvent(l
                .nextEvent(HierarchicalConfiguration.EVENT_SUBNODE_CHANGED),
                true);
        checkSubnodeEvent(l
                .nextEvent(HierarchicalConfiguration.EVENT_SUBNODE_CHANGED),

View Full Code Here

        Properties parameters = new Properties();


        List params = config.configurationsAt(PARAM_ELEMENT);
        for(Iterator it = params.iterator(); it.hasNext();) {
            // HierarchicalConfiguration sub = (HierarchicalConfiguration)it.next();
            SubnodeConfiguration sub = (SubnodeConfiguration)it.next();


            String name = null;
            String value = null;
            // String name = sub.getString("@" + NAME_ATTRIBUTE);
            // String value = sub.getString("@" + VALUE_ATTRIBUTE);
            List nameAtts = sub.getRootNode().getAttributes(NAME_ATTRIBUTE);
            List valueAtts = sub.getRootNode().getAttributes(VALUE_ATTRIBUTE);
            if (nameAtts != null && nameAtts.size() > 0) {
                ConfigurationNode nameAttNode = (ConfigurationNode)nameAtts.get(0);
                name = (String)nameAttNode.getValue();
            }
            if (valueAtts != null && valueAtts.size() > 0) {

View Full Code Here

     * @throws ConfigurationException if the attribute is not found
     */
    protected String getAttribute(HierarchicalConfiguration config, String name)
            throws ConfigurationException {
        // String attribute = config.getString("@" + name);
        SubnodeConfiguration xmlconfig = (SubnodeConfiguration)config;
        ConfigurationNode rootNode = xmlconfig.getRootNode();
        String rootNodeName = rootNode.getName();
        List atts = rootNode.getAttributes(name);
        String attribute = null;
        // Object obj = config.getProperty(name);
        if (atts != null && atts.size() > 0) {

View Full Code Here

        else
        {
            Iterator iter = list.iterator();
            while (iter.hasNext())
            {
                SubnodeConfiguration config = (SubnodeConfiguration) iter.next();
                if (config.getRootNode().equals(node))
                {
                    return new XMLBeanDeclaration(config, node);
                }
            }
            throw new ConfigurationRuntimeException("Unable to match node for " + node.getName());

View Full Code Here


        final boolean highAvailabilityMode = context.getProperties().getBoolean(Tokens.REXSTER_GRAPH_HA, false);


        // get the <properties> section of the xml configuration
        final HierarchicalConfiguration graphSectionConfig = (HierarchicalConfiguration) context.getProperties();
        SubnodeConfiguration neo4jSpecificConfiguration;


        try {
            neo4jSpecificConfiguration = graphSectionConfig.configurationAt(Tokens.REXSTER_GRAPH_PROPERTIES);
        } catch (IllegalArgumentException iae) {
            throw new GraphConfigurationException("Check graph configuration. Missing or empty configuration element: " + Tokens.REXSTER_GRAPH_PROPERTIES);
        }


        try {


            // properties to initialize the neo4j instance.
            final HashMap<String, String> neo4jProperties = new HashMap<String, String>();


            // read the properties from the xml file and convert them to properties
            // to be injected into neo4j.
            final Iterator<String> neo4jSpecificConfigurationKeys = neo4jSpecificConfiguration.getKeys();
            while (neo4jSpecificConfigurationKeys.hasNext()) {
                String key = neo4jSpecificConfigurationKeys.next();


                // replace the ".." put in play by apache commons configuration.  that's expected behavior
                // due to parsing key names to xml.
                neo4jProperties.put(key.replace("..", "."), neo4jSpecificConfiguration.getString(key));
            }


            if (highAvailabilityMode) {
                if (!neo4jProperties.containsKey("ha.machine_id")) {
                    throw new GraphConfigurationException("Check graph configuration. Neo4j HA requires [ha.machine_id] in the <properties> of the configuration");

View Full Code Here

      Class en = PropertiesConfigurationHelper.CONFIGURATION_SECTIONS.get(section);
      if (en==null){
        Logger.warn(section  + " is not a valid configuration section, it will be skipped!");
        continue;
      }
      SubnodeConfiguration subConf=c.getSection(section);
      Iterator<String> it = subConf.getKeys();
      while (it.hasNext()){
        String key = (it.next()); 
        Object value =subConf.getString(key);
        key=key.replace(doubleDot, dot);//bug on the Apache library: if the key contain a dot, it will be doubled!
        try {
          Logger.info("Setting "+value+ " to "+key);
          PropertiesConfigurationHelper.setByKey(en, key, value);
        } catch (Exception e) {

View Full Code Here

          + Tokens.REXSTER_GRAPH_LOCATION);
    }


    // get the <properties> section of the xml configuration
    final HierarchicalConfiguration graphSectionConfig = (HierarchicalConfiguration) context.getProperties();
    SubnodeConfiguration orientDbSpecificConfiguration;


    try {
      orientDbSpecificConfiguration = graphSectionConfig.configurationAt(Tokens.REXSTER_GRAPH_PROPERTIES);
    } catch (IllegalArgumentException iae) {
      throw new GraphConfigurationException("Check graph configuration. Missing or empty configuration element: "
          + Tokens.REXSTER_GRAPH_PROPERTIES);
    }


    try {


      final String username = orientDbSpecificConfiguration.getString("username", "");
      final String password = orientDbSpecificConfiguration.getString("password", "");


      // Caching must be turned off. OrientDB has different layers of cache:
      // http://code.google.com/p/orient/wiki/Caching There's one Level1 cache per OGraphDatabase instance
      // and one level2 per JVM. If a OGraphDatabase caches a vertex and then you change it in
      // another thread/transaction you could see the older one. To fix it just disable the Level1 cache.

View Full Code Here

        {
            throw new IllegalArgumentException(
                    "Configuration must not be null!");
        }


        SubnodeConfiguration tmpconfiguration = null;
        ConfigurationNode tmpnode = null;
        try
        {
            tmpconfiguration = config.configurationAt(key);
            tmpnode = tmpconfiguration.getRootNode();
        }
        catch (IllegalArgumentException iex)
        {
            // If we reach this block, the key does not have exactly one value
            if (!optional || config.getMaxIndex(key) > 0)

View Full Code Here

        else
        {
            Iterator<HierarchicalConfiguration> iter = list.iterator();
            while (iter.hasNext())
            {
                SubnodeConfiguration config = (SubnodeConfiguration) iter.next();
                if (config.getRootNode().equals(node))
                {
                    return new XMLBeanDeclaration(config, node);
                }
            }
            throw new ConfigurationRuntimeException("Unable to match node for " + node.getName());

View Full Code Here

     * events.
     */
    @Test
    public void testSubnodeChangedEvent()
    {
        SubnodeConfiguration sub = ((HierarchicalConfiguration) config)
                .configurationAt(EXIST_PROPERTY);
        sub.addProperty("newProp", "newValue");
        checkSubnodeEvent(l
                .nextEvent(HierarchicalConfiguration.EVENT_SUBNODE_CHANGED),
                true);
        checkSubnodeEvent(l
                .nextEvent(HierarchicalConfiguration.EVENT_SUBNODE_CHANGED),

View Full Code Here

0 1

TOP

Related Classes of org.apache.commons.configuration.SubnodeConfiguration

be.datablend.blueprints.impls.mongodb.util.MongoDBGraphConfiguration

cgl.shindig.config.ConfigurationParser

com.baasbox.db.DbHelper

com.tinkerpop.blueprints.impls.neo4j2.rexster.Neo4j2GraphConfiguration

com.tinkerpop.blueprints.impls.oraclekv.util.KVGraphConfiguration

com.tinkerpop.rexster.config.AbstractSailGraphConfiguration

com.tinkerpop.rexster.config.IdGraphConfiguration

com.tinkerpop.rexster.config.Neo4jGraphConfiguration

com.tinkerpop.rexster.config.SparkseeGraphConfiguration

com.tinkerpop.rexster.OrientGraphConfiguration

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.