com.alanbuttars.commons.config.stub

Class Watch

java.lang.Object

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

com.alanbuttars.commons.config.ConfigurationYamlImpl<YamlConfig>

com.alanbuttars.commons.config.stub.Watch

All Implemented Interfaces:

Configuration<YamlConfig>

public class Watch
extends ConfigurationYamlImpl<YamlConfig>

Models the entrypoint to this module. At application startup, a single instance of Watch should be created and subsequently used to (1) register configuration files to be watched, and (2) create configuration objects which will encompass those files.

The singleton instance of Watch can be constructed in two ways, both of which require a configuration YAML (see https://github.com/alanbuttars/commons-java/wiki/commons-config#commonsconfigyml.

1. Deploy your application with a system property pointing to the YAML

 java -Dcommons.config=/path/to/commons.config.yml -jar MyApplication.jar
 

Then in your main class:

 public class MyApplication {
        public static void main(String[] args) {
                EventBus eventBus = new EventBusSyncImpl();
                Watch watch = Watch.config().withEventBus(eventBus);
        }
 }
 

2. Pass the YAML file path directly in your main class:

    public class MyApplication {
           public static void main(String[] args) {
                   EventBus eventBus = new EventBusAsyncImpl();
                   Watch watch = Watch.config("/path/to/commons.config.yml").withEventBus(eventBus);
           }
    }
    

Once you have created your singleton Watch, you can use it to create Configuration objects. See https://github.com/alanbuttars/commons-java/wiki/commons-config#configuration.

 public class MyApplication {
 
        private static ConfigurationPropertiesImpl database;
        private static ConfigurationJsonImpl admin;
 
        public static void main(String[] args) {
                EventBus eventBus = new EventBusSyncImpl();
                Watch watch = Watch.config().withEventBus(eventBus);
 
                database = watch.properties("database");
                admin = watch.json("admin").mappedTo(User.class);
        }
 }
 

Author:

Alan Buttars

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SOURCE_ID

Method Summary

Methods

Modifier and Type	Method and Description
static WatchStub	config() Creates an instance of this class, using the system property commons.config.
static WatchStub	config(String yamlFilePath) Creates an instance of this class, using the given file path.
WatchFileCustomImplStub	custom(String sourceId) Creates a custom configuration object.
ConfigurationDirectoryImpl	directory(String sourceId) Creates a configuration object from a directory.
protected ScheduledThreadPoolExecutor	getExecutor()
WatchFileJsonImplStub	json(String sourceId) Creates a configuration object from a JSON file.
ConfigurationPropertiesImpl	properties(String sourceId) Creates a configuration object from a properties file.
protected void	reload(File configFile)
WatchFileXmlImplStub	xml(String sourceId) Creates a configuration object from a XML file.
WatchFileYamlImplStub	yaml(String sourceId) Creates a configuration object from a YAML file.

Methods inherited from class com.alanbuttars.commons.config.ConfigurationYamlImpl

load

Methods inherited from class com.alanbuttars.commons.config.ConfigurationAbstractImpl

getEventBus, getSourceId, getValue, init, onFileEvent, onFileEventMatch, whenConfigFileCreated, whenConfigFileDeleted, whenConfigFileUpdated

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_ID

protected static final String SOURCE_ID

See Also:

Constant Field Values

Method Detail

config

public static WatchStub config()

Creates an instance of this class, using the system property commons.config.

Throws:

IllegalArgumentException - If the system property points to an invalid file

config

public static WatchStub config(String yamlFilePath)

Creates an instance of this class, using the given file path.

Parameters:

yamlFilePath - Non-null file path of the configuration YAML

Throws:

IllegalArgumentException - If the file path points to an invalid file

json

public WatchFileJsonImplStub json(String sourceId)

Creates a configuration object from a JSON file.

Parameters:

sourceId - Non-null source ID from a JSON file entry in the master configuration YAML

Returns:

The configuration stubbing object

properties

public ConfigurationPropertiesImpl properties(String sourceId)
                                       throws IOException

Creates a configuration object from a properties file.

Parameters:

sourceId - Non-null source ID from a properties file entry in the master configuration YAML

Returns:

The configuration object

Throws:

IOException - On I/O parsing the properties file

xml

public WatchFileXmlImplStub xml(String sourceId)

Creates a configuration object from a XML file.

Parameters:

sourceId - Non-null source ID from a XML file entry in the master configuration YAML

Returns:

The configuration stubbing object

yaml

public WatchFileYamlImplStub yaml(String sourceId)

Creates a configuration object from a YAML file.

Parameters:

sourceId - Non-null source ID from a YAML file entry in the master configuration YAML

Returns:

The configuration stubbing object

directory

public ConfigurationDirectoryImpl directory(String sourceId)
                                     throws IOException

Creates a configuration object from a directory.

Parameters:

sourceId - Non-null source ID from a directory file entry in the master configuration YAML

Returns:

The configuration object

Throws:

IOException - On I/O parsing the directory

custom

public WatchFileCustomImplStub custom(String sourceId)

Creates a custom configuration object.

Parameters:

sourceId - Non-null source ID from a file entry in the master configuration YAML

Returns:

The configuration stubbing object

reload

protected void reload(File configFile)
               throws IOException

Overrides:

reload in class ConfigurationAbstractImpl<YamlConfig>

Throws:

IOException

getExecutor

protected ScheduledThreadPoolExecutor getExecutor()