Uses of Interface
ratpack.core.server.ServerConfigBuilder

Packages that use ServerConfigBuilder

Package	Description
ratpack.core.impose
ratpack.core.server	Objects used to start a ratpack application.
ratpack.groovy.server	Groovy implementations of the Ratpack server building classes.
ratpack.groovy.test.embed	Support for creating Groovy based embedded applications.
ratpack.groovy.test.handling
ratpack.spring.config
ratpack.test.embed	Support for creating embedded applications at test time, for testing Ratpack features and extensions.
ratpack.test.handling	Test fixtures for exercising Handler implementations without start a full EmbeddedApp.

Uses of ServerConfigBuilder in ratpack.core.impose

Methods in ratpack.core.impose with parameters of type ServerConfigBuilder

Modifier and Type	Method	Description
void	ServerConfigImposition.apply(ServerConfigBuilder builder)	Applies the overrides to the given builder.

Method parameters in ratpack.core.impose with type arguments of type ServerConfigBuilder

Modifier and Type	Method	Description
static ServerConfigImposition	ServerConfigImposition.of(Consumer<? super ServerConfigBuilder> overrides)	Creates an override that applies the given function to the server config builder.

Uses of ServerConfigBuilder in ratpack.core.server

Methods in ratpack.core.server that return ServerConfigBuilder

