Package io.deephaven.server.jetty

Class JettyConfig

java.lang.Object

io.deephaven.server.jetty.JettyConfig

All Implemented Interfaces:

ServerConfig

@Immutable
public abstract class JettyConfig
extends Object
implements ServerConfig

The jetty server configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JettyConfig.Builder
static enum	JettyConfig.WebsocketsSupport	Values to indicate what kind of websocket support should be offered.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOWED_HTTP_METHODS
static final Set<String>	DEFAULT_ALLOWED_METHODS
static final int	DEFAULT_PLAINTEXT_PORT
static final int	DEFAULT_SSL_PORT
static final String	EXTRA_HEADERS
static final String	HTTP_COMPRESSION
static final String	HTTP_HTTP1
static final String	HTTP_STREAM_TIMEOUT
static final String	HTTP_WEBSOCKETS
static final String	MAX_CONCURRENT_STREAMS
static final String	MAX_HEADER_REQUEST_SIZE
static final String	SNI_HOST_CHECK

Fields inherited from interface io.deephaven.server.config.ServerConfig

DEFAULT_MAX_INBOUND_MESSAGE_SIZE_MiB, DEFAULT_SCHEDULER_POOL_SIZE, DEFAULT_SHUTDOWN_TIMEOUT_MILLIS, GRPC_MAX_INBOUND_MESSAGE_SIZE, HTTP_HOST, HTTP_PORT, HTTP_SESSION_DURATION_MS, HTTP_TARGET_URL, PROXY_HINT, SCHEDULER_POOL_SIZE, SHUTDOWN_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor	Description
JettyConfig()

Method Summary

Modifier and Type	Method	Description
abstract Set<String>	allowedHttpMethods()	If unset, defaults to permitting "GET", "POST", and "OPTIONS" methods, ensuring that gRPC calls and requests to load the web client are permitted.
static JettyConfig.Builder	builder()
static JettyConfig.Builder	buildFromConfig(Configuration config)	Parses the configuration values into the appropriate builder methods via ServerConfig.buildFromConfig(ServerConfig.Builder, Configuration).
static JettyConfig	defaultConfig()	The default configuration is suitable for local development purposes.
abstract Map<String,String>	extraHeaders()	Extra headers to return in every response from this server.
abstract Boolean	http1()	Include HTTP/1.1.
final boolean	http1OrDefault()	Returns http1() if explicitly set.
abstract OptionalLong	http2StreamIdleTimeout()
long	http2StreamIdleTimeoutOrDefault()	How long can a stream be idle in milliseconds before it should be shut down.
abstract Boolean	httpCompression()	Include HTTP compression.
final boolean	httpCompressionOrDefault()	Returns httpCompression() if explicitly set, otherwise returns true.
abstract OptionalInt	maxConcurrentStreams()	If unset, uses Jetty's default (presently 128).
abstract OptionalInt	maxHeaderRequestSize()	Value is in bytes.
int	port()	The port.
boolean	sniHostCheck()	Include sniHostCheck.
abstract JettyConfig.WebsocketsSupport	websockets()	Include websockets.
final JettyConfig.WebsocketsSupport	websocketsOrDefault()	Returns websockets() if explicitly set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.deephaven.server.config.ServerConfig

host, maxInboundMessageSize, outboundSsl, proxyHint, schedulerPoolSize, shutdownTimeout, ssl, targetUrl, targetUrlOrDefault, tokenExpire

Field Details

DEFAULT_SSL_PORT

public static final int DEFAULT_SSL_PORT

See Also:

• Constant Field Values

DEFAULT_PLAINTEXT_PORT

public static final int DEFAULT_PLAINTEXT_PORT

See Also:

• Constant Field Values

HTTP_WEBSOCKETS

public static final String HTTP_WEBSOCKETS

See Also:

• Constant Field Values

HTTP_HTTP1

public static final String HTTP_HTTP1

See Also:

• Constant Field Values

HTTP_STREAM_TIMEOUT

public static final String HTTP_STREAM_TIMEOUT

See Also:

