org.finra.herd.dao

Class ReloadablePropertySource

java.lang.Object

org.springframework.core.env.PropertySource<T>

org.springframework.core.env.EnumerablePropertySource<Map<String,Object>>

org.springframework.core.env.MapPropertySource

org.finra.herd.dao.ReloadablePropertySource

public class ReloadablePropertySource
extends org.springframework.core.env.MapPropertySource

A property source that will possibly re-load itself each time a property is requested. A reload will take place if the configured refresh interval has elapsed. A refresh interval of 0 will cause the properties to refresh every time a property is requested.

If a property is loaded with the key org.finra.herd.dao.ReloadablePropertiesSource.refreshIntervalSecs, it will be used as a way to override the previously configured refresh interval.

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.core.env.PropertySource

org.springframework.core.env.PropertySource.StubPropertySource

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.configuration.Configuration	configuration
protected org.apache.commons.configuration.event.ConfigurationErrorEvent	lastConfigurationErrorEvent
protected long	lastRefreshTime
static String	REFRESH_INTERVAL_SECS_OVERRIDE_KEY The override key for the refresh interval seconds.
protected long	refreshIntervalMillis

Fields inherited from class org.springframework.core.env.PropertySource

logger, name, source

Constructor Summary

Constructors

Constructor and Description
ReloadablePropertySource(String name, Properties source, org.apache.commons.configuration.Configuration configuration) Constructs the object with a default refresh interval of 60 seconds.
ReloadablePropertySource(String name, Properties source, org.apache.commons.configuration.Configuration configuration, long refreshIntervalSecs) Constructs the object with all parameters specified.

Method Summary

Modifier and Type	Method and Description
Object	getProperty(String name) Gets a property by name while possibly refreshing the properties if needed.
protected void	refreshPropertiesIfNeeded() Refreshes the properties from the configuration if it's time to.

Methods inherited from class org.springframework.core.env.MapPropertySource

containsProperty, getPropertyNames

Methods inherited from class org.springframework.core.env.PropertySource

equals, getName, getSource, hashCode, named, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

configuration

protected org.apache.commons.configuration.Configuration configuration

lastRefreshTime

protected long lastRefreshTime

refreshIntervalMillis

protected long refreshIntervalMillis

lastConfigurationErrorEvent

protected org.apache.commons.configuration.event.ConfigurationErrorEvent lastConfigurationErrorEvent

REFRESH_INTERVAL_SECS_OVERRIDE_KEY

public static final String REFRESH_INTERVAL_SECS_OVERRIDE_KEY

The override key for the refresh interval seconds.

Constructor Detail

ReloadablePropertySource

public ReloadablePropertySource(String name,
                                Properties source,
                                org.apache.commons.configuration.Configuration configuration)

Constructs the object with a default refresh interval of 60 seconds.

Parameters:

name - the name of the property source.

source - the properties.

configuration - the configuration that knows how to read properties.

ReloadablePropertySource

public ReloadablePropertySource(String name,
                                Properties source,
                                org.apache.commons.configuration.Configuration configuration,
                                long refreshIntervalSecs)

Constructs the object with all parameters specified.

Parameters:

name - the name of the property source.

source - the properties.

configuration - the configuration that knows how to read properties.

refreshIntervalSecs - the refresh interval in seconds to wait before refreshing the properties when a property is requested.

Method Detail

getProperty

public Object getProperty(String name)

Gets a property by name while possibly refreshing the properties if needed.

Overrides:

getProperty in class org.springframework.core.env.MapPropertySource

Parameters:

name - the property name.

Returns:

the property value.

refreshPropertiesIfNeeded

protected void refreshPropertiesIfNeeded()

Refreshes the properties from the configuration if it's time to.