Examples of org.apache.commons.configuration.HierarchicalConfiguration

Package org.apache.commons.configuration

Examples of org.apache.commons.configuration.HierarchicalConfiguration

org.apache.commons.configuration.HierarchicalConfiguration
A specialized configuration class that extends its base class by the ability of keeping more structure in the stored properties.
There are some sources of configuration data that cannot be stored very well in a BaseConfiguration object because then their structure is lost. This is especially true for XML documents. This class can deal with such structured configuration sources by storing the properties in a tree-like organization.
The internal used storage form allows for a more sophisticated access to single properties. As an example consider the following XML document:
```
 <database> <tables> <table> <name>users</name> <fields> <field> <name>lid</name> <type>long</name> </field> <field> <name>usrName</name> <type>java.lang.String</type> </field> ... </fields> </table> <table> <name>documents</name> <fields> <field> <name>docid</name> <type>long</type> </field> ... </fields> </table> ... </tables> </database> 
```
If this document is parsed and stored in a HierarchicalConfiguration object (which can be done by one of the sub classes), there are enhanced possibilities of accessing properties. The keys for querying information can contain indices that select a certain element if there are multiple hits.
For instance the key tables.table(0).name can be used to find out the name of the first table. In opposite tables.table.name would return a collection with the names of all available tables. Similarly the key tables.table(1).fields.field.name returns a collection with the names of all fields of the second table. If another index is added after the field element, a single field can be accessed: tables.table(1).fields.field(0).name.
There is a getMaxIndex() method that returns the maximum allowed index that can be added to a given property key. This method can be used to iterate over all values defined for a certain property.

Since the 1.3 release of Commons Configuration hierarchical configurations support an expression engine. This expression engine is responsible for evaluating the passed in configuration keys and map them to the stored properties. The examples above are valid for the default expression engine, which is used when a new HierarchicalConfiguration instance is created. With the setExpressionEngine() method a different expression engine can be set. For instance with {@link org.apache.commons.configuration.tree.xpath.XPathExpressionEngine} there is an expression engine available that supports configuration keys in XPATH syntax.

In addition to the events common for all configuration classes hierarchical configurations support some more events that correspond to some specific methods and features:
EVENT_ADD_NODES
The addNodes() method was called; the event object contains the key, to which the nodes were added, and a collection with the new nodes as value.

EVENT_CLEAR_TREE
The clearTree() method was called; the event object stores the key of the removed sub tree.

EVENT_SUBNODE_CHANGED
A SubnodeConfiguration that was created from this configuration has been changed. The value property of the event object contains the original event object as it was sent by the subnode configuration.

Note:Configuration objects of this type can be read concurrently by multiple threads. However if one of these threads modifies the object, synchronization has to be performed manually.
@author Oliver Heger @version $Id: HierarchicalConfiguration.java 722238 2008-12-01 21:28:31Z oheger $

        {
            throw new ConfigurationException("Only one external virtualhosts configuration file allowed, multiple filenames found.");
        }


        // Virtualhost configuration object
        Configuration vhostConfiguration = new HierarchicalConfiguration();


        // Load from embedded configuration if possible
        if (!vhostConfig.subset("virtualhost").isEmpty())
        {
            vhostConfiguration = vhostConfig;
        }
        else
        {
        // Load from the external configuration if possible
        for (String fileName : vhostFiles)
          {
              // Open the vhosts XML file and copy values from it to our config
                _vhostsFile = new File(fileName);
                if (!_vhostsFile.exists())
                {
                    throw new ConfigurationException("Virtualhosts file does not exist");
                }
            vhostConfiguration = parseConfig(new File(fileName));


                // save the default virtualhost name
                String defaultVirtualHost = vhostConfiguration.getString("default");
                _configuration.setProperty("virtualhosts.default", defaultVirtualHost);
            }
        }


        // Now extract the virtual host names from the configuration object
        List hosts = vhostConfiguration.getList("virtualhost.name");
        for (int j = 0; j < hosts.size(); j++)
        {
            String name = (String) hosts.get(j);


            // Add the virtual hosts to the server configuration
            VirtualHostConfiguration virtualhost = new VirtualHostConfiguration(name, vhostConfiguration.subset("virtualhost." + name));
            _virtualHosts.put(virtualhost.getName(), virtualhost);
        }
    }

