io.jooby

Class ServerOptions

java.lang.Object

io.jooby.ServerOptions

public class ServerOptions
extends Object

Available server options.

Since:

2.0.0

Author:

edgar

Field Summary

Fields

Modifier and Type	Field and Description
static int	_10MB 10mb constant in bytes.
static int	_16KB 16kb constant in bytes.
static int	_4KB 4kb constant in bytes.
static int	_8KB 8kb constant in bytes.
static int	DEFAULT_COMPRESSION_LEVEL Default compression level for gzip.
static int	IO_THREADS Number of available threads, but never smaller than 2.
static int	SERVER_PORT Default application port 8080 or the value of system property server.port.
static int	SEVER_SECURE_PORT Default application secure port 8443 or the value of system property server.securePort.
static int	WORKER_THREADS Number of worker (a.k.a application) threads.

Constructor Summary

Constructors

Constructor and Description
ServerOptions()

Method Summary

Modifier and Type	Method and Description
static Optional<ServerOptions>	from(com.typesafe.config.Config conf) Creates server options from config object.
int	getBufferSize() Server buffer size in bytes.
Integer	getCompressionLevel() Indicates compression level to use while producing gzip responses.
boolean	getDefaultHeaders() True if default headers: Date, Content-Type and Server are enabled.
boolean	getGzip() Deprecated. In favor of getCompressionLevel().
String	getHost() Server host, defaults is 0.0.0.0.
int	getIoThreads() Number of IO threads used by the server.
int	getIoThreads(int defaultIoThreads) Number of IO threads used by the server.
int	getMaxRequestSize() Maximum request size in bytes.
int	getPort() Server HTTP port.
Integer	getSecurePort() HTTPs port or null.
String	getServer() Server name.
SslOptions	getSsl() SSL options.
SSLContext	getSSLContext(ClassLoader loader) Creates SSL context using the given resource loader.
int	getWorkerThreads() Number of worker threads (a.k.a application) to use.
int	getWorkerThreads(int defaultWorkerThreads) Number of worker threads (a.k.a application) to use.
boolean	isSSLEnabled() True when SSL is enabled.
ServerOptions	setBufferSize(int bufferSize) Set buffer size.
ServerOptions	setCompressionLevel(Integer compressionLevel) Set compression level to use while producing gzip responses.
ServerOptions	setDefaultHeaders(boolean defaultHeaders) Enabled/disabled default server headers: Date, Content-Type and Server.
ServerOptions	setGzip(boolean gzip) Deprecated. In favor of setCompressionLevel(Integer).
void	setHost(String host) Set the server host, defaults to 0.0.0.0.
ServerOptions	setIoThreads(int ioThreads) Set number of IO threads to use.
ServerOptions	setMaxRequestSize(int maxRequestSize) Set max request size in bytes.
ServerOptions	setPort(int port) Set the server port (default is 8080).
ServerOptions	setSecurePort(Integer securePort) Set HTTPs port.
ServerOptions	setServer(String server) Set server name.
ServerOptions	setSsl(SslOptions ssl) Set SSL options.
ServerOptions	setWorkerThreads(int workerThreads) Set number of worker threads (a.k.a application) to use.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SERVER_PORT

public static final int SERVER_PORT

Default application port 8080 or the value of system property server.port.

SEVER_SECURE_PORT

public static final int SEVER_SECURE_PORT

Default application secure port 8443 or the value of system property server.securePort.

DEFAULT_COMPRESSION_LEVEL

public static final int DEFAULT_COMPRESSION_LEVEL

Default compression level for gzip.

See Also:

Constant Field Values

_4KB

public static final int _4KB

4kb constant in bytes.

See Also:

Constant Field Values

_8KB

public static final int _8KB

8kb constant in bytes.

See Also:

Constant Field Values

_16KB

public static final int _16KB

16kb constant in bytes.

See Also:

Constant Field Values

_10MB

public static final int _10MB

10mb constant in bytes.

See Also:

Constant Field Values

IO_THREADS

public static final int IO_THREADS

Number of available threads, but never smaller than 2.

WORKER_THREADS

public static final int WORKER_THREADS

Number of worker (a.k.a application) threads. It is the number of processors multiply by 8.

Constructor Detail

ServerOptions

public ServerOptions()

Method Detail

from

@Nonnull
public static Optional<ServerOptions> from(@Nonnull
                                                    com.typesafe.config.Config conf)

Creates server options from config object. The configuration options must provided entries like: server.port, server.ioThreads, etc...

Parameters:

conf - Configuration object.

Returns:

Server options.

toString

public String toString()

Overrides:

toString in class Object

setServer

@Nonnull
public ServerOptions setServer(@Nonnull
                                        String server)

Set server name.

Parameters:

server - Name of the underlying server.

Returns:

This options.

getServer

@Nonnull
public String getServer()

Server name.

Returns:

Server name.

getPort

public int getPort()

Server HTTP port.

Returns:

Server HTTP port.

setPort

@Nonnull
public ServerOptions setPort(int port)

Set the server port (default is 8080). For random port use: 0.

Parameters:

port - Server port or 0 to pick a random port.

Returns:

This options.

getSecurePort

@Nullable
public Integer getSecurePort()

HTTPs port or null.

Returns:

