io.inverno.mod.configuration.ConfigurationLoader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of inverno-configuration Show documentation
Show all versions of inverno-configuration Show documentation
Inverno configuration module
/*
* Copyright 2020 Jeremy KUHN
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.inverno.mod.configuration;
import io.inverno.mod.configuration.ConfigurationKey.Parameter;
import io.inverno.mod.configuration.internal.ConfigurationTypeConfigurationLoader;
import io.inverno.mod.configuration.internal.ConfiguratorTypeConfigurationLoader;
import java.util.Arrays;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Function;
import reactor.core.publisher.Mono;
/**
*
* A configuration loader is used to load a configuration object from a {@link ConfigurationSource}.
*
*
*
* A typical usage is:
*
*
* {@code
* ConfigurationSource source = ...
*
* SomeConfiguration configuration = ConfigurationLoader
* .withConfiguration(SomeConfiguration.class)
* .withParameters("environment", "test", "profile", "perf")
* .withSource(source)
* .load()
* .block();
* }
*
*
* Please refer to {@link Configuration @Configuration} documentation to learn how to define a proper configuration type.
*
*
* @author Jeremy Kuhn
* @since 1.0
*
* @see ConfigurationSource
*
* @param the configuration type
* @param the configuration loader type
*/
public interface ConfigurationLoader> {
/**
*
* Creates a configuration loader to load configuration of the specified type.
*
*
* @param the configuration type to load
* @param configurationType a class of type E
*
* @return a configuration loader
*
* @throws IllegalArgumentException if the specified type is not an interface
*/
static ConfigurationLoader withConfiguration(Class configurationType) throws IllegalArgumentException {
return new ConfigurationTypeConfigurationLoader<>(configurationType);
}
/**
*
* Creates a configuration loader with a specified configurator type and configuration creation function.
*
*
*
* The configurator is acting as a builder: it exposes single argument methods to set the values of configuration properties whose names are the name of the methods.
*
*
*
* Then the creator builds the configuration from the configurator.
*
*
*
* Unlike {@link ConfigurationLoader#withConfiguration(Class)}, it is possible to load a configuration for any kind of object and not only interface since the creation of the configuration
* instance is delegated to the supplied configuration creator.
*
*
* @param the configuration type to load
* @param the configurator type
* @param configuratorType a class of type F
* @param configurationCreator a function that builds the configuration from the configurator
*
* @return a configuration loader
*/
static ConfigurationLoader withConfigurator(Class configuratorType, Function, E> configurationCreator) {
return new ConfiguratorTypeConfigurationLoader<>(configuratorType, configurationCreator);
}
/**
*
* Defines one parameter that specifies the context in which configuration properties are to be retrieved.
*
*
* @param k1 the parameter name
* @param v1 the parameter value
*
* @return the configuration loader
*/
default B withParameters(String k1, Object v1) {
return this.withParameters(List.of(Parameter.of(k1, v1)));
}
/**
*
* Defines two parameters that specify the context in which configuration properties are to be retrieved.
*
*
* @param k1 the first parameter name
* @param v1 the first parameter value
* @param k2 the second parameter name
* @param v2 the second parameter value
*
* @return the configuration loader
*
* @throws IllegalArgumentException if parameters were specified more than once
*/
default B withParameters(String k1, Object v1, String k2, Object v2) throws IllegalArgumentException {
return this.withParameters(List.of(Parameter.of(k1, v1), Parameter.of(k2, v2)));
}
/**
*
* Defines three parameters that specify the context in which configuration properties are to be retrieved.
*
*
* @param k1 the first parameter name
* @param v1 the first parameter value
* @param k2 the second parameter name
* @param v2 the second parameter value
* @param k3 the third parameter name
* @param v3 the third parameter value
*
* @return the configuration loader
*
* @throws IllegalArgumentException if parameters were specified more than once
*/
default B withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3) throws IllegalArgumentException {
return this.withParameters(List.of(Parameter.of(k1, v1), Parameter.of(k2, v2), Parameter.of(k3, v3)));
}
/**
*
* Defines four parameters that specify the context in which configuration properties are to be retrieved.
*
*
* @param k1 the first parameter name
* @param v1 the first parameter value
* @param k2 the second parameter name
* @param v2 the second parameter value
* @param k3 the third parameter name
* @param v3 the third parameter value
* @param k4 the fourth parameter name
* @param v4 the fourth parameter value
*
* @return the configuration loader
*
* @throws IllegalArgumentException if parameters were specified more than once
*/
default B withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4) throws IllegalArgumentException {
return this.withParameters(List.of(Parameter.of(k1, v1), Parameter.of(k2, v2), Parameter.of(k3, v3), Parameter.of(k4, v4)));
}
/**
*
* Defines five parameters that specify the context in which configuration properties are to be retrieved.
*
*
* @param k1 the first parameter name
* @param v1 the first parameter value
* @param k2 the second parameter name
* @param v2 the second parameter value
* @param k3 the third parameter name
* @param v3 the third parameter value
* @param k4 the fourth parameter name
* @param v4 the fourth parameter value
* @param k5 the fifth parameter name
* @param v5 the fifth parameter value
*
* @return the configuration loader
*
* @throws IllegalArgumentException if parameters were specified more than once
*/
default B withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5) throws IllegalArgumentException {
return this.withParameters(List.of(Parameter.of(k1, v1), Parameter.of(k2, v2), Parameter.of(k3, v3), Parameter.of(k4, v4), Parameter.of(k5, v5)));
}
/**
*
* Defines six parameters that specify the context in which configuration properties are to be retrieved.
*
*
* @param k1 the first parameter name
* @param v1 the first parameter value
* @param k2 the second parameter name
* @param v2 the second parameter value
* @param k3 the third parameter name
* @param v3 the third parameter value
* @param k4 the fourth parameter name
* @param v4 the fourth parameter value
* @param k5 the fifth parameter name
* @param v5 the fifth parameter value
* @param k6 the sixth parameter name
* @param v6 the sixth parameter value
*
* @return the configuration loader
*
* @throws IllegalArgumentException if parameters were specified more than once
*/
default B withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6) throws IllegalArgumentException {
return this.withParameters(List.of(Parameter.of(k1, v1), Parameter.of(k2, v2), Parameter.of(k3, v3), Parameter.of(k4, v4), Parameter.of(k5, v5), Parameter.of(k6, v6)));
}
/**
*
* Defines seven parameters that specify the context in which configuration properties are to be retrieved.
*
*
* @param k1 the first parameter name
* @param v1 the first parameter value
* @param k2 the second parameter name
* @param v2 the second parameter value
* @param k3 the third parameter name
* @param v3 the third parameter value
* @param k4 the fourth parameter name
* @param v4 the fourth parameter value
* @param k5 the fifth parameter name
* @param v5 the fifth parameter value
* @param k6 the sixth parameter name
* @param v6 the sixth parameter value
* @param k7 the seventh parameter name
* @param v7 the seventh parameter value
*
* @return the configuration loader
*
* @throws IllegalArgumentException if parameters were specified more than once
*/
default B withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6, String k7, Object v7) throws IllegalArgumentException {
return this.withParameters(List.of(Parameter.of(k1, v1), Parameter.of(k2, v2), Parameter.of(k3, v3), Parameter.of(k4, v4), Parameter.of(k5, v5), Parameter.of(k6, v6), Parameter.of(k7, v7)));
}
/**
*
* Defines eigth parameters that specify the context in which configuration properties are to be retrieved.
*
*
* @param k1 the first parameter name
* @param v1 the first parameter value
* @param k2 the second parameter name
* @param v2 the second parameter value
* @param k3 the third parameter name
* @param v3 the third parameter value
* @param k4 the fourth parameter name
* @param v4 the fourth parameter value
* @param k5 the fifth parameter name
* @param v5 the fifth parameter value
* @param k6 the sixth parameter name
* @param v6 the sixth parameter value
* @param k7 the seventh parameter name
* @param v7 the seventh parameter value
* @param k8 the eighth parameter name
* @param v8 the eighth parameter value
*
* @return the configuration loader
*
* @throws IllegalArgumentException if parameters were specified more than once
*/
default B withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6, String k7, Object v7, String k8, Object v8) throws IllegalArgumentException {
return this.withParameters(List.of(Parameter.of(k1, v1), Parameter.of(k2, v2), Parameter.of(k3, v3), Parameter.of(k4, v4), Parameter.of(k5, v5), Parameter.of(k6, v6), Parameter.of(k7, v7), Parameter.of(k8, v8)));
}
/**
*
* Defines nine parameters that specify the context in which configuration properties are to be retrieved.
*
*
* @param k1 the first parameter name
* @param v1 the first parameter value
* @param k2 the second parameter name
* @param v2 the second parameter value
* @param k3 the third parameter name
* @param v3 the third parameter value
* @param k4 the fourth parameter name
* @param v4 the fourth parameter value
* @param k5 the fifth parameter name
* @param v5 the fifth parameter value
* @param k6 the sixth parameter name
* @param v6 the sixth parameter value
* @param k7 the seventh parameter name
* @param v7 the seventh parameter value
* @param k8 the eighth parameter name
* @param v8 the eighth parameter value
* @param k9 the ninth parameter name
* @param v9 the ninth parameter value
*
* @return the configuration loader
*
* @throws IllegalArgumentException if parameters were specified more than once
*/
default B withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6, String k7, Object v7, String k8, Object v8, String k9, Object v9) throws IllegalArgumentException {
return this.withParameters(List.of(Parameter.of(k1, v1), Parameter.of(k2, v2), Parameter.of(k3, v3), Parameter.of(k4, v4), Parameter.of(k5, v5), Parameter.of(k6, v6), Parameter.of(k7, v7), Parameter.of(k8, v8), Parameter.of(k9, v9)));
}
/**
*
* Defines ten parameters that specify the context in which configuration properties are to be retrieved.
*
*
* @param k1 the first parameter name
* @param v1 the first parameter value
* @param k2 the second parameter name
* @param v2 the second parameter value
* @param k3 the third parameter name
* @param v3 the third parameter value
* @param k4 the fourth parameter name
* @param v4 the fourth parameter value
* @param k5 the fifth parameter name
* @param v5 the fifth parameter value
* @param k6 the sixth parameter name
* @param v6 the sixth parameter value
* @param k7 the seventh parameter name
* @param v7 the seventh parameter value
* @param k8 the eighth parameter name
* @param v8 the eighth parameter value
* @param k9 the ninth parameter name
* @param v9 the ninth parameter value
* @param k10 the tenth parameter name
* @param v10 the tenth parameter value
*
* @return the configuration loader
*
* @throws IllegalArgumentException if parameters were specified more than once
*/
default B withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6, String k7, Object v7, String k8, Object v8, String k9, Object v9, String k10, Object v10) throws IllegalArgumentException {
return this.withParameters(List.of(Parameter.of(k1, v1), Parameter.of(k2, v2), Parameter.of(k3, v3), Parameter.of(k4, v4), Parameter.of(k5, v5), Parameter.of(k6, v6), Parameter.of(k7, v7), Parameter.of(k8, v8), Parameter.of(k9, v9), Parameter.of(k10, v10)));
}
/**
*
* Defines parameters that specify the context in which configuration properties are to be retrieved.
*
*
* @param parameters an array of parameters
*
* @return the configuration loader
*
* @throws IllegalArgumentException if parameters were specified more than once
*/
default B withParameters(Parameter... parameters) throws IllegalArgumentException {
return this.withParameters(parameters != null ? Arrays.asList(parameters) : List.of());
}
/**
*
* Defines parameters that specify the context in which configuration properties are to be retrieved.
*
*
* @param parameters a list of parameters
*
* @return the configuration loader
*
* @throws IllegalArgumentException if parameters were specified more than once
*/
B withParameters(List parameters) throws IllegalArgumentException;
/**
*
* Specifies the configuration source from where to load configuration properties.
*
*
* @param source a configuration source
*
* @return the configuration loader
*/
B withSource(ConfigurationSource source);
/**
*
* Loads the configuration from the configuration source with the specified parameters.
*
*
* @return a mono emitting the resulting configuration object
*
* @throws ConfigurationLoaderException if there was an error loading the configuration
*/
Mono load() throws ConfigurationLoaderException;
}