net.centro.rtb.monitoringcenter.config

Class Configurator

java.lang.Object

net.centro.rtb.monitoringcenter.config.Configurator

public class Configurator
extends Object

A bootstrapping class, allowing for convenient configuration of MonitoringCenter. This class provides an ability to configure MonitoringCenter using a provided config file, a default config file, or indicate that no config file is to be used.

In all cases, the clients will be able to override any config file parameters programmatically.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONFIG_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
Configurator()

Method Summary

Modifier and Type	Method and Description
static MonitoringCenterConfig.Builder	configFile(File configFile) Obtains a MonitoringCenterConfig builder, pre-filled with a given config file in the YAML format.
static MonitoringCenterConfig.Builder	defaultConfigFile() Obtains a MonitoringCenterConfig builder, pre-filled with the default config file in the YAML format.
static MonitoringCenterConfig.Builder	noConfigFile() Obtains a MonitoringCenterConfig builder with default parameters.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIG_FILE_NAME

public static final String DEFAULT_CONFIG_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

Configurator

public Configurator()

Method Detail

configFile

public static MonitoringCenterConfig.Builder configFile(File configFile)

Obtains a MonitoringCenterConfig builder, pre-filled with a given config file in the YAML format. The client can override any config file property programmatically via a builder's method. To finalize the configuration, the MonitoringCenterConfig.Builder.build() method should be called.

Parameters:

configFile - a config file in the YAML format.

Returns:

a MonitoringCenterConfig builder pre-filled with the properties from the config file.

Throws:

NullPointerException - if config file is null.

IllegalArgumentException - if config file does not exist.

noConfigFile

public static MonitoringCenterConfig.Builder noConfigFile()

Obtains a MonitoringCenterConfig builder with default parameters. This method should be used when exclusively programmatic configuration is desired. When no config file is provided, the MonitoringCenter's configuration cannot be changed dynamically. To finalize the configuration, the MonitoringCenterConfig.Builder.build() method should be called.

Returns:

a MonitoringCenterConfig builder with default parameters.

defaultConfigFile

public static MonitoringCenterConfig.Builder defaultConfigFile()

Obtains a MonitoringCenterConfig builder, pre-filled with the default config file in the YAML format. The default config file should be named DEFAULT_CONFIG_FILE_NAME and it will be looked up on the classpath.

The client can override any config file property programmatically via a builder's method. To finalize the configuration, the MonitoringCenterConfig.Builder.build() method should be called.

Returns:

a MonitoringCenterConfig builder pre-filled with the properties from the default config file.

Throws:

ConfigException - if config file does not exist.