Package io.dropwizard.configuration

Class SubstitutingSourceProvider

java.lang.Object

io.dropwizard.configuration.SubstitutingSourceProvider

All Implemented Interfaces:

ConfigurationSourceProvider

public class SubstitutingSourceProvider
extends java.lang.Object
implements ConfigurationSourceProvider

A delegating ConfigurationSourceProvider which replaces variables in the underlying configuration source according to the rules of a custom StrSubstitutor.

Constructor Summary

Constructors

Constructor	Description
SubstitutingSourceProvider(ConfigurationSourceProvider delegate, org.apache.commons.text.StrSubstitutor substitutor)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
java.io.InputStream	open(java.lang.String path)	Returns an InputStream that contains the source of the configuration for the application.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubstitutingSourceProvider

public SubstitutingSourceProvider(ConfigurationSourceProvider delegate,
                                  org.apache.commons.text.StrSubstitutor substitutor)

Create a new instance.

Parameters:

delegate - The underlying ConfigurationSourceProvider.

substitutor - The custom StrSubstitutor implementation.

Method Detail

open

public java.io.InputStream open(java.lang.String path)
                         throws java.io.IOException

Returns an InputStream that contains the source of the configuration for the application. The caller is responsible for closing the result.

Specified by:

open in interface ConfigurationSourceProvider

Parameters:

path - the path to the configuration

Returns:

an InputStream

Throws:

java.io.IOException - if there is an error reading the data at path