io.dropwizard.configuration

Class YamlConfigurationFactory<T>

java.lang.Object

io.dropwizard.configuration.YamlConfigurationFactory<T>

Type Parameters:

T - the type of the configuration objects to produce

All Implemented Interfaces:

ConfigurationFactory<T>

public class YamlConfigurationFactory<T>
extends Object
implements ConfigurationFactory<T>

A factory class for loading YAML configuration files, binding them to configuration objects, and validating their constraints. Allows for overriding configuration parameters from system properties.

Constructor Summary

Constructors

Constructor and Description
YamlConfigurationFactory(Class<T> klass, javax.validation.Validator validator, com.fasterxml.jackson.databind.ObjectMapper objectMapper, String propertyPrefix) Creates a new configuration factory for the given class.

Method Summary

Modifier and Type	Method and Description
protected void	addOverride(com.fasterxml.jackson.databind.JsonNode root, String name, String value)
T	build() Loads, parses, binds, and validates a configuration object from an empty document.
T	build(ConfigurationSourceProvider provider, String path) Loads, parses, binds, and validates a configuration object.
protected T	build(com.fasterxml.jackson.databind.JsonNode node, String path)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.dropwizard.configuration.ConfigurationFactory

build

Constructor Detail

YamlConfigurationFactory

public YamlConfigurationFactory(Class<T> klass,
                                javax.validation.Validator validator,
                                com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                String propertyPrefix)

Creates a new configuration factory for the given class.

Parameters:

klass - the configuration class

validator - the validator to use

objectMapper - the Jackson ObjectMapper to use

propertyPrefix - the system property name prefix used by overrides

Method Detail

build

public T build(ConfigurationSourceProvider provider,
               String path)
        throws IOException,
               ConfigurationException

Description copied from interface: ConfigurationFactory

Loads, parses, binds, and validates a configuration object.

Specified by:

build in interface ConfigurationFactory<T>

Parameters:

provider - the provider to to use for reading configuration files

path - the path of the configuration file

Returns:

a validated configuration object

Throws:

IOException - if there is an error reading the file

ConfigurationException - if there is an error parsing or validating the file

build

public T build()
        throws IOException,
               ConfigurationException

Description copied from interface: ConfigurationFactory

Loads, parses, binds, and validates a configuration object from an empty document.

Specified by:

build in interface ConfigurationFactory<T>

Returns:

a validated configuration object

Throws:

IOException - if there is an error reading the file

ConfigurationException - if there is an error parsing or validating the file

build

protected T build(com.fasterxml.jackson.databind.JsonNode node,
                  String path)
           throws IOException,
                  ConfigurationException

Throws:

IOException

ConfigurationException

addOverride

protected void addOverride(com.fasterxml.jackson.databind.JsonNode root,
                           String name,
                           String value)