public interface ServerConfig extends ConfigData
Modifier and Type | Interface and Description |
---|---|
static interface |
ServerConfig.Builder |
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_MAX_CONTENT_LENGTH
The default max content length.
|
static int |
DEFAULT_PORT
The default port for Ratpack applications, 5050.
|
static int |
DEFAULT_THREADS
The default number of threads an application should use.
|
Modifier and Type | Method and Description |
---|---|
static ServerConfig.Builder |
baseDir(File baseDir)
Create a new builder, using the given file as the base dir.
|
static ServerConfig.Builder |
baseDir(Path baseDir)
Create a new builder, using the given file as the base dir.
|
static ServerConfig.Builder |
embedded()
Creates a builder configured to use no base dir, development mode and an ephemeral port.
|
static ServerConfig.Builder |
embedded(Path baseDir)
Creates a builder configured to use the given base dir, development mode and an ephemeral port.
|
static ServerConfig.Builder |
findBaseDir()
Creates a builder by finding a properties file with the default name ().
|
static ServerConfig.Builder |
findBaseDir(String markerFilePath)
Creates a builder based on a properties file with the given path either on the classpath or relative to the working directory.
|
InetAddress |
getAddress()
The address of the interface that the application should bind to.
|
FileSystemBinding |
getBaseDir()
The base dir of the application, which is also the initial
FileSystemBinding . |
int |
getMaxContentLength()
The max content length to use for the HttpObjectAggregator.
|
int |
getPort()
The port that the application should listen to requests on.
|
URI |
getPublicAddress()
The public address of the site used for redirects.
|
SSLContext |
getSSLContext()
The SSL context to use if the application will serve content over HTTPS.
|
int |
getThreads()
The number of threads for handling application requests.
|
boolean |
isDevelopment()
Whether or not the server is in "development" mode.
|
boolean |
isHasBaseDir()
Whether or not the base dir of the application has been set.
|
static ServerConfig.Builder |
noBaseDir()
Creates a builder configured to use no base dir.
|
shouldReload, toString
static final int DEFAULT_PORT
static final int DEFAULT_MAX_CONTENT_LENGTH
static final int DEFAULT_THREADS
Runtime.getRuntime().availableProcessors() * 2
.static ServerConfig.Builder embedded()
static ServerConfig.Builder embedded(Path baseDir)
baseDir
- the server base dirstatic ServerConfig.Builder noBaseDir()
static ServerConfig.Builder findBaseDir()
findBaseDir(String)
static ServerConfig.Builder findBaseDir(String markerFilePath)
The file is first searched for relative to the JVM's working directory, and then as a classpath resource via the context class loader.
If found, the file will be loaded as a properties file, where entries effectively map to methods of this builder.
The parent directory of the file will be used as the getBaseDir()
.
It is typical for the properties file to be empty, and just be used to find the base dir.
markerFilePath
- the relative path to the properties filestatic ServerConfig.Builder baseDir(Path baseDir)
baseDir
- The base dir of the launch configstatic ServerConfig.Builder baseDir(File baseDir)
baseDir
- The base dir of the launch configint getPort()
Defaults to 5050.
@Nullable InetAddress getAddress()
A value of null causes all interfaces to be bound. Defaults to null.
boolean isDevelopment()
A flag for indicating to Ratpack internals that the app is under development; diagnostics and reloading are more important than performance and security.
In development mode Ratpack will leak internal information through diagnostics and stacktraces by sending them to the response.
true
if the server is in "development" modeint getThreads()
If the value is greater than 0, a thread pool (of this size) will be created for servicing requests and doing computation.
If the value is 0 (default) or less, a thread pool of size Runtime.availableProcessors()
* 2
will be used.
This effectively sizes the ExecController.getExecutor()
thread pool size.
URI getPublicAddress()
@Nullable SSLContext getSSLContext()
null
if the application does not use SSL.int getMaxContentLength()
boolean isHasBaseDir()
FileSystemBinding getBaseDir() throws NoBaseDirException
FileSystemBinding
.NoBaseDirException
- if this launch config has no base dir set.