ratpack.config.ConfigData Maven / Gradle / Ivy
/*
* Copyright 2015 the original author or authors.
*
* 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 ratpack.config;
import com.fasterxml.jackson.databind.Module;
import com.fasterxml.jackson.databind.ObjectMapper;
import ratpack.config.internal.DefaultConfigDataSpec;
import ratpack.func.Action;
import ratpack.server.ReloadInformant;
import ratpack.server.Service;
import ratpack.server.internal.ServerEnvironment;
import java.util.List;
/**
* Configuration data for the application, potentially built from many sources.
*
* A {@link ConfigData} object allows configuration to be “read” as Java objects.
* The data used to populate the objects is specified when building the configuration data.
* The static methods of this interface can be used to build a configuration data object.
*
{@code
* import com.google.common.collect.ImmutableMap;
* import ratpack.server.RatpackServer;
* import ratpack.server.ServerConfig;
* import ratpack.test.http.TestHttpClient;
* import static org.junit.Assert.*;
*
* public class Example {
* public static class MyAppConfig {
* private String name;
*
* public String getName() {
* return name;
* }
* }
*
* public static void main(String[] args) throws Exception {
* RatpackServer server = RatpackServer.of(spec -> {
* ServerConfig serverConfig = ServerConfig.embedded()
* .props(ImmutableMap.of("server.publicAddress", "http://app.example.com", "app.name", "Ratpack"))
* .sysProps()
* .build();
* spec
* .serverConfig(serverConfig)
* .registryOf(r -> r
* .add(serverConfig.get("/app", MyAppConfig.class))
* )
* .handler(registry ->
* ctx -> ctx.render("Hi, my name is " + ctx.get(MyAppConfig.class).getName() + " at " + ctx.getServerConfig().getPublicAddress())
* );
* });
* server.start();
*
* assertTrue(server.isRunning());
*
* TestHttpClient httpClient = TestHttpClient.testHttpClient(server);
* assertEquals("Hi, my name is Ratpack at http://app.example.com", httpClient.getText());
*
* server.stop();
* }
* }
* }
* Configuration Reloading
*
* The created configuration data instance should be added to the server registry (as in the above example).
* This enables automatically reloading the configuration when it changes.
*
* @see ConfigDataSpec
*/
public interface ConfigData extends ReloadInformant, Service {
/**
* Begins building a new application configuration using a default object mapper.
*
* @return the new configuration data spec
*/
static ConfigDataSpec of() {
return new DefaultConfigDataSpec(ServerEnvironment.env());
}
/**
* Begins building a new application configuration using a default object mapper, from the given definition.
*
* The action argument effectively serves as the definition of the config data.
* It receives a mutable config data builder style object, a {@link ConfigDataSpec}.
*
* @param definition the config data definition
* @return a config data
* @throws Exception any thrown by building the config data
* @see ConfigDataSpec
*/
static ConfigData of(Action definition) throws Exception {
return definition.with(of()).build();
}
/**
* Begins building a new application configuration using a default object mapper with the supplied modules registered.
*
* @param modules the Jackson modules to register with a default object mapper
* @return the new configuration data spec
*/
static ConfigDataSpec of(Module... modules) {
return new DefaultConfigDataSpec(ServerEnvironment.env(), modules);
}
/**
* Begins building a new application configuration using a default object mapper with the supplied modules registered, from the given definition.
*
* @param modules the Jackson modules to register with a default object mapper
* @param definition the config data definition
* @return a config data
* @throws Exception any thrown by building the config data
* @see ConfigDataSpec
*/
static ConfigData of(List modules, Action definition) throws Exception {
return definition.with(of(modules.toArray(new Module[modules.size()]))).build();
}
/**
* Begins building a new application configuration using a specified object mapper.
*
* @param objectMapper the object mapper to use for configuration purposes
* @return the new configuration data spec
*/
static ConfigDataSpec of(ObjectMapper objectMapper) {
return new DefaultConfigDataSpec(ServerEnvironment.env(), objectMapper);
}
/**
* Begins building a new application configuration using a specified object mapper, from the given definition.
*
* @param objectMapper the object mapper to use for configuration purposes
* @param definition the config data definition
* @return a config data
* @throws Exception any thrown by building the config data
*/
static ConfigData of(ObjectMapper objectMapper, Action definition) throws Exception {
return definition.with(of(objectMapper)).build();
}
/**
* Binds a segment of the configuration data to the specified type.
*
* @param pointer a JSON Pointer specifying the point in the configuration data to bind from
* @param type the class of the type to bind to
* @param the type to bind to
* @return an instance of the specified type with bound configuration data
*/
default O get(String pointer, Class type) {
return getAsConfigObject(pointer, type).getObject();
}
/**
* Binds a segment of the configuration data to the specified type.
*
* @param pointer a JSON Pointer specifying the point in the configuration data to bind from
* @param type the class of the type to bind to
* @param the type to bind to
* @return a config object of the specified type with bound configuration data
*/
ConfigObject getAsConfigObject(String pointer, Class type);
/**
* Binds the root of the configuration data to the specified type.
*
* @param type the class of the type to bind to
* @param the type to bind to
* @return an instance of the specified type with bound configuration data
*/
default O get(Class type) {
return get(null, type);
}
}