ServerConfig.Builder (ratpack-core 0.9.17 API)

All Superinterfaces:: ConfigDataSpec

Enclosing interface:: ServerConfig

public static interface ServerConfig.Builder
extends ConfigDataSpec

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_BASE_DIR_MARKER_FILE_PATH` The default name for the base dir sentinel properties file.
`static String`	`DEFAULT_ENV_PREFIX`
`static String`	`DEFAULT_PROP_PREFIX`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ServerConfig.Builder`	`add(ConfigSource configSource)` Adds a configuration source.
`ServerConfig.Builder`	`address(InetAddress address)` Sets the address to bind to.
`ServerConfig`	`build()` Builds the server config.
`ServerConfig.Builder`	`configureObjectMapper(Action<ObjectMapper> action)` Configures the object mapper used for binding configuration data to arbitrary objects.
`ServerConfig.Builder`	`development(boolean development)` Whether or not the application is "development".
`ServerConfig.Builder`	`env()` Adds a configuration source for environment variables starting with the prefix "RATPACK_".
`ServerConfig.Builder`	`env(EnvironmentParser environmentParser)` Adds a configuration source for environment variables using custom parsing logic.
`ServerConfig.Builder`	`env(String prefix)` Adds a configuration source for environment variables starting with the specified prefix.
`ServerConfig.Builder`	`env(String prefix, Function<String,String> mapFunc)` Adds a configuration source for environment variables starting with the specified prefix.
`ServerConfig.Builder`	`json(ByteSource byteSource)` Adds a configuration source for a JSON file.
`ServerConfig.Builder`	`json(Path path)` Adds a configuration source for a JSON file.
`ServerConfig.Builder`	`json(String path)` Adds a configuration source for a JSON file.
`ServerConfig.Builder`	`json(URL url)` Adds a configuration source for a JSON file.
`ServerConfig.Builder`	`maxContentLength(int maxContentLength)` The max number of bytes a request body can be.
`ServerConfig.Builder`	`onError(Action<? super Throwable> errorHandler)` Sets the error handler that will be used for added configuration sources.
`ServerConfig.Builder`	`port(int port)` Sets the port to listen for requests on.
`ServerConfig.Builder`	`props(ByteSource byteSource)` Adds a configuration source for a properties file.
`ServerConfig.Builder`	`props(Map<String,String> map)` Adds a configuration source for a Map (flat key-value pairs).
`ServerConfig.Builder`	`props(Path path)` Adds a configuration source for a properties file.
`ServerConfig.Builder`	`props(Properties properties)` Adds a configuration source for a properties object.
`ServerConfig.Builder`	`props(String path)` Adds a configuration source for a properties file.
`ServerConfig.Builder`	`props(URL url)` Adds a configuration source for a properties file.
`ServerConfig.Builder`	`publicAddress(URI publicAddress)` The public address of the application.
`ServerConfig.Builder`	`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.
`ServerConfig.Builder`	`ssl(SSLContext sslContext)` The SSL context to use if the application serves content over HTTPS.
`ServerConfig.Builder`	`sysProps()` Adds a configuration source for system properties starting with the prefix "ratpack.".
`ServerConfig.Builder`	`sysProps(String prefix)` Adds a configuration source for system properties starting with the specified prefix.
`ServerConfig.Builder`	`threads(int threads)` The number of threads to use.
`ServerConfig.Builder`	`yaml(ByteSource byteSource)` Adds a configuration source for a YAML file.
`ServerConfig.Builder`	`yaml(Path path)` Adds a configuration source for a YAML file.
`ServerConfig.Builder`	`yaml(String path)` Adds a configuration source for a YAML file.
`ServerConfig.Builder`	`yaml(URL url)` Adds a configuration source for a YAML file.

Methods inherited from interface ratpack.config.ConfigDataSpec
getConfigSources, getObjectMapper

- Field Detail
  - DEFAULT_ENV_PREFIX
```
static final String DEFAULT_ENV_PREFIX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PROP_PREFIX
```
static final String DEFAULT_PROP_PREFIX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BASE_DIR_MARKER_FILE_PATH
```
static final String DEFAULT_BASE_DIR_MARKER_FILE_PATH
```
    The default name for the base dir sentinel properties file.
    Value: ".ratpack"
    
    See Also:
    
    ServerConfig.findBaseDir(), Constant Field Values
- Method Detail
  - port
```
ServerConfig.Builder port(int port)
```
    Sets the port to listen for requests on.
    Defaults to .
    
    Parameters:
    
    port - the port to listen for requests on
    
    Returns:
    
    this
    
    See Also:
    
    ServerConfig.getPort()
  - address
```
ServerConfig.Builder address(InetAddress address)
```
    Sets the address to bind to.
    Default value is null.
    
    Parameters:
    
    address - The address to bind to
    
    Returns:
    
    this
    
    See Also:
    
    ServerConfig.getAddress()
  - development
```
ServerConfig.Builder development(boolean development)
```
    Whether or not the application is "development".
    Default value is false.
    
    Parameters:
    
    development - Whether or not the application is "development".
    
    Returns:
    
    this
    
    See Also:
    
    ServerConfig.isDevelopment()
  - threads
```
ServerConfig.Builder threads(int threads)
```
    The number of threads to use.
    Defaults to ServerConfig.DEFAULT_THREADS
    
    Parameters:
    
    threads - the size of the event loop thread pool
    
    Returns:
    
    this
    
    See Also:
    
    ServerConfig.getThreads()
  - publicAddress
```
ServerConfig.Builder publicAddress(URI publicAddress)
```
    The public address of the application.
    Default value is null.
    
    Parameters:
    
    publicAddress - the public address of the application
    
    Returns:
    
    this
    
    See Also:
    
    ServerConfig.getPublicAddress()
  - maxContentLength
```
ServerConfig.Builder maxContentLength(int maxContentLength)
```
    The max number of bytes a request body can be. Default value is 1048576 (1 megabyte).
    
    Parameters:
    
    maxContentLength - the max content length to accept
    
    Returns:
    
    this
    
    See Also:
    
    ServerConfig.getMaxContentLength()
  - ssl
```
ServerConfig.Builder ssl(SSLContext sslContext)
```
    The SSL context to use if the application serves content over HTTPS.
    
    Parameters:
    
    sslContext - the SSL context
    
    Returns:
    
    this
    
    See Also:
    
    SSLContexts, ServerConfig.getSSLContext()
  - env
```
ServerConfig.Builder env()
```
    Adds a configuration source for environment variables starting with the prefix "RATPACK_". The prefix will be removed before loading the data. The environment variable name is split into per-object segments using double underscore as an object boundary. Segments are transformed into camel-case field names using a single underscore as a word boundary.
    
    Specified by:
    
    env in interface ConfigDataSpec
    
    Returns:
    
    this
  - env
```
ServerConfig.Builder env(String prefix)
```
    Adds a configuration source for environment variables starting with the specified prefix. The prefix will be removed before loading the data. The environment variable name is split into per-object segments using double underscore as an object boundary. Segments are transformed into camel-case field names using a single underscore as a word boundary.
    
    Specified by:
    
    env in interface ConfigDataSpec
    
    Parameters:
    
    prefix - the prefix which should be used to identify relevant environment variables
    
    Returns:
    
    this
  - props
```
ServerConfig.Builder props(ByteSource byteSource)
```
    Adds a configuration source for a properties file.
    
    Specified by:
    
    props in interface ConfigDataSpec
    
    Parameters:
    
    byteSource - the source of the properties data
    
    Returns:
    
    this
  - props
```
ServerConfig.Builder props(String path)
```
    Adds a configuration source for a properties file.
    
    Specified by:
    
    props in interface ConfigDataSpec
    
    Parameters:
    
    path - the path to the source of the properties data
    
    Returns:
    
    this
  - props
```
ServerConfig.Builder props(Path path)
```
    Adds a configuration source for a properties file.
    
    Specified by:
    
    props in interface ConfigDataSpec
    
    Parameters:
    
    path - the source of the properties data
    
    Returns:
    
    this
  - props
```
ServerConfig.Builder props(Properties properties)
```
    Adds a configuration source for a properties object.
    
    Specified by:
    
    props in interface ConfigDataSpec
    
    Parameters:
    
    properties - the properties object
    
    Returns:
    
    this
  - props
```
ServerConfig.Builder props(Map<String,String> map)
```
    Adds a configuration source for a Map (flat key-value pairs). This signature is particularly useful for providing default values as shown below:
```
import com.google.common.collect.ImmutableMap;
 import ratpack.config.ConfigData;
 import ratpack.server.ServerConfig;
 import static org.junit.Assert.*;

 public class Example {
   public static void main(String[] args) throws Exception {
     ServerConfig serverConfig = ServerConfig
       .noBaseDir()
       .props(ImmutableMap.of("server.port", "5060"))
       .sysProps()
       .build();
     assertEquals(5060, serverConfig.getPort());
   }
 }
 
