Package org.craftercms.commons.config

Class ConfigurationResolverImpl

java.lang.Object

org.craftercms.commons.config.ConfigurationResolverImpl

All Implemented Interfaces:

ConfigurationResolver

public class ConfigurationResolverImpl
extends Object
implements ConfigurationResolver

Default implementation of ConfigurationResolver

Since:

3.1.6

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected String	basePath	The path pattern for the default environment
protected EncryptionAwareConfigurationReader	configurationReader
static final String	DEFAULT_ENVIRONMENT
protected String	environment	The active environment
protected String	envPath	The path pattern for a specific environment
static final String	PLACEHOLDER_ENVIRONMENT
static final String	PLACEHOLDER_MODULE

Constructor Summary

Constructors

Constructor	Description
ConfigurationResolverImpl(String environment, String basePath, String envPath, EncryptionAwareConfigurationReader configurationReader)

Method Summary

Modifier and Type	Method	Description
org.apache.commons.configuration2.HierarchicalConfiguration<?>	getXmlConfiguration(String module, String path, ConfigurationProvider provider)	Get the content of a given configuration file

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ENVIRONMENT

public static final String DEFAULT_ENVIRONMENT

See Also:

• Constant Field Values

PLACEHOLDER_MODULE

public static final String PLACEHOLDER_MODULE

See Also:

• Constant Field Values

PLACEHOLDER_ENVIRONMENT

public static final String PLACEHOLDER_ENVIRONMENT

See Also:

• Constant Field Values

environment

protected String environment

The active environment

basePath

protected String basePath

The path pattern for the default environment

envPath

protected String envPath

The path pattern for a specific environment

configurationReader

protected EncryptionAwareConfigurationReader configurationReader

Constructor Details

ConfigurationResolverImpl

@ConstructorProperties({"environment","basePath","envPath","configurationReader"})
public ConfigurationResolverImpl(String environment,
 String basePath,
 String envPath,
 EncryptionAwareConfigurationReader configurationReader)

Method Details

getXmlConfiguration

public org.apache.commons.configuration2.HierarchicalConfiguration<?> getXmlConfiguration(String module,
 String path,
 ConfigurationProvider provider)
                                                                                   throws ConfigurationException

Description copied from interface: ConfigurationResolver

Get the content of a given configuration file

Specified by:

getXmlConfiguration in interface ConfigurationResolver

Parameters:

module - the name of the module

path - the path of the file

provider - the provider to read the file

Returns:

the configuration instance

Throws:

ConfigurationException - if there is any error reading the configuration