This manual is a work in progress and is currently incomplete.
If you'd like to help improve it, and we hope you do, please see the README.

18 Config

Most applications need some level of configuration. This can be used to specify the correct external resources to use (databases, other services, etc.), tune performance, or otherwise adjust to the requirements of a given environment. Ratpack provides an easy, flexible mechanism to access configuration information in your Ratpack application.

Configuration data is accessed via object binding using Jackson. Configuration objects provided by Ratpack are intended to be usable out of the box. Configuration data can be loaded from multiple sources, such as YAML files, JSON files, properties files, environment variables and system properties.

18.1 Quick-Start

To get started:

  1. Within your RatpackServer definition function, build a ConfigData instance (see class documentation for an example)
  2. Retrieve bound configuration objects from the config data

18.2 Config Sources

ConfigDataBuilder provides methods to easily load data from the most common sources.

Commonly used file formats can be used via the yaml, json and props methods. The provided signatures can be used to load data from local files (String or Path), over the network (URL), from the classpath (use Resources.getResource(String) to get a URL), or anywhere else you can treat as a ByteSource. Additionally, you can load data from non-file sources such as Maps/Properties objects (particularly useful for default values; see example), system properties, and environment variables. You can also choose to load configuration data from existing objects using the object method. If additional flexibility is needed, you can provide your own ConfigSource implementation.

18.2.1 Flat Config Sources

Environment variables, Properties, and Maps are flat data structures, whereas the binding model used by Ratpack is hierarchical. To bridge this gap, these config source implementations apply conventions to allow for the flat key-value pairs to be transformed into useful data.

18.2.1.1 Environment Variables

The default environment variable config source uses the following rules:

If custom environment parsing is needed, you can supply an EnvironmentParser implementation.

18.2.1.2 Properties/Maps

The default Properties/Map config source uses the following rules:

18.3 Usage

18.3.1 Ordering

If you have multiple config sources, add them to the builder from least important to most important. For example, if you had a configuration file that you wanted to be able to override via system properties, you would first add the configuration file source, followed by the system properties source. Likewise, if you have default settings that you wanted to be able to override via environment variables, you would first add the default settings source (perhaps via props), followed by the environment variables source.

18.3.2 Error Handling

As shown in the ConfigDataBuilder docs, onError can be used to customize the behavior when an error is encountered while loading data from a config source. Most commonly, this is used to make configuration sources optional by ignoring load exceptions.

18.3.3 Object Mapper

Ratpack uses Jackson for config object binding. The default ObjectMapper used is configured with commonly used Jackson modules pre-loaded, and set to allow unquoted field names, allow single quotes, and ignore unknown field names. This is intended to make it easy to use, out-of-the-box. However, there will sometimes be cases where you may want to change a Jackson configuration setting or add additional Jackson modules. If so, this can be accomplished via various signatures of ConfigData.of(...) or via ConfigDataBuilder.configureObjectMapper(...).

18.3.4 Binding

Once you’ve built your ConfigData instance, you can bind the data to configuration objects. The simplest option is to define a class that represents the entirety of your application’s configuration, and bind to it all at once using ConfigData.get(Class). Alternatively, you can bind objects one-at-a-time at specified paths within the data using ConfigData.get(String, Class). For the common case of binding to a ServerConfig object, ConfigData.getServerConfig(...) signatures are provided as a convenience.