```
    Specified by:
    
    props in interface ConfigDataSpec
    
    Parameters:
    
    map - the map
    
    Returns:
    
    this
  - props
```
ServerConfig.Builder props(URL url)
```
    Adds a configuration source for a properties file.
    
    Specified by:
    
    props in interface ConfigDataSpec
    
    Parameters:
    
    url - the source of the properties data
    
    Returns:
    
    this
  - sysProps
```
ServerConfig.Builder sysProps()
```
    Adds a configuration source for system properties starting with the prefix "ratpack.".
    
    Specified by:
    
    sysProps in interface ConfigDataSpec
    
    Returns:
    
    this
  - sysProps
```
ServerConfig.Builder sysProps(String prefix)
```
    Adds a configuration source for system properties starting with the specified prefix.
    
    Specified by:
    
    sysProps in interface ConfigDataSpec
    
    Parameters:
    
    prefix - the prefix which should be used to identify relevant system properties; the prefix will be removed before loading the data
    
    Returns:
    
    this
  - onError
```
ServerConfig.Builder onError(Action<? super Throwable> errorHandler)
```
    Sets the error handler that will be used for added configuration sources. The error handler only applies to configuration sources added after this method is called; it is not applied retroactively.
    
    Specified by:
    
    onError in interface ConfigDataSpec
    
    Parameters:
    
    errorHandler - the error handler
    
    Returns:
    
    this
    
    See Also:
    
    Action.noop(), Action.throwException()
  - configureObjectMapper
```
ServerConfig.Builder configureObjectMapper(Action<ObjectMapper> action)
```
    Configures the object mapper used for binding configuration data to arbitrary objects.
    
    Specified by:
    
    configureObjectMapper in interface ConfigDataSpec
    
    Parameters:
    
    action - an action to perform upon the object mapper
    
    Returns:
    
    this
  - add
```
ServerConfig.Builder add(ConfigSource configSource)
```
    Adds a configuration source.
    
    Specified by:
    
    add in interface ConfigDataSpec
    
    Parameters:
    
    configSource - the configuration source to add
    
    Returns:
    
    this
  - env
```
ServerConfig.Builder env(String prefix,
                         Function<String,String> mapFunc)
