org.springmodules.commons.configuration

Class CommonsConfigurationFactoryBean

java.lang.Object

org.springmodules.commons.configuration.CommonsConfigurationFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean<Properties>, org.springframework.beans.factory.InitializingBean

public class CommonsConfigurationFactoryBean
extends Object
implements org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.FactoryBean<Properties>

FactoryBean which wraps a Commons CompositeConfiguration object for usage with PropertiesLoaderSupport. This allows the configuration object to behave like a normal java.util.Properties object which can be passed on to setProperties() method allowing PropertyOverrideConfigurer and PropertyPlaceholderConfigurer to take advantage of Commons Configuration. Internally a CompositeConfiguration object is used for merging multiple Configuration objects.

Author:

Costin Leau

See Also:

Properties, org.springframework.core.io.support.PropertiesLoaderSupport

Constructor Summary

Constructors

Constructor and Description
CommonsConfigurationFactoryBean()
CommonsConfigurationFactoryBean(org.apache.commons.configuration.Configuration configuration)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
org.apache.commons.configuration.CompositeConfiguration	getConfiguration() Getter for the underlying CompositeConfiguration object.
org.apache.commons.configuration.Configuration[]	getConfigurations()
org.springframework.core.io.Resource[]	getLocations()
Properties	getObject()
Class<Properties>	getObjectType()
boolean	isSingleton()
boolean	isThrowExceptionOnMissing()
void	setConfigurationListener(org.apache.commons.configuration.event.ConfigurationListener listener)
void	setConfigurations(org.apache.commons.configuration.Configuration[] configurations) Set the commons configurations objects which will be used as properties.
void	setLocations(org.springframework.core.io.Resource[] locations) Shortcut for loading configuration from Spring resources.
void	setThrowExceptionOnMissing(boolean throwExceptionOnMissing) Set the underlying Commons CompositeConfiguration throwExceptionOnMissing flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonsConfigurationFactoryBean

public CommonsConfigurationFactoryBean()

CommonsConfigurationFactoryBean

public CommonsConfigurationFactoryBean(org.apache.commons.configuration.Configuration configuration)

Method Detail

getObject

public Properties getObject()
                     throws Exception

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<Properties>

Throws:

Exception

See Also:

FactoryBean.getObject()

getObjectType

public Class<Properties> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<Properties>

See Also:

FactoryBean.getObjectType()

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<Properties>

See Also:

FactoryBean.isSingleton()

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

See Also:

InitializingBean.afterPropertiesSet()

getConfigurations

public org.apache.commons.configuration.Configuration[] getConfigurations()

Returns:

Returns the configurations.

setConfigurations

public void setConfigurations(org.apache.commons.configuration.Configuration[] configurations)

Set the commons configurations objects which will be used as properties.

Parameters:

configurations -

getLocations

public org.springframework.core.io.Resource[] getLocations()

setLocations

public void setLocations(org.springframework.core.io.Resource[] locations)

Shortcut for loading configuration from Spring resources. It will internally create a PropertiesConfiguration object based on the URL retrieved from the given Resources.

Parameters:

locations -

isThrowExceptionOnMissing

public boolean isThrowExceptionOnMissing()

setThrowExceptionOnMissing

public void setThrowExceptionOnMissing(boolean throwExceptionOnMissing)

Set the underlying Commons CompositeConfiguration throwExceptionOnMissing flag.

Parameters:

throwExceptionOnMissing -

getConfiguration

public org.apache.commons.configuration.CompositeConfiguration getConfiguration()

Getter for the underlying CompositeConfiguration object.

Returns:

setConfigurationListener

public void setConfigurationListener(org.apache.commons.configuration.event.ConfigurationListener listener)