HttpTermOptions

The web term configuration options.

Name

Type

Description

@acceptBacklog

Number (int)

-

@acceptUnmaskedFrames

Boolean

-

@alpnVersions

Array of HttpVersion

-

@authOptions

Json object

Set the auth options.

@charset

String

Set the charset used for encoding / decoding text data from/to SockJS

@clientAuth

ClientAuth

-

@compressionLevel

Number (int)

-

@compressionSupported

Boolean

-

@crlPaths

Array of String

-

@crlValues

Array of Buffer

-

@decoderInitialBufferSize

Number (int)

-

@decompressionSupported

Boolean

-

@enabledCipherSuites

Array of String

-

@enabledSecureTransportProtocols

Array of String

-

@handle100ContinueAutomatically

Boolean

-

@host

String

-

@http2ConnectionWindowSize

Number (int)

-

@idleTimeout

Number (int)

-

@idleTimeoutUnit

TimeUnit

-

@intputrc

String

The path of the inputrc config.

@logActivity

Boolean

-

@maxChunkSize

Number (int)

-

@maxHeaderSize

Number (int)

-

@maxInitialLineLength

Number (int)

-

@maxWebSocketFrameSize

Number (int)

-

@maxWebSocketMessageSize

Number (int)

-

@perFrameWebSocketCompressionSupported

Boolean

-

@perMessageWebSocketCompressionSupported

Boolean

-

@port

Number (int)

-

@proxyProtocolTimeout

Number (long)

-

@proxyProtocolTimeoutUnit

TimeUnit

-

@receiveBufferSize

Number (int)

-

@reuseAddress

Boolean

-

@reusePort

Boolean

-

@sendBufferSize

Number (int)

-

@shellHtmlResource

Buffer

Set shell.html resource to use.

@sni

Boolean

-

@soLinger

Number (int)

-

@sockJSPath

String

Configure the SockJS path, the default value is /term/*.

@ssl

Boolean

-

@sslHandshakeTimeout

Number (long)

-

@sslHandshakeTimeoutUnit

TimeUnit

-

@tcpCork

Boolean

-

@tcpFastOpen

Boolean

-

@tcpKeepAlive

Boolean

-

@tcpNoDelay

Boolean

-

@tcpQuickAck

Boolean

-

@termJsResource

Buffer

Set term.js resource to use.

@trafficClass

Number (int)

-

@useAlpn

Boolean

-

@useProxyProtocol

Boolean

-

@vertsShellJsResource

Buffer

Set vertxshell.js resource to use.

@webSocketAllowServerNoContext

Boolean

-

@webSocketCompressionLevel

Number (int)

-

@webSocketPreferredClientNoContext

Boolean

-

@webSocketSubProtocols

Array of String

-

SSHTermOptions

The SSH term configuration options.

Name

Type

Description

@authOptions

Json object

Set the auth options.

@defaultCharset

String

Set the default charset to use when the client does not specifies one.

@host

String

Set the host

@intputrc

String

The path of the inputrc config.

@port

Number (int)

Set the port

ShellServerOptions

The configurations options for the shell server.

Name

Type

Description

@reaperInterval

Number (long)

Set the repear interval, i.e the period at which session eviction is performed.

@sessionTimeout

Number (long)

Set the session timeout.

@welcomeMessage

String

Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

ShellServiceOptions

The configurations options for the shell service, the shell connectors can be configured with , and .

Name

Type

Description

@reaperInterval

Number (long)

Set the repear interval, i.e the period at which session eviction is performed.

@sessionTimeout

Number (long)

Set the session timeout.

@welcomeMessage

String

Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

TelnetTermOptions

Telnet terminal options configuration, extends link.

Name

Type

Description

@acceptBacklog

Number (int)

-

@charset

String

Set the charset to use when binary mode is active, see link and link.

@clientAuth

ClientAuth

-

@crlPaths

Array of String

-

@crlValues

Array of Buffer

-

@enabledCipherSuites

Array of String

-

@enabledSecureTransportProtocols

Array of String

-

@host

String

-

@idleTimeout

Number (int)

-

@idleTimeoutUnit

TimeUnit

-

@inBinary

Boolean

Set the telnet connection to negociate binary data format when receiving from the client, the default value is true. This allows to send data in 8 bit format and thus charset like UTF-8.

@intputrc

String

The path of the inputrc config.

@logActivity

Boolean

-

@outBinary

Boolean

Set the telnet connection to negociate binary data format when sending to the client, the default value is true. This allows to send data in 8 bit format and thus charset like UTF-8.

@port

Number (int)

-

@proxyProtocolTimeout

Number (long)

-

@proxyProtocolTimeoutUnit

TimeUnit

-

@receiveBufferSize

Number (int)

-

@reuseAddress

Boolean

-

@reusePort

Boolean

-

@sendBufferSize

Number (int)

-

@sni

Boolean

-

@soLinger

Number (int)

-

@ssl

Boolean

-

@sslHandshakeTimeout

Number (long)

-

@sslHandshakeTimeoutUnit

TimeUnit

-

@tcpCork

Boolean

-

@tcpFastOpen

Boolean

-

@tcpKeepAlive

Boolean

-

@tcpNoDelay

Boolean

-

@tcpQuickAck

Boolean

-

@trafficClass

Number (int)

-

@useAlpn

Boolean

-

@useProxyProtocol

Boolean

-