```
    Adds a configuration source for environment variables starting with the specified prefix. The prefix will be removed before loading the data. The environment variable name is split into per-object segments using double underscore as an object boundary. Segments are transformed into field names using the specified transformation function rather than the default function.
    
    Specified by:
    
    env in interface ConfigDataSpec
    
    Parameters:
    
    prefix - the prefix which should be used to identify relevant environment variables
    
    mapFunc - the function to transform segments into field names
    
    Returns:
    
    this
  - env
```
ServerConfig.Builder env(EnvironmentParser environmentParser)
```
    Adds a configuration source for environment variables using custom parsing logic.
    
    Specified by:
    
    env in interface ConfigDataSpec
    
    Parameters:
    
    environmentParser - the parser to use to interpret environment variables
    
    Returns:
    
    this
  - json
```
ServerConfig.Builder json(ByteSource byteSource)
```
    Adds a configuration source for a JSON file.
    
    Specified by:
    
    json in interface ConfigDataSpec
    
    Parameters:
    
    byteSource - the source of the JSON data
    
    Returns:
    
    this
  - json
```
ServerConfig.Builder json(Path path)
```
    Adds a configuration source for a JSON file.
    
    Specified by:
    
    json in interface ConfigDataSpec
    
    Parameters:
    
    path - the source of the JSON data
    
    Returns:
    
    this
  - json
```
ServerConfig.Builder json(String path)
```
    Adds a configuration source for a JSON file.
    
    Specified by:
    
    json in interface ConfigDataSpec
    
    Parameters:
    
    path - the path to the source of the JSON data
    
    Returns:
    
    this
  - json
```
ServerConfig.Builder json(URL url)
```
    Adds a configuration source for a JSON file.
    
    Specified by:
    
    json in interface ConfigDataSpec
    
    Parameters:
    
    url - the source of the JSON data
    
    Returns:
    
    this
  - yaml
```
ServerConfig.Builder yaml(ByteSource byteSource)
```
    Adds a configuration source for a YAML file.
    
    Specified by:
    
    yaml in interface ConfigDataSpec
    
    Parameters:
    
    byteSource - the source of the YAML data
    
    Returns:
    
    this
  - yaml
```
ServerConfig.Builder yaml(Path path)
```
    Adds a configuration source for a YAML file.
    
    Specified by:
    
    yaml in interface ConfigDataSpec
    
    Parameters:
    
    path - the source of the YAML data
    
    Returns:
    
    this
  - yaml
```
ServerConfig.Builder yaml(String path)
```
    Adds a configuration source for a YAML file.
    
    Specified by:
    
    yaml in interface ConfigDataSpec
    
    Parameters:
    
    path - the path to the source of the YAML data
    
    Returns:
    
    this
  - yaml
```
ServerConfig.Builder yaml(URL url)
```
    Adds a configuration source for a YAML file.
    
    Specified by:
    
    yaml in interface ConfigDataSpec
    
    Parameters:
    
    url - the source of the YAML data
    
    Returns:
    
    this
  - require
```
ServerConfig.Builder 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.
    The 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 pointer argument is of the same format given to the ConfigData.get(String, Class) method.
```
import junit.framework.Assert;
 import ratpack.server.ServerConfig;
 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(ServerConfig.embedded()
             .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())
     );
   }
 }
 
```
    Parameters:
    
    pointer - a JSON Pointer specifying the point in the configuration data to bind from
    
    type - the class of the type to bind to
    
    Returns:
    
    this
  - build
```
ServerConfig build()
```
    Builds the server config.
    
    Specified by:
    
    build in interface ConfigDataSpec
    
    Returns:
    
    a server config

Interface ServerConfig.Builder

Field Summary

Method Summary

Methods inherited from interface ratpack.config.ConfigDataSpec

Field Detail

DEFAULT_ENV_PREFIX

DEFAULT_PROP_PREFIX

DEFAULT_BASE_DIR_MARKER_FILE_PATH

Method Detail

port

address

development

threads

publicAddress

maxContentLength

ssl

env

env

props

props

props

props

props

props

sysProps

sysProps

onError

configureObjectMapper

add

env

env

json

json

json

json

yaml

yaml

yaml

yaml

require

build