org.apache.pekko.http.scaladsl.settings

Class ServerSettings

java.lang.Object

org.apache.pekko.http.javadsl.settings.ServerSettings

org.apache.pekko.http.scaladsl.settings.ServerSettings

Direct Known Subclasses:

ServerSettingsImpl

public abstract class ServerSettings
extends ServerSettings

Public API but not intended for subclassing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerSettings.LogUnencryptedNetworkBytes$
static interface	ServerSettings.Timeouts

Constructor Summary

Constructors

Constructor and Description
ServerSettings()

Method Summary

Modifier and Type	Method and Description
static ServerSettings	apply(com.typesafe.config.Config config)
static ServerSettings	apply(java.lang.String configOverrides)
abstract int	backlog()
abstract Host	defaultHostHeader()
abstract int	defaultHttpPort()
abstract int	defaultHttpsPort()
abstract boolean	enableHttp2() Configures the Http extension to bind using HTTP/2 if given an pekko.http.scaladsl.HttpsConnectionContext.
int	getBacklog()
Host	getDefaultHostHeader()
int	getDefaultHttpPort()
int	getDefaultHttpsPort()
java.util.Optional<java.lang.Object>	getLogUnencryptedNetworkBytes()
int	getMaxConnections()
ParserSettings	getParserSettings()
java.lang.String	getParsingErrorHandler()
int	getPipeliningLimit()
PreviewServerSettings	getPreviewServerSettings() Deprecated. the preview server settings are now integrated into the main server settings (since 1.3.0)
boolean	getRawRequestUriHeader()
boolean	getRemoteAddressAttribute()
boolean	getRemoteAddressHeader()
int	getResponseHeaderSizeHint()
java.util.Optional<Server>	getServerHeader()
java.util.List<org.apache.pekko.io.Inet.SocketOption>	getSocketOptions()
scala.concurrent.duration.FiniteDuration	getStreamCancellationDelay()
HttpResponse	getTerminationDeadlineExceededResponse()
ServerSettings.Timeouts	getTimeouts()
boolean	getTransparentHeadRequests()
boolean	getVerboseErrorMessages()
java.lang.Object	getWebsocketRandomFactory() Deprecated. Kept for binary compatibility; Use websocketSettings.getRandomFactory instead. Since Akka HTTP 10.2.0.
WebSocketSettings	getWebsocketSettings()
abstract Http2ServerSettings	http2Settings()
abstract scala.Option<java.lang.Object>	logUnencryptedNetworkBytes()
ServerSettings	mapHttp2Settings(scala.Function1<Http2ServerSettings,Http2ServerSettings> f)
ServerSettings	mapParserSettings(scala.Function1<ParserSettings,ParserSettings> f)
ServerSettings	mapPreviewServerSettings(scala.Function1<PreviewServerSettings,PreviewServerSettings> f) Deprecated. the preview server settings are now integrated into the main server settings. Since 1.3.0.
ServerSettings	mapTimeouts(scala.Function1<ServerSettings.Timeouts,ServerSettings.Timeouts> f)
ServerSettings	mapWebsocketSettings(scala.Function1<WebSocketSettings,WebSocketSettings> f)
abstract int	maxConnections()
abstract ParserSettings	parserSettings()
abstract java.lang.String	parsingErrorHandler()
abstract ParsingErrorHandler	parsingErrorHandlerInstance(org.apache.pekko.actor.ActorSystem system) INTERNAL API Returns an instance of the ParsingErrorHandler as specified by parsingErrorHandler
abstract int	pipeliningLimit()
abstract PreviewServerSettings	previewServerSettings()
abstract boolean	rawRequestUriHeader()
abstract boolean	remoteAddressAttribute()
abstract boolean	remoteAddressHeader() Deprecated. use remote-address-attribute instead. Since Akka HTTP 10.2.0.
abstract int	responseHeaderSizeHint()
abstract scala.Option<Server>	serverHeader()
abstract scala.collection.immutable.Seq<org.apache.pekko.io.Inet.SocketOption>	socketOptions()
abstract scala.concurrent.duration.FiniteDuration	streamCancellationDelay()
abstract HttpResponse	terminationDeadlineExceededResponse()
abstract ServerSettings.Timeouts	timeouts()
static ServerSettings.Timeouts	timeoutsShortcut(ServerSettings s)
abstract boolean	transparentHeadRequests()
abstract boolean	verboseErrorMessages()
abstract scala.Function0<java.util.Random>	websocketRandomFactory() Deprecated. Kept for binary compatibility; Use websocketSettings.randomFactory instead. Since Akka HTTP 10.1.1.
abstract WebSocketSettings	websocketSettings()
ServerSettings	withBacklog(int newValue)
ServerSettings	withDefaultHostHeader(Host newValue)
ServerSettings	withDefaultHttpPort(int newValue)
ServerSettings	withDefaultHttpsPort(int newValue)
ServerSettings	withEnableHttp2(boolean newValue)
ServerSettings	withHttp2Settings(Http2ServerSettings newValue)
ServerSettings	withLogUnencryptedNetworkBytes(scala.Option<java.lang.Object> newValue)
ServerSettings	withMaxConnections(int newValue)
ServerSettings	withParserSettings(ParserSettings newValue)
ServerSettings	withParsingErrorHandler(java.lang.String newValue)
ServerSettings	withPipeliningLimit(int newValue)
ServerSettings	withPreviewServerSettings(PreviewServerSettings newValue) Deprecated. the preview server settings are now integrated into the main server settings (since 1.3.0)
ServerSettings	withRawRequestUriHeader(boolean newValue)
ServerSettings	withRemoteAddressAttribute(boolean newValue)
ServerSettings	withRemoteAddressHeader(boolean newValue) Deprecated. since Pekko HTTP 1.3.0, use withRemoteAddressAttribute instead
ServerSettings	withResponseHeaderSizeHint(int newValue)
ServerSettings	withServerHeader(scala.Option<Server> newValue)
ServerSettings	withSocketOptions(java.lang.Iterable<org.apache.pekko.io.Inet.SocketOption> newValue)
ServerSettings	withSocketOptions(scala.collection.immutable.Seq<org.apache.pekko.io.Inet.SocketOption> newValue)
ServerSettings	withStreamCancellationDelay(scala.concurrent.duration.FiniteDuration newValue)
ServerSettings	withTerminationDeadlineExceededResponse(HttpResponse response)
ServerSettings	withTimeouts(ServerSettings.Timeouts newValue)
ServerSettings	withTransparentHeadRequests(boolean newValue)
ServerSettings	withVerboseErrorMessages(boolean newValue)
ServerSettings	withWebsocketRandomFactory(scala.Function0<java.util.Random> newValue) Deprecated. Kept for binary compatibility; Use websocketSettings.withRandomFactoryFactory instead. Since Akka HTTP 10.2.0.
ServerSettings	withWebsocketRandomFactory(java.util.function.Supplier<java.util.Random> newValue) Deprecated. Kept for binary compatibility; Use websocketSettings.withRandomFactoryFactory instead. Since Akka HTTP 10.2.0.
ServerSettings	withWebsocketSettings(WebSocketSettings newValue)