View Full Code Here

    }


    public PortalConfig parsePortalConfig(InputStream xml)
            throws ConfigurationException {
        // HierarchicalConfiguration root = parseXML(xml, true);
        HierarchicalConfiguration root = parseXML(xml, false);


        // Security configuration and access manager implementation
        HierarchicalConfiguration security = getSubConfig(root, SECURITY_ELEMENT);
        SecurityConfig securityConfig = parseSecurityConfig(security);


        return new PortalConfig(securityConfig, this);
    }

View Full Code Here

    }


    public SecurityManagerConfig parseSecurityManagerConfig(HierarchicalConfiguration security)
            throws ConfigurationException {
        // Optional security manager config entry
        HierarchicalConfiguration smElement = getSubConfig(security, SECURITY_MANAGER_ELEMENT, false);
        if (smElement != null) {
            BeanConfig bc = parseBeanConfig(smElement);


            BeanConfig umc = null;
            HierarchicalConfiguration element = getSubConfig(smElement, USER_MANAGER_ELEMENT, false);
            if (element != null) {
                umc = parseBeanConfig(smElement, USER_MANAGER_ELEMENT);
            }
            return new SecurityManagerConfig(bc, umc);
        } else {

View Full Code Here

    }


    public AccessManagerConfig parseAccessManagerConfig(HierarchicalConfiguration security)
            throws ConfigurationException {
        // Optional access manager config entry
        HierarchicalConfiguration accessMgr = getSubConfig(security, ACCESS_MANAGER_ELEMENT, false);
        if (accessMgr != null) {
            return new AccessManagerConfig(parseBeanConfig(accessMgr));
        } else {
            return null;
        }

View Full Code Here

    }


    public LoginModuleConfig parseLoginModuleConfig(HierarchicalConfiguration security)
            throws ConfigurationException {
        // Optional login module
        HierarchicalConfiguration loginModule = getSubConfig(security, LOGIN_MODULE_ELEMENT, false);


        if (loginModule != null) {
            return new LoginModuleConfig(parseBeanConfig(security, LOGIN_MODULE_ELEMENT));
        } else {
            return null;

View Full Code Here

    }


    protected BeanConfig parseBeanConfig(HierarchicalConfiguration parent, String name)
            throws ConfigurationException {
        // Bean configuration element
        HierarchicalConfiguration config = getSubConfig(parent, name);


        // Bean implementation class
        String className = getAttribute(config, CLASS_ATTRIBUTE);


        // Bean properties

View Full Code Here

        {
            throw new ConfigurationException("Only one external virtualhosts configuration file allowed, multiple filenames found.");
        }


        // Virtualhost configuration object
        Configuration vhostConfiguration = new HierarchicalConfiguration();


        // Load from embedded configuration if possible
        if (!vhostConfig.subset("virtualhost").isEmpty())
        {
            vhostConfiguration = vhostConfig;
        }
        else
        {
        // Load from the external configuration if possible
        for (String fileName : vhostFiles)
          {
              // Open the vhosts XML file and copy values from it to our config
                _vhostsFile = new File(fileName);
                if (!_vhostsFile.exists())
                {
                    throw new ConfigurationException("Virtualhosts file does not exist");
                }
            vhostConfiguration = parseConfig(new File(fileName));


                // save the default virtualhost name
                String defaultVirtualHost = vhostConfiguration.getString("default");
                _configuration.setProperty("virtualhosts.default", defaultVirtualHost);
            }
        }


        // Now extract the virtual host names from the configuration object
        List hosts = vhostConfiguration.getList("virtualhost.name");
        for (int j = 0; j < hosts.size(); j++)
        {
            String name = (String) hosts.get(j);


            // Add the virtual hosts to the server configuration
            VirtualHostConfiguration virtualhost = new VirtualHostConfiguration(name, vhostConfiguration.subset("virtualhost." + name));
            _virtualHosts.put(virtualhost.getName(), virtualhost);
        }
    }

View Full Code Here

        setJavaMailProviderName(
            conf.getString("javaMailProviderName"));
        setJavaMailFolderName(conf.getString("javaMailFolderName"));
        setRecurse(conf.getBoolean("recursesubfolders"));


        HierarchicalConfiguration recipientNotFound = conf.configurationAt("recipientnotfound");
        setDeferRecipientNotFound(
            recipientNotFound.getBoolean("[@defer]"));
        setRejectRecipientNotFound(
            recipientNotFound.getBoolean("[@reject]"));
        setLeaveRecipientNotFound(
            recipientNotFound.getBoolean("[@leaveonserver]"));
        setMarkRecipientNotFoundSeen(
            recipientNotFound.getBoolean("[@markseen]"));
        setDefaultDomainName(conf.getString("defaultdomain", "localhost"));


        setFetchAll(conf.getBoolean("fetchall"));


        HierarchicalConfiguration fetched = conf.configurationAt("fetched");
        setLeave(fetched.getBoolean("[@leaveonserver]"));
        setMarkSeen(fetched.getBoolean("[@markseen]"));


        HierarchicalConfiguration remoterecipient = conf.configurationAt("remoterecipient");
        setRejectRemoteRecipient(
            remoterecipient.getBoolean("[@reject]"));
        setLeaveRemoteRecipient(
            remoterecipient.getBoolean("[@leaveonserver]"));
        setMarkRemoteRecipientSeen(
            remoterecipient.getBoolean("[@markseen]"));


        HierarchicalConfiguration blacklist = conf.configurationAt("blacklist");
        setBlacklist(conf.getString("blacklist",""));
        setRejectBlacklisted(blacklist.getBoolean("[@reject]"));
        setLeaveBlacklisted(blacklist.getBoolean("[@leaveonserver]"));
        setMarkBlacklistedSeen(blacklist.getBoolean("[@markseen]"));


        HierarchicalConfiguration userundefined = conf.configurationAt("userundefined");
        setRejectUserUndefined(userundefined.getBoolean("[@reject]"));
        setLeaveUserUndefined(
            userundefined.getBoolean("[@leaveonserver]"));
        setMarkUserUndefinedSeen(
            userundefined.getBoolean("[@markseen]"));


        HierarchicalConfiguration undeliverable = conf.configurationAt("undeliverable");
        setLeaveUndeliverable(
            undeliverable.getBoolean("[@leaveonserver]"));
        setMarkUndeliverableSeen(
            undeliverable.getBoolean("[@markseen]"));


        if (conf.getKeys("remotereceivedheader").hasNext())
        {
            HierarchicalConfiguration remotereceivedheader = conf.configurationAt("remotereceivedheader");


            setRemoteReceivedHeaderIndex(
                remotereceivedheader.getInt("[@index]"));
            setRejectRemoteReceivedHeaderInvalid(
                remotereceivedheader.getBoolean("[@reject]"));
            setLeaveRemoteReceivedHeaderInvalid(
                remotereceivedheader.getBoolean("[@leaveonserver]"));
            setMarkRemoteReceivedHeaderInvalidSeen(
                remotereceivedheader.getBoolean("[@markseen]"));
        }            


        if (conf.getKeys("maxmessagesize").hasNext())
        {
            HierarchicalConfiguration maxmessagesize = conf.configurationAt("maxmessagesize");


            setMaxMessageSizeLimit(
                maxmessagesize.getInt("[@limit]") * 1024);
            setRejectMaxMessageSizeExceeded(
                maxmessagesize.getBoolean("[@reject]"));
            setLeaveMaxMessageSizeExceeded(
                maxmessagesize.getBoolean("[@leaveonserver]"));
            setMarkMaxMessageSizeExceededSeen(
                maxmessagesize.getBoolean("[@markseen]"));
        }


        if (getLogger().isDebugEnabled())
        {
            getLogger().info(

View Full Code Here

        
        for ( int i = 0; i < protocols.size(); i++ )
        {
            String protocol = protocols.get(i);


            HierarchicalConfiguration defConf = null;
            
            if (repConf.getKeys("config").hasNext()) {
                // Get the default configuration for these protocol/type combinations.
                defConf = repConf.configurationAt("config");
            }

View Full Code Here

            // If default values have been set, create a new repository
            // configuration element using the default values
            // and the values in the selector.
            // If no default values, just use the selector.
            final CombinedConfiguration config =  new CombinedConfiguration();
            HierarchicalConfiguration defConf = defaultConfigs.get(key);
            if ( defConf == null) {
                config.addConfiguration(repConf);
            }
            else {
                config.addConfiguration(repConf);

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

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

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

cgl.shindig.config.ConfigurationParser

cgl.shindig.config.PortalConfigParser

com.cedarsoft.configuration.xml.XmlConfigurationManager

com.cedarsoft.utils.configuration.xml.XmlConfigurationManager

com.codicesoftware.plugins.bamboo40.PlasticRepository

com.mvc4g.util.Mvc4gConfigurationFileReader

com.netflix.config.ConcurrentMapConfigurationTest

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

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

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.