ratpack.server.ServerConfigBuilder 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.server;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.io.ByteSource;
import com.google.common.reflect.TypeToken;
import io.netty.handler.ssl.SslContext;
import io.netty.handler.ssl.SslContextBuilder;
import ratpack.config.ConfigData;
import ratpack.config.ConfigDataBuilder;
import ratpack.config.ConfigSource;
import ratpack.config.EnvironmentParser;
import ratpack.exec.ExecController;
import ratpack.exec.ExecInitializer;
import ratpack.exec.ExecInterceptor;
import ratpack.func.Action;
import ratpack.func.Function;
import ratpack.impose.ServerConfigImposition;
import ratpack.util.Types;
import javax.net.ssl.SSLContext;
import java.io.File;
import java.lang.reflect.Type;
import java.net.InetAddress;
import java.net.URI;
import java.net.URL;
import java.nio.file.Path;
import java.time.Duration;
import java.util.Map;
import java.util.Properties;
/**
* Builds a {@link ServerConfig}.
*
* @see RatpackServerSpec#serverConfig(Action)
* @see ServerConfigImposition
*/
public interface ServerConfigBuilder extends ConfigDataBuilder {
/**
* Sets the root of the filesystem for the application.
*
* The {@link ServerConfig#getBaseDir() base dir} acts as the portable file system for the application.
* All paths within the application, resolved by Ratpack API are resolved from this point.
* For example, {@link ratpack.handling.Chain#files(Action)} allows serving static files within the base dir.
*
* The base dir is also used to resolve paths to file system locations when using {@link #json(String)}, {@link #yaml(String)} and {@link #props(String)}.
* This allows config files to travel with the application within the base dir.
*
* It is generally desirable to use the {@link BaseDir#find()} to dynamically find the base dir at runtime.
*
* @param baseDir the base dir
* @return {@code this}
*/
ServerConfigBuilder baseDir(Path baseDir);
/**
* Calls {@link #baseDir(Path)} after converting the given {@code File} to a {@code Path} using {@link File#toPath()}.
*
* @param file the base dir
* @return {@code this}
*/
default ServerConfigBuilder baseDir(File file) {
return baseDir(file.toPath());
}
/**
* Sets the base dir using {@link BaseDir#find()}.
*
* @return {@code this}
* @since 1.4
*/
default ServerConfigBuilder findBaseDir() {
return baseDir(BaseDir.find());
}
/**
* Sets the base dir using {@link BaseDir#find(String)}.
*
* @param markerFilePath the path to the marker file on the classpath
* @return {@code this}
* @since 1.4
*/
default ServerConfigBuilder findBaseDir(String markerFilePath) {
return baseDir(BaseDir.find(markerFilePath));
}
/**
* Indicates whether the server should inherit an exec controller from the environment.
*
* This is equivalent to calling {@link #execController(ExecController)} with {@link ExecController#require()}.
*
* @param inheritExecController whether to inherit the exec controller from the environment
* @return {@code this}
* @since 1.10
*/
ServerConfigBuilder inheritExecController(boolean inheritExecController);
/**
* Specifies that this server should inherit the given exec controller instead of creating one.
*
* This can be used when embedded a Ratpack server inside another Ratpack server,
* to reuse the same thread pools.
*
* Any {@link ExecInitializer} or {@link ExecInterceptor} implementations specified as part of this server will be ignored.
* Initializers and interceptors specified as part of the application that the given exec controller came from will be used.
*
* @param execController the exec controller to inherit
* @return {@code this}
* @since 1.10
*/
ServerConfigBuilder execController(ExecController execController);
/**
* Sets the port to listen for requests on.
*
* Defaults to 5050.
*
* @param port the port to listen for requests on
* @return {@code this}
* @see ratpack.server.ServerConfig#getPort()
*/
ServerConfigBuilder port(int port);
/**
* Sets the address to bind to.
*
* Default value is {@code null}.
*
* @param address The address to bind to
* @return {@code this}
* @see ServerConfig#getAddress()
*/
ServerConfigBuilder address(InetAddress address);
/**
* Whether or not the application is "development".
*
* Default value is {@code false}.
*
* @param development Whether or not the application is "development".
* @return {@code this}
* @see ServerConfig#isDevelopment()
*/
ServerConfigBuilder development(boolean development);
/**
* The number of threads to use.
*
* Defaults to {@link ServerConfig#DEFAULT_THREADS}
*
* @param threads the size of the event loop thread pool
* @return {@code this}
* @see ServerConfig#getThreads()
*/
ServerConfigBuilder threads(int threads);
/**
* Whether or not to register a JVM shutdown hook to gracefully stop the server.
*
* Default value is {@code true}.
*
* @param registerShutdownHook whether to register or not
* @return {@code this}
* @see ServerConfig#isRegisterShutdownHook()
* @since 1.6
*/
ServerConfigBuilder registerShutdownHook(boolean registerShutdownHook);
/**
* The public address of the application.
*
* Default value is {@code null}.
*
* @param publicAddress the public address of the application
* @return {@code this}
* @see ServerConfig#getPublicAddress()
*/
ServerConfigBuilder publicAddress(URI publicAddress);
/**
* The max number of bytes a request body can be.
*
* Default value is {@code 1048576} (1 megabyte).
*
* @param maxContentLength the max content length to accept
* @return {@code this}
* @see ServerConfig#getMaxContentLength()
*/
ServerConfigBuilder maxContentLength(int maxContentLength);
/**
* The maximum size of read chunks of request/response bodies.
*
* Default value is {@link ServerConfig#DEFAULT_MAX_CHUNK_SIZE}.
*
* @param maxChunkSize the maximum size of read chunks of request/response bodies
* @return {@code this}
* @see ServerConfig#getMaxChunkSize()
*/
ServerConfigBuilder maxChunkSize(int maxChunkSize);
/**
* The maximum initial line length allowed for reading http requests.
*
* Default value is {@link ServerConfig#DEFAULT_MAX_INITIAL_LINE_LENGTH}.
*
* @param maxInitialLineLength the maximum length of the initial line of the request.
* @return {@code this}
* @see ServerConfig#getMaxInitialLineLength()
* @since 1.4
*/
ServerConfigBuilder maxInitialLineLength(int maxInitialLineLength);
/**
* The maximum size of all headers allowed for reading http requests.
*
* Default value is {@link ServerConfig#DEFAULT_MAX_HEADER_SIZE}.
*
* @param maxHeaderSize the maximum size of the sum of the length of all headers.
* @return {@code this}
* @see ServerConfig#getMaxHeaderSize()
* @since 1.4
*/
ServerConfigBuilder maxHeaderSize(int maxHeaderSize);
/**
* The connect timeout of the channel.
*
* @param connectTimeoutMillis the connect timeout in milliseconds
* @return {@code this}
* @see ServerConfig#getConnectTimeoutMillis()
*/
ServerConfigBuilder connectTimeoutMillis(int connectTimeoutMillis);
/**
* Whether to enable TCP keep-alive for connections.
*
* @param tcpKeepAlive whether to enable TCP keep-alive for connections
* @return {@code this}
* @see ServerConfig#isTcpKeepAlive()
*/
ServerConfigBuilder tcpKeepAlive(boolean tcpKeepAlive);
/**
* The default read timeout of the channel.
*
* @param idleTimeout the idleTimeout ({@link Duration#ZERO} = no timeout, must not be negative, must not be null)
* @return {@code this}
* @see ServerConfig#getIdleTimeout()
* @since 1.5
*/
ServerConfigBuilder idleTimeout(Duration idleTimeout);
/**
* The maximum number of messages to read per read loop.
*
* @param maxMessagesPerRead the max messages per read
* @return {@code this}
* @see ServerConfig#getMaxMessagesPerRead()
*/
ServerConfigBuilder maxMessagesPerRead(int maxMessagesPerRead);
/**
* The StandardSocketOptions.SO_RCVBUF option.
*
* @param receiveBufferSize the recieve buffer size
* @return {@code this}
* @see ServerConfig#getReceiveBufferSize()
*/
ServerConfigBuilder receiveBufferSize(int receiveBufferSize);
/**
* The maximum amount of connections that may be waiting to be accepted at any time.
*
* This is effectively the {@code SO_BACKLOG} standard socket parameter.
* If the queue is full (i.e. there are too many pending connections), connection attempts will be rejected.
* Established connections are not part of this queue so do not contribute towards the limit.
*
* The default value is platform specific, but usually either 200 or 128.
* Most application do not need to change this default.
*
* @param connectQueueSize connection queue size
* @since 1.5
*/
ServerConfigBuilder connectQueueSize(int connectQueueSize);
/**
* The maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.
*
* @param writeSpinCount the write spin count
* @return {@code this}
* @see ServerConfig#getWriteSpinCount()
*/
ServerConfigBuilder writeSpinCount(int writeSpinCount);
/**
* The path where to store the bind port.
*
* @param portFile the path file
* @return {@code this}
* @see ServerConfig#getPortFile()
* @since 1.8
*/
ServerConfigBuilder portFile(Path portFile);
/**
* The SSL context to use if the application serves content over HTTPS.
*
* @param sslContext the SSL context
* @return {@code this}
* @see ratpack.ssl.SSLContexts
* @see ServerConfig#getSslContext()
* @deprecated since 1.5, replaced by {@link #ssl(SslContext)}
*/
@Deprecated
ServerConfigBuilder ssl(SSLContext sslContext);
/**
* The server needs client SSL authentication.
*
* @param requireClientSslAuth whether or not server needs client SSL authentication
* @return {@code this}
* @deprecated since 1.5, prefer {@link #ssl(SslContext)}
*/
@Deprecated
ServerConfigBuilder requireClientSslAuth(boolean requireClientSslAuth);
/**
* The SSL context to use if the application serves content over HTTPS.
*
* @param sslContext the SSL context
* @return {@code this}
* @see SslContextBuilder
* @since 1.5
*/
ServerConfigBuilder ssl(SslContext sslContext);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder env();
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder env(String prefix);
/**
* Adds the given args as a config source.
*
* This method is designed to be used with the args var of the {@code static main(String... args)} application entry point.
* This allows configuration parameters to be passed to the application on the command line.
*
* Each arg should be of the format {@code «key»=«value»}.
* For the following example, the application has been started with the argument {@code thing.name=foo}.
*
*
{@code
* import ratpack.test.embed.EmbeddedApp;
* import static org.junit.Assert.assertEquals;
*
* public class Example {
* static class Thing {
* public String name;
* }
*
* public static void main(String... args) throws Exception {
* EmbeddedApp.of(a -> a
* .serverConfig(s -> s
* .args(args)
* .require("/thing", Thing.class)
* )
* .handlers(c -> c
* .get(ctx -> ctx.render(ctx.get(Thing.class).name))
* )
* ).test(httpClient ->
* assertEquals(httpClient.getText(), "foo")
* );
* }
* }
* }
*
* @param args the argument values
* @return {@code this}
* @since 1.1
*/
@Override
ServerConfigBuilder args(String[] args);
/**
* Invokes {@link #args(String, String, String[])}, with no prefix.
*
* @param separator the separator of the key and value in each arg
* @param args the argument values
* @return {@code this}
* @see #args(String[])
* @since 1.1
*/
@Override
ServerConfigBuilder args(String separator, String[] args);
/**
* Adds a configuration source for the given string args.
*
* Args that do not start with the given {@code prefix} are ignored.
* The remaining are each split using the given {@code separator} (as a literal string, not as a regex),
* then trimmed of the prefix.
*
* @param prefix the prefix that each arg must have to be considered (use {@code null} or {@code ""} for no prefix)
* @param separator the separator between the key and the value
* @param args the argument values
* @return {@code this}
* @see #args(String[])
* @since 1.1
*/
@Override
ServerConfigBuilder args(String prefix, String separator, String[] args);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder props(ByteSource byteSource);
/**
* Adds the properties file at the given path as a configuration source.
*
* If a base dir is set, the path will be resolved relative to it.
* Otherwise, it will be resolved relative to the file system root.
*
* @param path the path to the file
* @return {@code this}
*/
@Override
ServerConfigBuilder props(String path);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder props(Path path);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder props(Properties properties);
/**
* {@inheritDoc}
*
* @since 1.4
*/
@Override
ServerConfigBuilder object(String path, Object object);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder props(Map map);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder props(URL url);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder sysProps();
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder sysProps(String prefix);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder onError(Action errorHandler);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder configureObjectMapper(Action action);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder add(ConfigSource configSource);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder env(String prefix, Function mapFunc);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder env(EnvironmentParser environmentParser);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder json(ByteSource byteSource);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder json(Path path);
/**
* Adds the JSON file at the given path as a configuration source.
*
* If a base dir is set, the path will be resolved relative to it.
* Otherwise, it will be resolved relative to the file system root.
*
* @param path the path to the file
* @return {@code this}
*/
@Override
ServerConfigBuilder json(String path);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder json(URL url);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder yaml(ByteSource byteSource);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder yaml(Path path);
/**
* Adds the YAML file at the given path as a configuration source.
*
* If a base dir is set, the path will be resolved relative to it.
* Otherwise, it will be resolved relative to the file system root.
*
* @param path the path to the file
* @return {@code this}
*/
@Override
ServerConfigBuilder yaml(String path);
/**
* {@inheritDoc}
*/
@Override
ServerConfigBuilder yaml(URL url);
/**
* Declares that it is required that the server config provide an object of the given type at the given path.
*
* The {@link #build()} method will fail if the config is not able to provide the requested object.
*
* All objects declared using this method will also automatically be implicitly added to the base registry.
*
* The {@code pointer} argument is of the same format given to the {@link ConfigData#get(String, Class)} method.
*
{@code
* import org.junit.Assert;
* import ratpack.test.embed.EmbeddedApp;
*
* import java.util.Collections;
*
* public class Example {
* static class MyConfig {
* public String value;
* }
*
* public static void main(String... args) throws Exception {
* EmbeddedApp.of(a -> a
* .serverConfig(s -> s
* .props(Collections.singletonMap("config.value", "foo"))
* .require("/config", MyConfig.class)
* )
* .handlers(c -> c
* .get(ctx -> ctx.render(ctx.get(MyConfig.class).value))
* )
* ).test(httpClient ->
* Assert.assertEquals("foo", httpClient.getText())
* );
* }
* }
* }
*
* @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
* @return {@code this}
*/
default ServerConfigBuilder require(String pointer, Class type) {
return require(pointer, Types.token(type));
}
/**
* Declares that it is required that the server config provide an object of the given type at the given path.
*
* @param pointer a JSON Pointer specifying the point in the configuration data to bind from
* @param type the type to bind to
* @return {@code this}
* @since 1.4
*/
default ServerConfigBuilder require(String pointer, Type type) {
return require(pointer, Types.token(type));
}
/**
* Declares that it is required that the server config provide an object of the given type at the given path.
*
* @param pointer a JSON Pointer specifying the point in the configuration data to bind from
* @param type the type to bind to
* @return {@code this}
* @since 1.4
*/
ServerConfigBuilder require(String pointer, TypeToken type);
/**
* Builds the server config.
*
* @return a server config
* @see ServerConfigImposition
*/
@Override
ServerConfig build();
}