Methods inherited from class org.apache.pekko.http.javadsl.settings.ServerSettings

create, create, create, getHttp2Settings, withDefaultHostHeader, withHttp2Settings, withLogUnencryptedNetworkBytes, withParserSettings, withPreviewServerSettings, withServerHeader, withTimeouts, withWebsocketSettings

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerSettings

public ServerSettings()

Method Detail

timeoutsShortcut

public static ServerSettings.Timeouts timeoutsShortcut(ServerSettings s)

apply

public static ServerSettings apply(com.typesafe.config.Config config)

apply

public static ServerSettings apply(java.lang.String configOverrides)

serverHeader

public abstract scala.Option<Server> serverHeader()

previewServerSettings

public abstract PreviewServerSettings previewServerSettings()

timeouts

public abstract ServerSettings.Timeouts timeouts()

maxConnections

public abstract int maxConnections()

pipeliningLimit

public abstract int pipeliningLimit()

remoteAddressHeader

public abstract boolean remoteAddressHeader()

Deprecated. use remote-address-attribute instead. Since Akka HTTP 10.2.0.

remoteAddressAttribute

public abstract boolean remoteAddressAttribute()

rawRequestUriHeader

public abstract boolean rawRequestUriHeader()

transparentHeadRequests

public abstract boolean transparentHeadRequests()

verboseErrorMessages

public abstract boolean verboseErrorMessages()

responseHeaderSizeHint

public abstract int responseHeaderSizeHint()

backlog

public abstract int backlog()

socketOptions

public abstract scala.collection.immutable.Seq<org.apache.pekko.io.Inet.SocketOption> socketOptions()

defaultHostHeader

public abstract Host defaultHostHeader()

websocketRandomFactory

public abstract scala.Function0<java.util.Random> websocketRandomFactory()

Deprecated. Kept for binary compatibility; Use websocketSettings.randomFactory instead. Since Akka HTTP 10.1.1.

websocketSettings

public abstract WebSocketSettings websocketSettings()

parserSettings

public abstract ParserSettings parserSettings()

logUnencryptedNetworkBytes

public abstract scala.Option<java.lang.Object> logUnencryptedNetworkBytes()

http2Settings

public abstract Http2ServerSettings http2Settings()

defaultHttpPort

public abstract int defaultHttpPort()

defaultHttpsPort

public abstract int defaultHttpsPort()

terminationDeadlineExceededResponse

public abstract HttpResponse terminationDeadlineExceededResponse()