Modifier and Type	Method	Description
ServerConfigBuilder	ServerConfigBuilder.add(ConfigSource configSource)	Adds a configuration source.
ServerConfigBuilder	ServerConfigBuilder.address(InetAddress address)	Sets the address to bind to.
ServerConfigBuilder	ServerConfigBuilder.args(String[] args)	Adds the given args as a config source.
ServerConfigBuilder	ServerConfigBuilder.args(String separator, String[] args)	Invokes args(String, String, String[]), with no prefix.
ServerConfigBuilder	ServerConfigBuilder.args(String prefix, String separator, String[] args)	Adds a configuration source for the given string args.
default ServerConfigBuilder	ServerConfigBuilder.baseDir(File file)	Calls baseDir(Path) after converting the given File to a Path using File.toPath().
ServerConfigBuilder	ServerConfigBuilder.baseDir(Path baseDir)	Sets the root of the filesystem for the application.
static ServerConfigBuilder	ServerConfig.builder()
ServerConfigBuilder	ServerConfigBuilder.configureObjectMapper(Action<ObjectMapper> action)	Configures the object mapper used for binding configuration data to arbitrary objects.
ServerConfigBuilder	ServerConfigBuilder.connectQueueSize(int connectQueueSize)	The maximum amount of connections that may be waiting to be accepted at any time.
ServerConfigBuilder	ServerConfigBuilder.connectTimeoutMillis(int connectTimeoutMillis)	The connect timeout of the channel.
ServerConfigBuilder	ServerConfigBuilder.decodingErrorLevel(DecodingErrorLevel log)	Configures how to emit messages associated with errors when decoding incoming requests.
ServerConfigBuilder	ServerConfigBuilder.development(boolean development)	Whether or not the application is "development".
static ServerConfigBuilder	ServerConfig.embedded()	Creates a builder configured for development mode and an ephemeral port.
ServerConfigBuilder	ServerConfigBuilder.env()	Adds a configuration source for environment variables starting with the prefix "RATPACK_".
ServerConfigBuilder	ServerConfigBuilder.env(String prefix)	Adds a configuration source for environment variables starting with the specified prefix.
ServerConfigBuilder	ServerConfigBuilder.env(String prefix, Function<String,String> mapFunc)	Adds a configuration source for environment variables starting with the specified prefix.
ServerConfigBuilder	ServerConfigBuilder.env(EnvironmentParser environmentParser)	Adds a configuration source for environment variables using custom parsing logic.
default ServerConfigBuilder	ServerConfigBuilder.findBaseDir()	Sets the base dir using BaseDir.find().
default ServerConfigBuilder	ServerConfigBuilder.findBaseDir(String markerFilePath)	Sets the base dir using BaseDir.find(String).
ServerConfigBuilder	ServerConfigBuilder.idleTimeout(Duration idleTimeout)	The default read timeout of the channel.
ServerConfigBuilder	ServerConfigBuilder.json(com.google.common.io.ByteSource byteSource)	Adds a configuration source for a JSON file.
ServerConfigBuilder	ServerConfigBuilder.json(String path)	Adds the JSON file at the given path as a configuration source.
ServerConfigBuilder	ServerConfigBuilder.json(URL url)	Adds a configuration source for a JSON file.
ServerConfigBuilder	ServerConfigBuilder.json(Path path)	Adds a configuration source for a JSON file.
ServerConfigBuilder	ServerConfigBuilder.maxChunkSize(int maxChunkSize)	The maximum size of read chunks of request/response bodies.
ServerConfigBuilder	ServerConfigBuilder.maxContentLength(int maxContentLength)	The max number of bytes a request body can be.
ServerConfigBuilder	ServerConfigBuilder.maxHeaderSize(int maxHeaderSize)	The maximum size of all headers allowed for reading http requests.
ServerConfigBuilder	ServerConfigBuilder.maxInitialLineLength(int maxInitialLineLength)	The maximum initial line length allowed for reading http requests.
ServerConfigBuilder	ServerConfigBuilder.maxMessagesPerRead(int maxMessagesPerRead)	The maximum number of messages to read per read loop.
ServerConfigBuilder	ServerConfigBuilder.object(String path, Object object)	Adds the object's fields at the given path as a configuration source.
ServerConfigBuilder	ServerConfigBuilder.onError(Action<? super Throwable> errorHandler)	Sets the error all that will be used for added configuration sources.
ServerConfigBuilder	ServerConfigBuilder.port(int port)	Sets the port to listen for requests on.
ServerConfigBuilder	ServerConfigBuilder.portFile(Path portFile)	The path where to store the bind port.
ServerConfigBuilder	ServerConfigBuilder.props(com.google.common.io.ByteSource byteSource)	Adds a configuration source for a properties file.
ServerConfigBuilder	ServerConfigBuilder.props(String path)	Adds the properties file at the given path as a configuration source.
ServerConfigBuilder	ServerConfigBuilder.props(URL url)	Adds a configuration source for a properties file.
ServerConfigBuilder	ServerConfigBuilder.props(Path path)	Adds a configuration source for a properties file.
ServerConfigBuilder	ServerConfigBuilder.props(Map<String,String> map)	Adds a configuration source for a Map (flat key-value pairs).
ServerConfigBuilder	ServerConfigBuilder.props(Properties properties)	Adds a configuration source for a properties object.
ServerConfigBuilder	ServerConfigBuilder.publicAddress(URI publicAddress)	The public address of the application.
ServerConfigBuilder	ServerConfigBuilder.receiveBufferSize(int receiveBufferSize)	The StandardSocketOptions.SO_RCVBUF option.
ServerConfigBuilder	ServerConfigBuilder.registerShutdownHook(boolean registerShutdownHook)	Whether or not to register a JVM shutdown hook to gracefully stop the server.
ServerConfigBuilder	ServerConfigBuilder.require(String pointer, com.google.common.reflect.TypeToken<?> type)	Declares that it is required that the server config provide an object of the given type at the given path.
default ServerConfigBuilder	ServerConfigBuilder.require(String pointer, Class<?> type)	Declares that it is required that the server config provide an object of the given type at the given path.
default ServerConfigBuilder	ServerConfigBuilder.require(String pointer, Type type)	Declares that it is required that the server config provide an object of the given type at the given path.
ServerConfigBuilder	ServerConfigBuilder.ssl(io.netty.handler.ssl.SslContext sslContext)	The SSL context to use if the application serves content over HTTPS.
ServerConfigBuilder	ServerConfigBuilder.ssl(io.netty.handler.ssl.SslContext sslContext, Action<? super io.netty.util.DomainWildcardMappingBuilder<io.netty.handler.ssl.SslContext>> sniConfiguration)	Configures the SSL contexts to use based on the client requested domain if the application serves content over HTTPS.
ServerConfigBuilder	ServerConfigBuilder.ssl(io.netty.util.Mapping<String,io.netty.handler.ssl.SslContext> sniConfiguration)	Configures the SSL contexts to use based on the client requested domain if the application serves content over HTTPS.
ServerConfigBuilder	ServerConfigBuilder.sysProps()	Adds a configuration source for system properties starting with the prefix "ratpack.".
ServerConfigBuilder	ServerConfigBuilder.sysProps(String prefix)	Adds a configuration source for system properties starting with the specified prefix.
ServerConfigBuilder	ServerConfigBuilder.threads(int threads)	The number of threads to use.
ServerConfigBuilder	ServerConfigBuilder.writeSpinCount(int writeSpinCount)	The maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.
ServerConfigBuilder	ServerConfigBuilder.yaml(com.google.common.io.ByteSource byteSource)	Adds a configuration source for a YAML file.
ServerConfigBuilder	ServerConfigBuilder.yaml(String path)	Adds the YAML file at the given path as a configuration source.
ServerConfigBuilder	ServerConfigBuilder.yaml(URL url)	Adds a configuration source for a YAML file.
ServerConfigBuilder	ServerConfigBuilder.yaml(Path path)	Adds a configuration source for a YAML file.