• Constant Field Values

HTTP_COMPRESSION

public static final String HTTP_COMPRESSION

See Also:

• Constant Field Values

SNI_HOST_CHECK

public static final String SNI_HOST_CHECK

See Also:

• Constant Field Values

MAX_CONCURRENT_STREAMS

public static final String MAX_CONCURRENT_STREAMS

See Also:

• Constant Field Values

MAX_HEADER_REQUEST_SIZE

public static final String MAX_HEADER_REQUEST_SIZE

See Also:

• Constant Field Values

ALLOWED_HTTP_METHODS

public static final String ALLOWED_HTTP_METHODS

See Also:

• Constant Field Values

DEFAULT_ALLOWED_METHODS

public static final Set<String> DEFAULT_ALLOWED_METHODS

EXTRA_HEADERS

public static final String EXTRA_HEADERS

See Also:

• Constant Field Values

Constructor Details

JettyConfig

public JettyConfig()

Method Details

builder

public static JettyConfig.Builder builder()

defaultConfig

public static JettyConfig defaultConfig()

The default configuration is suitable for local development purposes. It inherits all of the defaults, which are documented on each individual method. In brief, the default server starts up on all interfaces with plaintext port 10000, a scheduler pool size of 4, and a max inbound message size of 100 MiB.

buildFromConfig

public static JettyConfig.Builder buildFromConfig(Configuration config)

Parses the configuration values into the appropriate builder methods via ServerConfig.buildFromConfig(ServerConfig.Builder, Configuration).

Additionally, parses the property "http.websockets" into JettyConfig.Builder.websockets(WebsocketsSupport), "http.http1" into JettyConfig.Builder.http1(Boolean), "http2.stream.idleTimeoutMs" into JettyConfig.Builder.http2StreamIdleTimeout(long), and "http.compression" into JettyConfig.Builder.httpCompression(Boolean)

Parameters:

config - the config

Returns:

the builder

port

@Default
public int port()

The port. Defaults to 443 if ServerConfig.ssl() is present, otherwise defaults to 10000.

Specified by:

port in interface ServerConfig

websockets

@Nullable
public abstract JettyConfig.WebsocketsSupport websockets()

Include websockets.

http1

@Nullable
public abstract Boolean http1()

Include HTTP/1.1.

sniHostCheck

@Default
public boolean sniHostCheck()

Include sniHostCheck.

http2StreamIdleTimeout

public abstract OptionalLong http2StreamIdleTimeout()

httpCompression

@Nullable
public abstract Boolean httpCompression()

Include HTTP compression.

http2StreamIdleTimeoutOrDefault

public long http2StreamIdleTimeoutOrDefault()

How long can a stream be idle in milliseconds before it should be shut down. Non-positive values disable this feature. Default is zero.

websocketsOrDefault

public final JettyConfig.WebsocketsSupport websocketsOrDefault()

Returns websockets() if explicitly set. If ServerConfig.proxyHint() is true, returns false. Otherwise, defaults to true when ServerConfig.ssl() is empty, and false when ServerConfig.ssl() is present.

http1OrDefault

public final boolean http1OrDefault()

Returns http1() if explicitly set. If ServerConfig.proxyHint() is true, returns false. Otherwise, defaults to true. This may become more strict in the future, see #2787).

httpCompressionOrDefault

public final boolean httpCompressionOrDefault()

Returns httpCompression() if explicitly set, otherwise returns true.

maxHeaderRequestSize

public abstract OptionalInt maxHeaderRequestSize()

Value is in bytes. If unset, uses Jetty's default (presently 8192).

maxConcurrentStreams

public abstract OptionalInt maxConcurrentStreams()

If unset, uses Jetty's default (presently 128). Only applies to http2 connections.

allowedHttpMethods

public abstract Set<String> allowedHttpMethods()

If unset, defaults to permitting "GET", "POST", and "OPTIONS" methods, ensuring that gRPC calls and requests to load the web client are permitted.

extraHeaders

public abstract Map<String,String> extraHeaders()

Extra headers to return in every response from this server.