public interface LaunchConfig
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.
|
Modifier and Type | Method and Description |
---|---|
InetAddress |
getAddress()
The address of the interface that the application should bind to.
|
Background |
getBackground()
The “background”, for performing blocking operations.
|
FileSystemBinding |
getBaseDir()
The base dir of the application, which is also the initial
FileSystemBinding . |
ByteBufAllocator |
getBufferAllocator()
The allocator for buffers needed by the application.
|
Foreground |
getForeground()
The application foreground.
|
HandlerFactory |
getHandlerFactory()
The handler factory that can create the root handler for the application.
|
List<String> |
getIndexFiles()
The names of files that can be served if a request is made to serve a directory.
|
int |
getMaxContentLength()
The max content length to use for the HttpObjectAggregator.
|
String |
getOther(String key,
String defaultValue)
Provides access to any "other" properties that were specified.
|
Map<String,String> |
getOtherPrefixedWith(String prefix)
Provides access to all "other" properties whose name starts with a given prefix.
|
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 |
isCompressResponses()
Whether or not responses should be compressed.
|
boolean |
isReloadable()
Whether or not the server is in "reloadable" (i.e.
|
boolean |
isTimeResponses()
Indicates whether responses should include a 'X-Response-Time' header with the number of milliseconds (to 5 decimal places) it took to process the request.
|
static final int DEFAULT_PORT
static final int DEFAULT_MAX_CONTENT_LENGTH
FileSystemBinding getBaseDir()
FileSystemBinding
.HandlerFactory getHandlerFactory()
int getPort()
Defaults to 5050.
@Nullable InetAddress getAddress()
A value of null causes all interfaces to be bound. Defaults to null.
boolean isReloadable()
Different parts of the application may respond to this as they see fit.
true
if the server is in "reloadable" 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 Foreground.getExecutor()
thread pool size.
Background getBackground()
ReadOnlyContext.background(java.util.concurrent.Callable)
Foreground getForeground()
Foreground
ByteBufAllocator getBufferAllocator()
Defaults to Netty's PooledByteBufAllocator
.
URI getPublicAddress()
List<String> getIndexFiles()
@Nullable SSLContext getSSLContext()
null
if the application does not use SSL.String getOther(String key, String defaultValue)
Extensions and plugins can use other properties for their configuration.
key
- The property keydefaultValue
- The value to return if the property was not setkey
, or the defaultValue
if it is not setMap<String,String> getOtherPrefixedWith(String prefix)
The prefix is removed from keys of the result map.
prefix
- Property name prefix that should be used for filteringint getMaxContentLength()
boolean isTimeResponses()
Timing starts when processing of the request starts. That is, the number of milliseconds it took to determine the response to send to the client. It does not include the time taken to send the response over the wire.
boolean isCompressResponses()