Methods in ratpack.core.server with parameters of type ServerConfigBuilder

Modifier and Type	Method	Description
default RatpackServerSpec	RatpackServerSpec.serverConfig(ServerConfigBuilder builder)	Convenience function that builds the config from the given builder and delegates to RatpackServerSpec.serverConfig(ServerConfig).

Method parameters in ratpack.core.server with type arguments of type ServerConfigBuilder

Modifier and Type	Method	Description
static ServerConfig	ServerConfig.of(Action<? super ServerConfigBuilder> action)
default RatpackServerSpec	RatpackServerSpec.serverConfig(Action<? super ServerConfigBuilder> action)

Uses of ServerConfigBuilder in ratpack.groovy.server

Method parameters in ratpack.groovy.server with type arguments of type ServerConfigBuilder

Modifier and Type	Method	Description
GroovyRatpackServerSpec	GroovyRatpackServerSpec.serverConfig(Action<? super ServerConfigBuilder> action)

Uses of ServerConfigBuilder in ratpack.groovy.test.embed

Methods in ratpack.groovy.test.embed with parameters of type ServerConfigBuilder

Modifier and Type	Method	Description
static GroovyEmbeddedApp	GroovyEmbeddedApp.fromServer(ServerConfigBuilder serverConfig, Closure<?> definition)

Uses of ServerConfigBuilder in ratpack.groovy.test.handling

Method parameters in ratpack.groovy.test.handling with type arguments of type ServerConfigBuilder

Modifier and Type	Method	Description
GroovyRequestFixture	GroovyRequestFixture.serverConfig(Action<? super ServerConfigBuilder> action)	Configures the server config to have no base dir and given configuration.

Uses of ServerConfigBuilder in ratpack.spring.config

Methods in ratpack.spring.config that return types with arguments of type ServerConfigBuilder

Modifier and Type	Method	Description
Action<ServerConfigBuilder>	RatpackServerCustomizer.getServerConfig()
Action<ServerConfigBuilder>	RatpackServerCustomizerAdapter.getServerConfig()

Uses of ServerConfigBuilder in ratpack.test.embed

Methods in ratpack.test.embed with parameters of type ServerConfigBuilder

Modifier and Type	Method	Description
static EmbeddedApp	EmbeddedApp.fromServer(ServerConfigBuilder serverConfig, Action<? super RatpackServerSpec> definition)	Creates an embedded application using the given server config, and server creating function.

Uses of ServerConfigBuilder in ratpack.test.handling

Method parameters in ratpack.test.handling with type arguments of type ServerConfigBuilder

Modifier and Type	Method	Description
RequestFixture	RequestFixture.serverConfig(Action<? super ServerConfigBuilder> action)	Configures the server config to have no base dir and given configuration.