com.alanbuttars.commons.config

Class ConfigurationAbstractImpl<T>

java.lang.Object

com.alanbuttars.commons.config.ConfigurationAbstractImpl<T>

Type Parameters:

T - Configuration object type

All Implemented Interfaces:

Configuration<T>

Direct Known Subclasses:

ConfigurationClientsImpl, ConfigurationDirectoryImpl, ConfigurationJsonCollectionImpl, ConfigurationJsonImpl, ConfigurationPropertiesImpl, ConfigurationXmlImpl, ConfigurationYamlCollectionImpl, ConfigurationYamlImpl

public abstract class ConfigurationAbstractImpl<T>
extends Object
implements Configuration<T>

Abstract implementation of Configuration which defines the logic by which event subscription works. Extending classes must call init(File) in the last call of the constructor. For example:

 class ConfigurationCustomImpl implements Configuration<User> {
 
        private final UserDao userDao;
 
        public ConfigurationCustomImpl(String sourceId, File configFile, EventBus eventBus, UserDao userDao) {
                super(sourceId, eventBus);
                this.userDao = userDao;
                init(configFile);
        }
 
        @Override
        public User load(File configFile) {
                String username = readAdminUsernameFromFile(configFile);
                return new UserDao().getUser(username);
        }
 }
 

Author:

Alan Buttars

Constructor Summary

Constructors

Constructor and Description
ConfigurationAbstractImpl(String sourceId, EventBus eventBus)

Method Summary

Methods

Modifier and Type	Method and Description
protected EventBus	getEventBus()
String	getSourceId()
T	getValue() Returns the configuration object.
protected void	init(File configFile) Initializes the configuration value and subscribes this object to file changes.
void	onFileEvent(FileEvent fileEvent) Called when a file event published from the eventBus is heard.
protected void	onFileEventMatch(File configFile, FileEventType fileEventType) Defines the reloading logic to be performed when the file event matches this configuration object.
protected void	reload(File configFile)
protected void	whenConfigFileCreated(File configFile) Called when the file associated with this object is FileEventType.CREATED.
protected void	whenConfigFileDeleted(File configFile) Called when the file associated with this object is FileEventType.DELETED.
protected void	whenConfigFileUpdated(File configFile) Called when the file associated with this object is FileEventType.UPDATED.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.alanbuttars.commons.config.Configuration

load

Constructor Detail

ConfigurationAbstractImpl

public ConfigurationAbstractImpl(String sourceId,
                         EventBus eventBus)

Method Detail

init

protected void init(File configFile)
             throws IOException

Initializes the configuration value and subscribes this object to file changes.

Parameters:

configFile - Non-null configuration file

Throws:

IOException - On I/O error parsing the config file

getSourceId

public String getSourceId()

getEventBus

protected EventBus getEventBus()

getValue

public T getValue()

Returns the configuration object.

onFileEvent

public void onFileEvent(FileEvent fileEvent)
                 throws IOException

Called when a file event published from the eventBus is heard.

Parameters:

fileEvent - Non-null file event which may or may not correspond to this configuration object

Throws:

IOException

onFileEventMatch

protected void onFileEventMatch(File configFile,
                    FileEventType fileEventType)
                         throws IOException

Defines the reloading logic to be performed when the file event matches this configuration object.

Parameters:

configFile - Non-null configuration file which was changed

fileEventType - Non-null file event type

Throws:

IOException

whenConfigFileCreated

protected void whenConfigFileCreated(File configFile)
                              throws IOException

Called when the file associated with this object is FileEventType.CREATED. By default, this method reloads the #config object.

Throws:

IOException

whenConfigFileUpdated

protected void whenConfigFileUpdated(File configFile)
                              throws IOException

Called when the file associated with this object is FileEventType.UPDATED. By default, this method reloads the #config object.

Throws:

IOException

whenConfigFileDeleted

protected void whenConfigFileDeleted(File configFile)
                              throws IOException

Called when the file associated with this object is FileEventType.DELETED. By default, this method does nothing.

Throws:

IOException

reload

protected void reload(File configFile)
               throws IOException

Throws:

IOException