io.vertx.kotlin.ext.shell.term.HttpTermOptions.kt Maven / Gradle / Ivy
/*
* Copyright 2019 Red Hat, Inc.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package io.vertx.kotlin.ext.shell.term
import io.vertx.ext.shell.term.HttpTermOptions
import io.netty.handler.logging.ByteBufFormat
import io.vertx.core.http.ClientAuth
import io.vertx.core.http.Http2Settings
import io.vertx.core.http.HttpVersion
import io.vertx.core.net.JdkSSLEngineOptions
import io.vertx.core.net.JksOptions
import io.vertx.core.net.OpenSSLEngineOptions
import io.vertx.core.net.PemKeyCertOptions
import io.vertx.core.net.PemTrustOptions
import io.vertx.core.net.PfxOptions
import io.vertx.core.net.TrafficShapingOptions
import io.vertx.core.tracing.TracingPolicy
import io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions
import java.util.concurrent.TimeUnit
/**
* A function providing a DSL for building [io.vertx.ext.shell.term.HttpTermOptions] objects.
*
* The web term configuration options.
*
* @param acceptBacklog Set the accept back log
* @param acceptUnmaskedFrames Set true when the server accepts unmasked frame. As default Server doesn't accept unmasked frame, you can bypass this behaviour (RFC 6455) setting true. It's set to false as default.
* @param activityLogDataFormat Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.
* @param alpnVersions Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation.
* @param authOptions Set the auth options.
* @param charset Set the charset used for encoding / decoding text data from/to SockJS
* @param clientAuth Set whether client auth is required
* @param compressionLevel This method allows to set the compression level to be used in http1.x/2 response bodies when compression support is turned on (@see setCompressionSupported) and the client advertises to support deflate/gzip compression in the Accept-Encoding header default value is : 6 (Netty legacy) The compression level determines how much the data is compressed on a scale from 1 to 9, where '9' is trying to achieve the maximum compression ratio while '1' instead is giving priority to speed instead of compression ratio using some algorithm optimizations and skipping pedantic loops that usually gives just little improvements While one can think that best value is always the maximum compression ratio, there's a trade-off to consider: the most compressed level requires the most computational work to compress/decompress data, e.g. more dictionary lookups and loops. E.g. you have it set fairly high on a high-volume website, you may experience performance degradation and latency on resource serving due to CPU overload, and, however - as the computational work is required also client side while decompressing - setting an higher compression level can result in an overall higher page load time especially nowadays when many clients are handled mobile devices with a low CPU profile. see also: http://www.gzip.org/algorithm.txt
* @param compressionSupported Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header)
* @param compressors Set the list of compressor to use instead of using the default gzip/deflate [io.vertx.core.http.HttpServerOptions] configuration. This is only active when [io.vertx.ext.shell.term.HttpTermOptions] is true.
* @param crlPaths Add a CRL path
* @param crlValues Add a CRL value
* @param decoderInitialBufferSize Set the initial buffer size for the HTTP decoder
* @param decompressionSupported Set whether the server supports decompression
* @param enabledCipherSuites Add an enabled cipher suite, appended to the ordered suites.
* @param enabledSecureTransportProtocols Sets the list of enabled SSL/TLS protocols.
* @param handle100ContinueAutomatically Set whether 100 Continue should be handled automatically
* @param host Set the host
* @param http2ConnectionWindowSize Set the default HTTP/2 connection window size. It overrides the initial window size set by , so the connection window size is greater than for its streams, in order the data throughput.
A value of -1 reuses the initial window size setting.
* @param http2RstFloodMaxRstFramePerWindow Set the max number of RST frame allowed per time window, this is used to prevent HTTP/2 RST frame flood DDOS attacks. The default value is [io.vertx.core.http.HttpServerOptions], setting zero or a negative value, disables flood protection.
* @param http2RstFloodWindowDuration Set the duration of the time window when checking the max number of RST frames, this is used to prevent HTTP/2 RST frame flood DDOS attacks. The default value is [io.vertx.core.http.HttpServerOptions], setting zero or a negative value, disables flood protection.
* @param http2RstFloodWindowDurationTimeUnit Set the time unit of the duration of the time window when checking the max number of RST frames, this is used to prevent HTTP/2 RST frame flood DDOS attacks. The default value is [io.vertx.core.http.HttpServerOptions], setting zero or a negative value, disables the flood protection.
* @param idleTimeout Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received nor sent within the timeout. If you want change default time unit, use [io.vertx.core.http.HttpServerOptions]
* @param idleTimeoutUnit Set the idle timeout unit. If not specified, default is seconds.
* @param initialSettings Set the HTTP/2 connection settings immediatly sent by the server when a client connects.
* @param intputrc The path of the inputrc config.
* @param jdkSslEngineOptions
* @param keyCertOptions Set the key/cert options.
* @param keyStoreOptions Set the key/cert options in jks format, aka Java keystore.
* @param logActivity Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
* @param maxChunkSize Set the maximum HTTP chunk size that will receive
* @param maxFormAttributeSize Set the maximum size of a form attribute. Set to -1 to allow unlimited length
* @param maxFormBufferedBytes Set the maximum number of bytes a server can buffer when decoding a form. Set to -1 to allow unlimited length
* @param maxFormFields Set the maximum number of fields of a form. Set to -1 to allow unlimited number of attributes
* @param maxHeaderSize Set the maximum length of all headers for HTTP/1.x .
* @param maxInitialLineLength Set the maximum length of the initial line for HTTP/1.x (e.g. "GET / HTTP/1.0")
* @param maxWebSocketFrameSize Set the maximum WebSocket frames size
* @param maxWebSocketMessageSize Set the maximum WebSocket message size
* @param openSslEngineOptions
* @param pemKeyCertOptions Set the key/cert store options in pem format.
* @param pemTrustOptions Set the trust options in pem format
* @param perFrameWebSocketCompressionSupported Enable or disable support for the WebSocket per-frame deflate compression extension.
* @param perMessageWebSocketCompressionSupported Enable or disable support for WebSocket per-message deflate compression extension.
* @param pfxKeyCertOptions Set the key/cert options in pfx format.
* @param pfxTrustOptions Set the trust options in pfx format
* @param port Set the port
* @param proxyProtocolTimeout Set the Proxy protocol timeout, default time unit is seconds.
* @param proxyProtocolTimeoutUnit Set the Proxy protocol timeout unit. If not specified, default is seconds.
* @param readIdleTimeout Set the read idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use [io.vertx.core.http.HttpServerOptions]
* @param receiveBufferSize Set the TCP receive buffer size
* @param registerWebSocketWriteHandlers Whether write-handlers for server websockets should be registered on the [io.vertx.core.eventbus.EventBus]. Defaults to false.
* @param registerWriteHandler Has no effect on HTTP server options.
* @param reuseAddress Set the value of reuse address
* @param reusePort Set the value of reuse port.
This is only supported by native transports.
* @param sendBufferSize Set the TCP send buffer size
* @param shellHtmlResource Set shell.html resource to use.
* @param sni Set whether the server supports Server Name Indiciation
* @param soLinger Set whether SO_linger keep alive is enabled
* @param sockJSHandlerOptions The SockJS handler options.
* @param sockJSPath Configure the SockJS path, the default value is /term/.
* @param ssl Set whether SSL/TLS is enabled
* @param sslEngineOptions Set to use SSL engine implementation to use.
* @param sslHandshakeTimeout Set the SSL handshake timeout, default time unit is seconds.
* @param sslHandshakeTimeoutUnit Set the SSL handshake timeout unit. If not specified, default is seconds.
* @param tcpCork Enable the TCP_CORK option - only with linux native transport.
* @param tcpFastOpen Enable the TCP_FASTOPEN option - only with linux native transport.
* @param tcpKeepAlive Set whether TCP keep alive is enabled
* @param tcpNoDelay Set whether TCP no delay is enabled
* @param tcpQuickAck Enable the TCP_QUICKACK option - only with linux native transport.
* @param tcpUserTimeout Sets the TCP_USER_TIMEOUT option - only with linux native transport.
* @param termJsResource Set term.js resource to use.
* @param tracingPolicy Set the tracing policy for the server behavior when Vert.x has tracing enabled.
* @param trafficClass Set the value of traffic class
* @param trafficShapingOptions Set traffic shaping options. If not specified, traffic is unthrottled.
* @param trustOptions Set the trust options.
* @param trustStoreOptions Set the trust options in jks format, aka Java truststore
* @param useAlpn Set the ALPN usage.
* @param useProxyProtocol Set whether the server uses the HA Proxy protocol
* @param vertsShellJsResource Set vertxshell.js resource to use.
* @param webSocketAllowServerNoContext Set whether the WebSocket server will accept the server_no_context_takeover parameter of the per-message deflate compression extension offered by the client.
* @param webSocketClosingTimeout Set the amount of time a server WebSocket will wait until it closes the TCP connection after sending a close frame. When a server closes a WebSocket, it should wait the client close frame to close the TCP connection. This timeout will close the TCP connection on the server when it expires. When the TCP connection is closed receiving the close frame, the instead of the will be called.
Set to 0L closes the TCP connection immediately after sending the close frame.
Set to a negative value to disable it.
* @param webSocketCompressionLevel Set the WebSocket compression level.
* @param webSocketPreferredClientNoContext Set whether the WebSocket server will accept the client_no_context_takeover parameter of the per-message deflate compression extension offered by the client.
* @param webSocketSubProtocols Set the WebSocket list of sub-protocol supported by the server.
* @param writeIdleTimeout Set the write idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is sent within the timeout. If you want change default time unit, use [io.vertx.core.http.HttpServerOptions]
*
*
* NOTE: This function has been automatically generated from the [io.vertx.ext.shell.term.HttpTermOptions original] using Vert.x codegen.
*/
fun httpTermOptionsOf(
acceptBacklog: Int? = null,
acceptUnmaskedFrames: Boolean? = null,
activityLogDataFormat: ByteBufFormat? = null,
alpnVersions: Iterable? = null,
authOptions: io.vertx.core.json.JsonObject? = null,
charset: String? = null,
clientAuth: ClientAuth? = null,
compressionLevel: Int? = null,
compressionSupported: Boolean? = null,
compressors: Iterable? = null,
crlPaths: Iterable? = null,
crlValues: Iterable? = null,
decoderInitialBufferSize: Int? = null,
decompressionSupported: Boolean? = null,
enabledCipherSuites: Iterable? = null,
enabledSecureTransportProtocols: Iterable? = null,
handle100ContinueAutomatically: Boolean? = null,
host: String? = null,
http2ConnectionWindowSize: Int? = null,
http2RstFloodMaxRstFramePerWindow: Int? = null,
http2RstFloodWindowDuration: Int? = null,
http2RstFloodWindowDurationTimeUnit: TimeUnit? = null,
idleTimeout: Int? = null,
idleTimeoutUnit: TimeUnit? = null,
initialSettings: io.vertx.core.http.Http2Settings? = null,
intputrc: String? = null,
jdkSslEngineOptions: io.vertx.core.net.JdkSSLEngineOptions? = null,
keyCertOptions: io.vertx.core.net.KeyCertOptions? = null,
keyStoreOptions: io.vertx.core.net.JksOptions? = null,
logActivity: Boolean? = null,
maxChunkSize: Int? = null,
maxFormAttributeSize: Int? = null,
maxFormBufferedBytes: Int? = null,
maxFormFields: Int? = null,
maxHeaderSize: Int? = null,
maxInitialLineLength: Int? = null,
maxWebSocketFrameSize: Int? = null,
maxWebSocketMessageSize: Int? = null,
openSslEngineOptions: io.vertx.core.net.OpenSSLEngineOptions? = null,
pemKeyCertOptions: io.vertx.core.net.PemKeyCertOptions? = null,
pemTrustOptions: io.vertx.core.net.PemTrustOptions? = null,
perFrameWebSocketCompressionSupported: Boolean? = null,
perMessageWebSocketCompressionSupported: Boolean? = null,
pfxKeyCertOptions: io.vertx.core.net.PfxOptions? = null,
pfxTrustOptions: io.vertx.core.net.PfxOptions? = null,
port: Int? = null,
proxyProtocolTimeout: Long? = null,
proxyProtocolTimeoutUnit: TimeUnit? = null,
readIdleTimeout: Int? = null,
receiveBufferSize: Int? = null,
registerWebSocketWriteHandlers: Boolean? = null,
registerWriteHandler: Boolean? = null,
reuseAddress: Boolean? = null,
reusePort: Boolean? = null,
sendBufferSize: Int? = null,
shellHtmlResource: io.vertx.core.buffer.Buffer? = null,
sni: Boolean? = null,
soLinger: Int? = null,
sockJSHandlerOptions: io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions? = null,
sockJSPath: String? = null,
ssl: Boolean? = null,
sslEngineOptions: io.vertx.core.net.SSLEngineOptions? = null,
sslHandshakeTimeout: Long? = null,
sslHandshakeTimeoutUnit: TimeUnit? = null,
tcpCork: Boolean? = null,
tcpFastOpen: Boolean? = null,
tcpKeepAlive: Boolean? = null,
tcpNoDelay: Boolean? = null,
tcpQuickAck: Boolean? = null,
tcpUserTimeout: Int? = null,
termJsResource: io.vertx.core.buffer.Buffer? = null,
tracingPolicy: TracingPolicy? = null,
trafficClass: Int? = null,
trafficShapingOptions: io.vertx.core.net.TrafficShapingOptions? = null,
trustOptions: io.vertx.core.net.TrustOptions? = null,
trustStoreOptions: io.vertx.core.net.JksOptions? = null,
useAlpn: Boolean? = null,
useProxyProtocol: Boolean? = null,
vertsShellJsResource: io.vertx.core.buffer.Buffer? = null,
webSocketAllowServerNoContext: Boolean? = null,
webSocketClosingTimeout: Int? = null,
webSocketCompressionLevel: Int? = null,
webSocketPreferredClientNoContext: Boolean? = null,
webSocketSubProtocols: Iterable? = null,
writeIdleTimeout: Int? = null): HttpTermOptions = io.vertx.ext.shell.term.HttpTermOptions().apply {
if (acceptBacklog != null) {
this.setAcceptBacklog(acceptBacklog)
}
if (acceptUnmaskedFrames != null) {
this.setAcceptUnmaskedFrames(acceptUnmaskedFrames)
}
if (activityLogDataFormat != null) {
this.setActivityLogDataFormat(activityLogDataFormat)
}
if (alpnVersions != null) {
this.setAlpnVersions(alpnVersions.toList())
}
if (authOptions != null) {
this.setAuthOptions(authOptions)
}
if (charset != null) {
this.setCharset(charset)
}
if (clientAuth != null) {
this.setClientAuth(clientAuth)
}
if (compressionLevel != null) {
this.setCompressionLevel(compressionLevel)
}
if (compressionSupported != null) {
this.setCompressionSupported(compressionSupported)
}
if (compressors != null) {
this.setCompressors(compressors.toList())
}
if (crlPaths != null) {
for (item in crlPaths) {
this.addCrlPath(item)
}
}
if (crlValues != null) {
for (item in crlValues) {
this.addCrlValue(item)
}
}
if (decoderInitialBufferSize != null) {
this.setDecoderInitialBufferSize(decoderInitialBufferSize)
}
if (decompressionSupported != null) {
this.setDecompressionSupported(decompressionSupported)
}
if (enabledCipherSuites != null) {
for (item in enabledCipherSuites) {
this.addEnabledCipherSuite(item)
}
}
if (enabledSecureTransportProtocols != null) {
this.setEnabledSecureTransportProtocols(enabledSecureTransportProtocols.toSet())
}
if (handle100ContinueAutomatically != null) {
this.setHandle100ContinueAutomatically(handle100ContinueAutomatically)
}
if (host != null) {
this.setHost(host)
}
if (http2ConnectionWindowSize != null) {
this.setHttp2ConnectionWindowSize(http2ConnectionWindowSize)
}
if (http2RstFloodMaxRstFramePerWindow != null) {
this.setHttp2RstFloodMaxRstFramePerWindow(http2RstFloodMaxRstFramePerWindow)
}
if (http2RstFloodWindowDuration != null) {
this.setHttp2RstFloodWindowDuration(http2RstFloodWindowDuration)
}
if (http2RstFloodWindowDurationTimeUnit != null) {
this.setHttp2RstFloodWindowDurationTimeUnit(http2RstFloodWindowDurationTimeUnit)
}
if (idleTimeout != null) {
this.setIdleTimeout(idleTimeout)
}
if (idleTimeoutUnit != null) {
this.setIdleTimeoutUnit(idleTimeoutUnit)
}
if (initialSettings != null) {
this.setInitialSettings(initialSettings)
}
if (intputrc != null) {
this.setIntputrc(intputrc)
}
if (jdkSslEngineOptions != null) {
this.setJdkSslEngineOptions(jdkSslEngineOptions)
}
if (keyCertOptions != null) {
this.setKeyCertOptions(keyCertOptions)
}
if (keyStoreOptions != null) {
this.setKeyStoreOptions(keyStoreOptions)
}
if (logActivity != null) {
this.setLogActivity(logActivity)
}
if (maxChunkSize != null) {
this.setMaxChunkSize(maxChunkSize)
}
if (maxFormAttributeSize != null) {
this.setMaxFormAttributeSize(maxFormAttributeSize)
}
if (maxFormBufferedBytes != null) {
this.setMaxFormBufferedBytes(maxFormBufferedBytes)
}
if (maxFormFields != null) {
this.setMaxFormFields(maxFormFields)
}
if (maxHeaderSize != null) {
this.setMaxHeaderSize(maxHeaderSize)
}
if (maxInitialLineLength != null) {
this.setMaxInitialLineLength(maxInitialLineLength)
}
if (maxWebSocketFrameSize != null) {
this.setMaxWebSocketFrameSize(maxWebSocketFrameSize)
}
if (maxWebSocketMessageSize != null) {
this.setMaxWebSocketMessageSize(maxWebSocketMessageSize)
}
if (openSslEngineOptions != null) {
this.setOpenSslEngineOptions(openSslEngineOptions)
}
if (pemKeyCertOptions != null) {
this.setPemKeyCertOptions(pemKeyCertOptions)
}
if (pemTrustOptions != null) {
this.setPemTrustOptions(pemTrustOptions)
}
if (perFrameWebSocketCompressionSupported != null) {
this.setPerFrameWebSocketCompressionSupported(perFrameWebSocketCompressionSupported)
}
if (perMessageWebSocketCompressionSupported != null) {
this.setPerMessageWebSocketCompressionSupported(perMessageWebSocketCompressionSupported)
}
if (pfxKeyCertOptions != null) {
this.setPfxKeyCertOptions(pfxKeyCertOptions)
}
if (pfxTrustOptions != null) {
this.setPfxTrustOptions(pfxTrustOptions)
}
if (port != null) {
this.setPort(port)
}
if (proxyProtocolTimeout != null) {
this.setProxyProtocolTimeout(proxyProtocolTimeout)
}
if (proxyProtocolTimeoutUnit != null) {
this.setProxyProtocolTimeoutUnit(proxyProtocolTimeoutUnit)
}
if (readIdleTimeout != null) {
this.setReadIdleTimeout(readIdleTimeout)
}
if (receiveBufferSize != null) {
this.setReceiveBufferSize(receiveBufferSize)
}
if (registerWebSocketWriteHandlers != null) {
this.setRegisterWebSocketWriteHandlers(registerWebSocketWriteHandlers)
}
if (registerWriteHandler != null) {
this.setRegisterWriteHandler(registerWriteHandler)
}
if (reuseAddress != null) {
this.setReuseAddress(reuseAddress)
}
if (reusePort != null) {
this.setReusePort(reusePort)
}
if (sendBufferSize != null) {
this.setSendBufferSize(sendBufferSize)
}
if (shellHtmlResource != null) {
this.setShellHtmlResource(shellHtmlResource)
}
if (sni != null) {
this.setSni(sni)
}
if (soLinger != null) {
this.setSoLinger(soLinger)
}
if (sockJSHandlerOptions != null) {
this.setSockJSHandlerOptions(sockJSHandlerOptions)
}
if (sockJSPath != null) {
this.setSockJSPath(sockJSPath)
}
if (ssl != null) {
this.setSsl(ssl)
}
if (sslEngineOptions != null) {
this.setSslEngineOptions(sslEngineOptions)
}
if (sslHandshakeTimeout != null) {
this.setSslHandshakeTimeout(sslHandshakeTimeout)
}
if (sslHandshakeTimeoutUnit != null) {
this.setSslHandshakeTimeoutUnit(sslHandshakeTimeoutUnit)
}
if (tcpCork != null) {
this.setTcpCork(tcpCork)
}
if (tcpFastOpen != null) {
this.setTcpFastOpen(tcpFastOpen)
}
if (tcpKeepAlive != null) {
this.setTcpKeepAlive(tcpKeepAlive)
}
if (tcpNoDelay != null) {
this.setTcpNoDelay(tcpNoDelay)
}
if (tcpQuickAck != null) {
this.setTcpQuickAck(tcpQuickAck)
}
if (tcpUserTimeout != null) {
this.setTcpUserTimeout(tcpUserTimeout)
}
if (termJsResource != null) {
this.setTermJsResource(termJsResource)
}
if (tracingPolicy != null) {
this.setTracingPolicy(tracingPolicy)
}
if (trafficClass != null) {
this.setTrafficClass(trafficClass)
}
if (trafficShapingOptions != null) {
this.setTrafficShapingOptions(trafficShapingOptions)
}
if (trustOptions != null) {
this.setTrustOptions(trustOptions)
}
if (trustStoreOptions != null) {
this.setTrustStoreOptions(trustStoreOptions)
}
if (useAlpn != null) {
this.setUseAlpn(useAlpn)
}
if (useProxyProtocol != null) {
this.setUseProxyProtocol(useProxyProtocol)
}
if (vertsShellJsResource != null) {
this.setVertsShellJsResource(vertsShellJsResource)
}
if (webSocketAllowServerNoContext != null) {
this.setWebSocketAllowServerNoContext(webSocketAllowServerNoContext)
}
if (webSocketClosingTimeout != null) {
this.setWebSocketClosingTimeout(webSocketClosingTimeout)
}
if (webSocketCompressionLevel != null) {
this.setWebSocketCompressionLevel(webSocketCompressionLevel)
}
if (webSocketPreferredClientNoContext != null) {
this.setWebSocketPreferredClientNoContext(webSocketPreferredClientNoContext)
}
if (webSocketSubProtocols != null) {
this.setWebSocketSubProtocols(webSocketSubProtocols.toList())
}
if (writeIdleTimeout != null) {
this.setWriteIdleTimeout(writeIdleTimeout)
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy