Package io.deephaven.server.config

Interface ServerConfig

All Known Implementing Classes:

JettyConfig, JettyConfig, NettyConfig

public interface ServerConfig

The server configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ServerConfig.Builder<T,B extends ServerConfig.Builder<T,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_INBOUND_MESSAGE_SIZE_MiB
static final int	DEFAULT_SCHEDULER_POOL_SIZE
static final int	DEFAULT_SHUTDOWN_TIMEOUT_MILLIS
static final String	GRPC_MAX_INBOUND_MESSAGE_SIZE
static final String	HTTP_HOST
static final String	HTTP_PORT
static final String	HTTP_SESSION_DURATION_MS
static final String	HTTP_TARGET_URL
static final String	PROXY_HINT
static final String	SCHEDULER_POOL_SIZE
static final String	SHUTDOWN_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method	Description
static <B extends ServerConfig.Builder<?, B>> B	buildFromConfig(B builder, Configuration config)	Parses the configuration values into the appropriate builder methods.
Optional<String>	host()	The network interface this server binds to as an IP address or a hostname.
default int	maxInboundMessageSize()	The maximum inbound message size.
Optional<SSLConfig>	outboundSsl()	The optional outbound SSL configuration.
int	port()	The port.
Boolean	proxyHint()	A hint that the server is running behind a proxy.
default int	schedulerPoolSize()	The scheduler pool size.
default Duration	shutdownTimeout()	How many do we wait to shut down the server.
Optional<SSLConfig>	ssl()	The optional SSL configuration.
Optional<String>	targetUrl()	The user-accessible target URL.
default String	targetUrlOrDefault()	Returns targetUrl() if set, otherwise computes a reasonable default based on host(), port(), and ssl().
Duration	tokenExpire()	The token expiration.

Field Details

DEFAULT_SCHEDULER_POOL_SIZE

static final int DEFAULT_SCHEDULER_POOL_SIZE

See Also:

• Constant Field Values

DEFAULT_MAX_INBOUND_MESSAGE_SIZE_MiB

static final int DEFAULT_MAX_INBOUND_MESSAGE_SIZE_MiB

See Also:

• Constant Field Values

DEFAULT_SHUTDOWN_TIMEOUT_MILLIS

static final int DEFAULT_SHUTDOWN_TIMEOUT_MILLIS

See Also:

• Constant Field Values

HTTP_SESSION_DURATION_MS

static final String HTTP_SESSION_DURATION_MS

See Also:

• Constant Field Values

HTTP_HOST

static final String HTTP_HOST

See Also:

• Constant Field Values

HTTP_PORT

static final String HTTP_PORT

See Also:

• Constant Field Values

HTTP_TARGET_URL

static final String HTTP_TARGET_URL

See Also:

• Constant Field Values

SCHEDULER_POOL_SIZE

static final String SCHEDULER_POOL_SIZE

See Also:

• Constant Field Values

GRPC_MAX_INBOUND_MESSAGE_SIZE

static final String GRPC_MAX_INBOUND_MESSAGE_SIZE

See Also:

• Constant Field Values

PROXY_HINT

static final String PROXY_HINT

See Also:

• Constant Field Values

SHUTDOWN_TIMEOUT_MILLIS

static final String SHUTDOWN_TIMEOUT_MILLIS

See Also:

• Constant Field Values

Method Details

buildFromConfig

static <B extends ServerConfig.Builder<?,
B>> B buildFromConfig(B builder,
 Configuration config)

Parses the configuration values into the appropriate builder methods.

Property	Method
"http.session.durationMs"	ServerConfig.Builder.tokenExpire(Duration)
"http.host"	ServerConfig.Builder.host(String)
"http.port"	ServerConfig.Builder.port(int)
"http.targetUrl"	ServerConfig.Builder.targetUrl(String)
"scheduler.poolSize"	ServerConfig.Builder.schedulerPoolSize(int)
"grpc.maxInboundMessageSize"	ServerConfig.Builder.maxInboundMessageSize(int)
"proxy.hint"	ServerConfig.Builder.proxyHint(Boolean)

Also parses MainHelper.parseSSLConfig(Configuration) into ServerConfig.Builder.ssl(SSLConfig) and MainHelper.parseOutboundSSLConfig(Configuration) into ServerConfig.Builder.outboundSsl(SSLConfig).

See MainHelper.parseSSLConfig(Configuration) for ServerConfig.Builder.ssl(SSLConfig).

Type Parameters:

B - the builder type

Parameters:

builder - the builder

config - the configuration

Returns:

the builder

host

Optional<String> host()

The network interface this server binds to as an IP address or a hostname. If not set, then bind to all interfaces.

port

int port()

The port.

targetUrl

Optional<String> targetUrl()

The user-accessible target URL.

ssl

Optional<SSLConfig> ssl()

The optional SSL configuration.

outboundSsl

Optional<SSLConfig> outboundSsl()

The optional outbound SSL configuration.

tokenExpire

Duration tokenExpire()

The token expiration.

schedulerPoolSize

@Default
default int schedulerPoolSize()

The scheduler pool size. Defaults to 4.

maxInboundMessageSize

@Default
default int maxInboundMessageSize()

The maximum inbound message size. Defaults to 100 MiB.

shutdownTimeout

@Default
default Duration shutdownTimeout()

How many do we wait to shut down the server. Defaults to 10000.

proxyHint

@Nullable
Boolean proxyHint()

A hint that the server is running behind a proxy. This may allow consumers of the configuration to make more appropriate default choices.

targetUrlOrDefault

default String targetUrlOrDefault()

Returns targetUrl() if set, otherwise computes a reasonable default based on host(), port(), and ssl().

Returns:

the target URL or default