HTTPs port or null.

isSSLEnabled

public boolean isSSLEnabled()

True when SSL is enabled. Either bc the secure port or SSL options are set.

Returns:

True when SSL is enabled. Either bc the secure port or SSL options are set.

setSecurePort

@Nullable
public ServerOptions setSecurePort(@Nullable
                                             Integer securePort)

Set HTTPs port.

Parameters:

securePort - Port number or 0 for random number.

Returns:

This options.

getIoThreads

public int getIoThreads()

Number of IO threads used by the server. Required by Netty and Undertow.

Returns:

Number of IO threads used by the server. Required by Netty and Undertow.

getIoThreads

public int getIoThreads(int defaultIoThreads)

Number of IO threads used by the server. Required by Netty and Undertow.

Parameters:

defaultIoThreads - Default number of threads if none was set.

Returns:

Number of IO threads used by the server. Required by Netty and Undertow.

setIoThreads

@Nonnull
public ServerOptions setIoThreads(int ioThreads)

Set number of IO threads to use. Supported by Netty and Undertow.

Parameters:

ioThreads - Number of threads. Must be greater than 0.

Returns:

This options.

getWorkerThreads

public int getWorkerThreads()

Number of worker threads (a.k.a application) to use. This are the threads which are allowed to block.

Returns:

Number of worker threads (a.k.a application) to use. This are the threads which are allowed to block.

getWorkerThreads

public int getWorkerThreads(int defaultWorkerThreads)

Number of worker threads (a.k.a application) to use. This are the threads which are allowed to block.

Parameters:

defaultWorkerThreads - Default worker threads is none was set.

Returns:

Number of worker threads (a.k.a application) to use. This are the threads which are allowed to block.

setWorkerThreads

@Nonnull
public ServerOptions setWorkerThreads(int workerThreads)

Set number of worker threads (a.k.a application) to use. This are the threads which are allowed to block.

Parameters:

workerThreads - Number of worker threads to use.

Returns:

This options.

getGzip

@Deprecated
public boolean getGzip()

Deprecated. In favor of getCompressionLevel().

True if gzip is enabled.

Returns:

True if gzip is enabled.

setGzip

@Deprecated
 @Nonnull
public ServerOptions setGzip(boolean gzip)

Deprecated. In favor of setCompressionLevel(Integer).

Enabled/disabled gzip.

Parameters:

gzip - True to enabled it. Default is disabled(false).

Returns:

This options.

getCompressionLevel

@Nullable
public Integer getCompressionLevel()

Indicates compression level to use while producing gzip responses.

Returns:

Compression level value between 0...9 or null when off.

setCompressionLevel

@Nonnull
public ServerOptions setCompressionLevel(@Nullable
                                                  Integer compressionLevel)

Set compression level to use while producing gzip responses. Gzip is off by default (compression level is null).

Parameters:

compressionLevel - Value between 0..9 or null.

Returns:

This options.

getDefaultHeaders

public boolean getDefaultHeaders()

True if default headers: Date, Content-Type and Server are enabled.

Returns:

True if default headers: Date, Content-Type and Server are enabled.

setDefaultHeaders

@Nonnull
public ServerOptions setDefaultHeaders(boolean defaultHeaders)

Enabled/disabled default server headers: Date, Content-Type and Server. Enabled by default.

Parameters:

defaultHeaders - True for enabled.

Returns:

This options.

getBufferSize

public int getBufferSize()

Server buffer size in bytes. Default is: 16kb. Used for reading/writing data.

Returns:

Server buffer size in bytes. Default is: 16kb. Used for reading/writing data.

setBufferSize

@Nonnull
public ServerOptions setBufferSize(int bufferSize)

Set buffer size.

Parameters:

bufferSize - Buffer size.

Returns:

This options.

getMaxRequestSize

public int getMaxRequestSize()

Maximum request size in bytes. Request exceeding this value results in StatusCode.REQUEST_ENTITY_TOO_LARGE response. Default is 10mb.

Returns:

Maximum request size in bytes.

setMaxRequestSize

@Nonnull
public ServerOptions setMaxRequestSize(int maxRequestSize)

Set max request size in bytes.

Parameters:

maxRequestSize - Max request size in bytes.

Returns:

This options.

getHost

public String getHost()

Server host, defaults is 0.0.0.0.

Returns:

Server host, defaults is 0.0.0.0.

setHost

public void setHost(String host)

Set the server host, defaults to 0.0.0.0.

Parameters:

host - Server host. Localhost, null or empty values fallback to 0.0.0.0.

getSsl

@Nullable
public SslOptions getSsl()

SSL options.

Returns:

SSL options.

setSsl

@Nonnull
public ServerOptions setSsl(@Nullable
                                     SslOptions ssl)

Set SSL options.

Parameters:

ssl - SSL options.

Returns:

Server options.

getSSLContext

@Nullable
public SSLContext getSSLContext(@Nonnull
                                          ClassLoader loader)

Creates SSL context using the given resource loader. This method attempts to create a SSLContext when: - getSecurePort() has been set; or - getSsl() has been set. If secure port is set and there is no SSL options, this method configure a SSL context using the a self-signed certificate for localhost.

Parameters:

loader - Resource loader.

Returns:

SSLContext or null when SSL is disabled.