ratpack.launch.LaunchConfig Maven / Gradle / Ivy
/*
* Copyright 2013 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.launch;
import com.google.common.collect.ImmutableSet;
import io.netty.buffer.ByteBufAllocator;
import ratpack.api.Nullable;
import ratpack.exec.ExecController;
import ratpack.file.FileSystemBinding;
import javax.net.ssl.SSLContext;
import java.net.InetAddress;
import java.net.URI;
import java.util.List;
import java.util.Map;
/**
* The configuration used to launch a server.
*
* @see LaunchConfigBuilder
* @see LaunchConfigs
* @see ratpack.server.RatpackServerBuilder#build(LaunchConfig)
*/
public interface LaunchConfig {
/**
* The default port for Ratpack applications, {@value}.
*/
public static final int DEFAULT_PORT = 5050;
/**
* The default max content length.
*/
public int DEFAULT_MAX_CONTENT_LENGTH = 1048576;
/**
* The default number of threads an application should use.
*
* Calculated as {@code Runtime.getRuntime().availableProcessors() * 2}.
*/
public int DEFAULT_THREADS = Runtime.getRuntime().availableProcessors() * 2;
/**
* The default compression minimum size in bytes, {@value}.
*/
public long DEFAULT_COMPRESSION_MIN_SIZE = 1024;
/**
* The base dir of the application, which is also the initial {@link ratpack.file.FileSystemBinding}.
*
* @return The base dir of the application.
* @throws NoBaseDirException if this launch config has no base dir set.
*/
public FileSystemBinding getBaseDir() throws NoBaseDirException;
/**
* The handler factory that can create the root handler for the application.
*
* @return The handler factory that can create the root handler for the application.
* @throws NoHandlerFactoryException if no handler factory was defined (i.e. this launch config isn't used for a HTTP server)
*/
public HandlerFactory getHandlerFactory() throws NoHandlerFactoryException;
/**
* The port that the application should listen to requests on.
*
* Defaults to {@value #DEFAULT_PORT}.
*
* @return The port that the application should listen to requests on.
*/
public int getPort();
/**
* The address of the interface that the application should bind to.
*
* A value of null causes all interfaces to be bound. Defaults to null.
*
* @return The address of the interface that the application should bind to.
*/
@Nullable
public InetAddress getAddress();
/**
* Whether or not the server is in "reloadable" (i.e. development) mode.
*
* Different parts of the application may respond to this as they see fit.
*
* @return {@code true} if the server is in "reloadable" mode
*/
public boolean isReloadable();
/**
* The number of threads for handling application requests.
*
* 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 {@link Runtime#availableProcessors()} {@code * 2} will be used.
*
* This effectively sizes the {@link ratpack.exec.ExecController#getExecutor()} thread pool size.
*
* @return the number of threads for handling application requests.
*/
public int getThreads();
/**
* The execution controller.
*
* @return the execution controller
*/
public ExecController getExecController();
/**
* The allocator for buffers needed by the application.
*
* Defaults to Netty's {@link io.netty.buffer.PooledByteBufAllocator}.
*
* @return The allocator for buffers needed by the application.
*/
public ByteBufAllocator getBufferAllocator();
/**
* The public address of the site used for redirects.
*
* @return The url of the public address
*/
public URI getPublicAddress();
/**
* The names of files that can be served if a request is made to serve a directory.
*
* @return The names of files that can be served if a request is made to serve a directory.
*/
public List getIndexFiles();
/**
* The SSL context to use if the application will serve content over HTTPS.
*
* @return The SSL context or null if the application does not use SSL.
*/
@Nullable
public SSLContext getSSLContext();
/**
* Provides access to any "other" properties that were specified.
*
* Extensions and plugins can use other properties for their configuration.
*
* @param key The property key
* @param defaultValue The value to return if the property was not set
* @return The other property for {@code key}, or the {@code defaultValue} if it is not set
*/
public String getOther(String key, String defaultValue);
/**
* Provides access to all "other" properties whose name starts with a given prefix.
*
* The prefix is removed from keys of the result map.
*
* @param prefix Property name prefix that should be used for filtering
* @return A map of all "other" properties whose name starts with the prefix with the prefix removed from key names
*/
public Map getOtherPrefixedWith(String prefix);
/**
* The max content length to use for the HttpObjectAggregator.
*
* @return The max content length as an int.
*/
public int getMaxContentLength();
/**
* 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.
*
* 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.
*/
public boolean isTimeResponses();
/**
* Whether or not responses should be compressed.
*
* @return whether or not responses should be compressed.
*/
public boolean isCompressResponses();
/**
* The minimum size at which responses should be compressed, in bytes.
*
* @return the minimum size at which responses should be compressed.
*/
public long getCompressionMinSize();
/**
* The response mime types which should be compressed.
*
* If {@code null}, defaults to all mime types not on the black list.
*
* @return the response mime types which should be compressed.
*/
@Nullable
public ImmutableSet getCompressionMimeTypeWhiteList();
/**
* The response mime types which should not be compressed.
*
* If {@code null}, uses a default that excludes many commonly used compressed types.
*
* @return the response mime types which should not be compressed.
*/
@Nullable
public ImmutableSet getCompressionMimeTypeBlackList();
/**
* Whether or not the base dir of the application has been set.
*
* @return whether or not the base dir of the application has been set.
*/
public boolean isHasBaseDir();
}