io.dropwizard.configuration

Class ConfigurationFactory<T>

java.lang.Object

io.dropwizard.configuration.ConfigurationFactory<T>

Type Parameters:

T - the type of the configuration objects to produce

public class ConfigurationFactory<T>
extends Object

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

Constructor Summary

Constructors

Constructor and Description
ConfigurationFactory(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

Methods

Modifier and Type	Method and Description
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.
T	build(File file) Loads, parses, binds, and validates a configuration object from a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationFactory

public ConfigurationFactory(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

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

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(File file)
        throws IOException,
               ConfigurationException

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

Parameters:

file - 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

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

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