Module org.github.gestalt.core

Package org.github.gestalt.config.reload

Class ConfigReloadStrategy

java.lang.Object

org.github.gestalt.config.reload.ConfigReloadStrategy

Direct Known Subclasses:

FileChangeReloadStrategy, ManualConfigReloadStrategy, TimedConfigReloadStrategy

public abstract class ConfigReloadStrategy
extends java.lang.Object

Baseclass for all reload strategies. Holds all the config reload listeners and the source we want to watch for. On reload it will call the listeners with the sources.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<ConfigReloadListener>	listeners	The listeners for the Config Reload.
protected ConfigSource	source	The source we are listening for a reload.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConfigReloadStrategy()	Protected constructor for the ConfigReloadStrategy.
protected	ConfigReloadStrategy(ConfigSource source)	Protected constructor for the ConfigReloadStrategy.

Method Summary

Modifier and Type	Method	Description
ConfigSource	getSource()	Get the source this reload strategy should apply to.
void	registerListener(ConfigReloadListener listener)	Add a config reload listener.
protected void	reload()	call all listeners with the reload event.
void	removeListener(ConfigReloadListener listener)	Remove a config reload listener.
void	setSource(ConfigSource source)	set the source this reload strategy should apply to.

Methods inherited from class java.lang.Object

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

Field Detail

listeners

protected final java.util.List<ConfigReloadListener> listeners

The listeners for the Config Reload.

source

protected ConfigSource source

The source we are listening for a reload.

Constructor Detail

ConfigReloadStrategy

protected ConfigReloadStrategy()

Protected constructor for the ConfigReloadStrategy. So end users cant create this class, only inherit it.

ConfigReloadStrategy

protected ConfigReloadStrategy(ConfigSource source)

Protected constructor for the ConfigReloadStrategy. So end users cant create this class, only inherit it.

Parameters:

source - source we are listening for a reload

Method Detail

getSource

public ConfigSource getSource()

Get the source this reload strategy should apply to.

Returns:

the source this reload strategy should apply to.

setSource

public void setSource(ConfigSource source)
               throws GestaltConfigurationException

set the source this reload strategy should apply to.

Parameters:

source - the source this reload strategy should apply to.

Throws:

GestaltConfigurationException - if there is an exception setting the source

registerListener

public void registerListener(ConfigReloadListener listener)

Add a config reload listener.

Parameters:

listener - a config reload listener.

removeListener

public void removeListener(ConfigReloadListener listener)

Remove a config reload listener.

Parameters:

listener - a config reload listener.

reload

protected void reload()
               throws GestaltException

call all listeners with the reload event.

Throws:

GestaltException - any exceptions