parsingErrorHandler

public abstract java.lang.String parsingErrorHandler()

streamCancellationDelay

public abstract scala.concurrent.duration.FiniteDuration streamCancellationDelay()

enableHttp2

public abstract boolean enableHttp2()

Configures the Http extension to bind using HTTP/2 if given an pekko.http.scaladsl.HttpsConnectionContext. Otherwise binds as plain HTTP.

Specified by:

enableHttp2 in class ServerSettings

Returns:

(undocumented)

Since:

1.3.0

getBacklog

public int getBacklog()

Specified by:

getBacklog in class ServerSettings

getPreviewServerSettings

public PreviewServerSettings getPreviewServerSettings()

Deprecated. the preview server settings are now integrated into the main server settings (since 1.3.0)

Specified by:

getPreviewServerSettings in class ServerSettings

Returns:

(undocumented)

getDefaultHostHeader

public Host getDefaultHostHeader()

Specified by:

getDefaultHostHeader in class ServerSettings

getPipeliningLimit

public int getPipeliningLimit()

Specified by:

getPipeliningLimit in class ServerSettings

getParserSettings

public ParserSettings getParserSettings()

Specified by:

getParserSettings in class ServerSettings

getMaxConnections

public int getMaxConnections()

Specified by:

getMaxConnections in class ServerSettings

getTransparentHeadRequests

public boolean getTransparentHeadRequests()

Specified by:

getTransparentHeadRequests in class ServerSettings

getResponseHeaderSizeHint

public int getResponseHeaderSizeHint()

Specified by:

getResponseHeaderSizeHint in class ServerSettings

getVerboseErrorMessages

public boolean getVerboseErrorMessages()

Specified by:

getVerboseErrorMessages in class ServerSettings

getSocketOptions

public java.util.List<org.apache.pekko.io.Inet.SocketOption> getSocketOptions()

Specified by:

getSocketOptions in class ServerSettings

getServerHeader

public java.util.Optional<Server> getServerHeader()

Specified by:

getServerHeader in class ServerSettings

getTimeouts

public ServerSettings.Timeouts getTimeouts()

Specified by:

getTimeouts in class ServerSettings

getRawRequestUriHeader

public boolean getRawRequestUriHeader()

Specified by:

getRawRequestUriHeader in class ServerSettings

getRemoteAddressHeader

public boolean getRemoteAddressHeader()

Specified by:

getRemoteAddressHeader in class ServerSettings

Returns:

(undocumented)

getRemoteAddressAttribute

public boolean getRemoteAddressAttribute()

Specified by:

getRemoteAddressAttribute in class ServerSettings

getLogUnencryptedNetworkBytes

public java.util.Optional<java.lang.Object> getLogUnencryptedNetworkBytes()

Specified by:

getLogUnencryptedNetworkBytes in class ServerSettings

getWebsocketRandomFactory

public java.lang.Object getWebsocketRandomFactory()

Deprecated. Kept for binary compatibility; Use websocketSettings.getRandomFactory instead. Since Akka HTTP 10.2.0.

getDefaultHttpPort

public int getDefaultHttpPort()

Specified by:

getDefaultHttpPort in class ServerSettings

getDefaultHttpsPort

public int getDefaultHttpsPort()

Specified by:

getDefaultHttpsPort in class ServerSettings

getTerminationDeadlineExceededResponse

public HttpResponse getTerminationDeadlineExceededResponse()

Specified by:

getTerminationDeadlineExceededResponse in class ServerSettings

getParsingErrorHandler

public java.lang.String getParsingErrorHandler()

Specified by:

getParsingErrorHandler in class ServerSettings

getStreamCancellationDelay

public scala.concurrent.duration.FiniteDuration getStreamCancellationDelay()

Specified by:

getStreamCancellationDelay in class ServerSettings

withPreviewServerSettings

public ServerSettings withPreviewServerSettings(PreviewServerSettings newValue)

Deprecated. the preview server settings are now integrated into the main server settings (since 1.3.0)

Parameters:

newValue - (undocumented)

Returns:

(undocumented)

withMaxConnections

public ServerSettings withMaxConnections(int newValue)

Overrides:

withMaxConnections in class ServerSettings

withPipeliningLimit

public ServerSettings withPipeliningLimit(int newValue)

Overrides:

withPipeliningLimit in class ServerSettings

withRemoteAddressHeader

public ServerSettings withRemoteAddressHeader(boolean newValue)

Deprecated. since Pekko HTTP 1.3.0, use withRemoteAddressAttribute instead

Overrides:

withRemoteAddressHeader in class ServerSettings

Parameters:

newValue - (undocumented)

Returns:

(undocumented)

withRemoteAddressAttribute

public ServerSettings withRemoteAddressAttribute(boolean newValue)

Overrides:

withRemoteAddressAttribute in class ServerSettings

