org.craftercms.commons.config

Class MultiResourceConfigurationBuilder

java.lang.Object

org.craftercms.commons.config.EncryptionAwareConfigurationReader

org.craftercms.commons.config.MultiResourceConfigurationBuilder

All Implemented Interfaces:

org.apache.commons.configuration2.builder.ConfigurationBuilder<org.apache.commons.configuration2.HierarchicalConfiguration<?>>, org.apache.commons.configuration2.event.EventSource

public class MultiResourceConfigurationBuilder
extends EncryptionAwareConfigurationReader
implements org.apache.commons.configuration2.builder.ConfigurationBuilder<org.apache.commons.configuration2.HierarchicalConfiguration<?>>

ConfigurationBuilder that creates the configuration from a set of specified resource configuration paths. Each configuration from this path is then combined in a single configuration, where the latest configurations override the first ones.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	configPaths
protected org.springframework.core.io.ResourceLoader	resourceLoader

Fields inherited from class org.craftercms.commons.config.EncryptionAwareConfigurationReader

configListDelimiter, DEFAULT_ENCRYPTED_VALUE_PREFIX, DEFAULT_LIST_DELIMITER, encryptedValuePrefix, prefixLookups, textEncryptor

Constructor Summary

Constructors

Constructor and Description
MultiResourceConfigurationBuilder(String[] configPaths, org.springframework.core.io.ResourceLoader resourceLoader)
MultiResourceConfigurationBuilder(String[] configPaths, org.springframework.core.io.ResourceLoader resourceLoader, char configListDelimiter, String encryptedValuePrefix, TextEncryptor configDecryptor)
MultiResourceConfigurationBuilder(String[] configPaths, org.springframework.core.io.ResourceLoader resourceLoader, TextEncryptor configDecryptor)

Method Summary

Modifier and Type	Method and Description
<E extends org.apache.commons.configuration2.event.Event> void	addEventListener(org.apache.commons.configuration2.event.EventType<E> eventType, org.apache.commons.configuration2.event.EventListener<? super E> listener)
org.apache.commons.configuration2.HierarchicalConfiguration<?>	getConfiguration()
<E extends org.apache.commons.configuration2.event.Event> boolean	removeEventListener(org.apache.commons.configuration2.event.EventType<E> eventType, org.apache.commons.configuration2.event.EventListener<? super E> listener)

Methods inherited from class org.craftercms.commons.config.EncryptionAwareConfigurationReader

readXmlConfiguration, readXmlConfiguration, readYamlConfiguration, readYamlConfiguration, readYamlConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configPaths

protected String[] configPaths

resourceLoader

protected org.springframework.core.io.ResourceLoader resourceLoader

Constructor Detail

MultiResourceConfigurationBuilder

public MultiResourceConfigurationBuilder(String[] configPaths,
                                         org.springframework.core.io.ResourceLoader resourceLoader)

MultiResourceConfigurationBuilder

public MultiResourceConfigurationBuilder(String[] configPaths,
                                         org.springframework.core.io.ResourceLoader resourceLoader,
                                         TextEncryptor configDecryptor)

MultiResourceConfigurationBuilder

public MultiResourceConfigurationBuilder(String[] configPaths,
                                         org.springframework.core.io.ResourceLoader resourceLoader,
                                         char configListDelimiter,
                                         String encryptedValuePrefix,
                                         TextEncryptor configDecryptor)

Method Detail

getConfiguration

public org.apache.commons.configuration2.HierarchicalConfiguration<?> getConfiguration()
                                                                                throws org.apache.commons.configuration2.ex.ConfigurationException

Specified by:

getConfiguration in interface org.apache.commons.configuration2.builder.ConfigurationBuilder<org.apache.commons.configuration2.HierarchicalConfiguration<?>>

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

addEventListener

public <E extends org.apache.commons.configuration2.event.Event> void addEventListener(org.apache.commons.configuration2.event.EventType<E> eventType,
                                                                                       org.apache.commons.configuration2.event.EventListener<? super E> listener)

Specified by:

addEventListener in interface org.apache.commons.configuration2.event.EventSource

removeEventListener

public <E extends org.apache.commons.configuration2.event.Event> boolean removeEventListener(org.apache.commons.configuration2.event.EventType<E> eventType,
                                                                                             org.apache.commons.configuration2.event.EventListener<? super E> listener)

Specified by:

removeEventListener in interface org.apache.commons.configuration2.event.EventSource