withRawRequestUriHeader

public ServerSettings withRawRequestUriHeader(boolean newValue)

Overrides:

withRawRequestUriHeader in class ServerSettings

withTransparentHeadRequests

public ServerSettings withTransparentHeadRequests(boolean newValue)

Overrides:

withTransparentHeadRequests in class ServerSettings

withVerboseErrorMessages

public ServerSettings withVerboseErrorMessages(boolean newValue)

Overrides:

withVerboseErrorMessages in class ServerSettings

withResponseHeaderSizeHint

public ServerSettings withResponseHeaderSizeHint(int newValue)

Overrides:

withResponseHeaderSizeHint in class ServerSettings

withBacklog

public ServerSettings withBacklog(int newValue)

Overrides:

withBacklog in class ServerSettings

withSocketOptions

public ServerSettings withSocketOptions(java.lang.Iterable<org.apache.pekko.io.Inet.SocketOption> newValue)

Overrides:

withSocketOptions in class ServerSettings

withWebsocketRandomFactory

public ServerSettings withWebsocketRandomFactory(java.util.function.Supplier<java.util.Random> newValue)

Deprecated. Kept for binary compatibility; Use websocketSettings.withRandomFactoryFactory instead. Since Akka HTTP 10.2.0.

Overrides:

withWebsocketRandomFactory in class ServerSettings

getWebsocketSettings

public WebSocketSettings getWebsocketSettings()

Specified by:

getWebsocketSettings in class ServerSettings

withDefaultHttpPort

public ServerSettings withDefaultHttpPort(int newValue)

Overrides:

withDefaultHttpPort in class ServerSettings

withDefaultHttpsPort

public ServerSettings withDefaultHttpsPort(int newValue)

Overrides:

withDefaultHttpsPort in class ServerSettings

withTerminationDeadlineExceededResponse

public ServerSettings withTerminationDeadlineExceededResponse(HttpResponse response)

Overrides:

withTerminationDeadlineExceededResponse in class ServerSettings

withParsingErrorHandler

public ServerSettings withParsingErrorHandler(java.lang.String newValue)

Overrides:

withParsingErrorHandler in class ServerSettings

withStreamCancellationDelay

public ServerSettings withStreamCancellationDelay(scala.concurrent.duration.FiniteDuration newValue)

Overrides:

withStreamCancellationDelay in class ServerSettings

withEnableHttp2

public ServerSettings withEnableHttp2(boolean newValue)

Overrides:

withEnableHttp2 in class ServerSettings

Parameters:

newValue - (undocumented)

Returns:

(undocumented)

withTimeouts

public ServerSettings withTimeouts(ServerSettings.Timeouts newValue)

withServerHeader

public ServerSettings withServerHeader(scala.Option<Server> newValue)

withLogUnencryptedNetworkBytes

public ServerSettings withLogUnencryptedNetworkBytes(scala.Option<java.lang.Object> newValue)

withDefaultHostHeader

public ServerSettings withDefaultHostHeader(Host newValue)

withParserSettings

public ServerSettings withParserSettings(ParserSettings newValue)

withWebsocketRandomFactory

public ServerSettings withWebsocketRandomFactory(scala.Function0<java.util.Random> newValue)

Deprecated. Kept for binary compatibility; Use websocketSettings.withRandomFactoryFactory instead. Since Akka HTTP 10.2.0.

withWebsocketSettings

public ServerSettings withWebsocketSettings(WebSocketSettings newValue)

withSocketOptions

public ServerSettings withSocketOptions(scala.collection.immutable.Seq<org.apache.pekko.io.Inet.SocketOption> newValue)

withHttp2Settings

public ServerSettings withHttp2Settings(Http2ServerSettings newValue)

mapHttp2Settings

public ServerSettings mapHttp2Settings(scala.Function1<Http2ServerSettings,Http2ServerSettings> f)

mapParserSettings

public ServerSettings mapParserSettings(scala.Function1<ParserSettings,ParserSettings> f)

mapPreviewServerSettings

public ServerSettings mapPreviewServerSettings(scala.Function1<PreviewServerSettings,PreviewServerSettings> f)

Deprecated. the preview server settings are now integrated into the main server settings. Since 1.3.0.

mapWebsocketSettings

public ServerSettings mapWebsocketSettings(scala.Function1<WebSocketSettings,WebSocketSettings> f)

mapTimeouts

public ServerSettings mapTimeouts(scala.Function1<ServerSettings.Timeouts,ServerSettings.Timeouts> f)

parsingErrorHandlerInstance

public abstract ParsingErrorHandler parsingErrorHandlerInstance(org.apache.pekko.actor.ActorSystem system)

INTERNAL API

Returns an instance of the ParsingErrorHandler as specified by parsingErrorHandler

Parameters:

system - (undocumented)

Returns:

(undocumented)