public class HttpTermOptions extends HttpServerOptions
| Modifier and Type | Field and Description |
|---|---|
static String |
DEFAULT_CHARSET |
static String |
DEFAULT_INPUTRC |
DEFAULT_ACCEPT_UNMASKED_FRAMES, DEFAULT_ALPN_VERSIONS, DEFAULT_COMPRESSION_LEVEL, DEFAULT_COMPRESSION_SUPPORTED, DEFAULT_DECODER_INITIAL_BUFFER_SIZE, DEFAULT_DECOMPRESSION_SUPPORTED, DEFAULT_HANDLE_100_CONTINE_AUTOMATICALLY, DEFAULT_HTTP2_CONNECTION_WINDOW_SIZE, DEFAULT_INITIAL_SETTINGS_MAX_CONCURRENT_STREAMS, DEFAULT_MAX_CHUNK_SIZE, DEFAULT_MAX_FORM_ATTRIBUTE_SIZE, DEFAULT_MAX_HEADER_SIZE, DEFAULT_MAX_INITIAL_LINE_LENGTH, DEFAULT_MAX_WEBSOCKET_FRAME_SIZE, DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE, DEFAULT_PER_FRAME_WEBSOCKET_COMPRESSION_SUPPORTED, DEFAULT_PER_MESSAGE_WEBSOCKET_COMPRESSION_SUPPORTED, DEFAULT_PORT, DEFAULT_TRACING_POLICY, DEFAULT_WEBSOCKET_ALLOW_SERVER_NO_CONTEXT, DEFAULT_WEBSOCKET_CLOSING_TIMEOUT, DEFAULT_WEBSOCKET_COMPRESSION_LEVEL, DEFAULT_WEBSOCKET_PREFERRED_CLIENT_NO_CONTEXTDEFAULT_ACCEPT_BACKLOG, DEFAULT_CLIENT_AUTH, DEFAULT_HOST, DEFAULT_PROXY_PROTOCOL_TIMEOUT, DEFAULT_PROXY_PROTOCOL_TIMEOUT_TIME_UNIT, DEFAULT_SNI, DEFAULT_USE_PROXY_PROTOCOLDEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS, DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_SSL_HANDSHAKE_TIMEOUT, DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT, DEFAULT_TCP_CORK, DEFAULT_TCP_FAST_OPEN, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_QUICKACK, DEFAULT_USE_ALPNDEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS| Constructor and Description |
|---|
HttpTermOptions() |
HttpTermOptions(HttpTermOptions that) |
HttpTermOptions(JsonObject json) |
| Modifier and Type | Method and Description |
|---|---|
HttpTermOptions |
addCrlPath(String crlPath)
Add a CRL path
|
HttpTermOptions |
addCrlValue(Buffer crlValue)
Add a CRL value
|
HttpTermOptions |
addEnabledCipherSuite(String suite)
Add an enabled cipher suite, appended to the ordered suites.
|
static Buffer |
defaultShellHtmlResource() |
static Buffer |
defaultTermJsResource() |
static Buffer |
defaultVertxShellJsResource() |
JsonObject |
getAuthOptions() |
String |
getCharset() |
String |
getIntputrc() |
Buffer |
getShellHtmlResource() |
SockJSHandlerOptions |
getSockJSHandlerOptions() |
String |
getSockJSPath() |
Buffer |
getTermJsResource() |
Buffer |
getVertsShellJsResource() |
HttpTermOptions |
setAcceptBacklog(int acceptBacklog)
Set the accept back log
|
HttpTermOptions |
setAuthOptions(JsonObject authOptions)
Set the auth options.
|
HttpTermOptions |
setCharset(String charset)
Set the charset used for encoding / decoding text data from/to SockJS
|
HttpTermOptions |
setClientAuth(ClientAuth clientAuth)
Set whether client auth is required
|
HttpTermOptions |
setCompressionSupported(boolean compressionSupported)
Set whether the server should support gzip/deflate compression
(serving compressed responses to clients advertising support for them with Accept-Encoding header)
|
HttpTermOptions |
setHandle100ContinueAutomatically(boolean handle100ContinueAutomatically)
Set whether 100 Continue should be handled automatically
|
HttpTermOptions |
setHost(String host)
Set the host
|
HttpTermOptions |
setIdleTimeout(int idleTimeout)
Set the idle timeout, default time unit is seconds.
|
HttpTermOptions |
setIntputrc(String intputrc)
The path of the inputrc config.
|
HttpTermOptions |
setKeyStoreOptions(JksOptions options)
Set the key/cert options in jks format, aka Java keystore.
|
HttpTermOptions |
setPemKeyCertOptions(PemKeyCertOptions options)
Set the key/cert store options in pem format.
|
HttpTermOptions |
setPemTrustOptions(PemTrustOptions options)
Set the trust options in pem format
|
HttpTermOptions |
setPfxKeyCertOptions(PfxOptions options)
Set the key/cert options in pfx format.
|
HttpTermOptions |
setPfxTrustOptions(PfxOptions options)
Set the trust options in pfx format
|
HttpTermOptions |
setPort(int port)
Set the port
|
HttpTermOptions |
setReceiveBufferSize(int receiveBufferSize)
Set the TCP receive buffer size
|
HttpTermOptions |
setReuseAddress(boolean reuseAddress)
Set the value of reuse address
|
HttpTermOptions |
setSendBufferSize(int sendBufferSize)
Set the TCP send buffer size
|
HttpTermOptions |
setShellHtmlResource(Buffer shellHtmlResource)
Set
shell.html resource to use. |
HttpTermOptions |
setSockJSHandlerOptions(SockJSHandlerOptions sockJSHandlerOptions)
The SockJS handler options.
|
HttpTermOptions |
setSockJSPath(String sockJSPath)
Configure the SockJS path, the default value is
/term/*. |
HttpTermOptions |
setSoLinger(int soLinger)
Set whether SO_linger keep alive is enabled
|
HttpTermOptions |
setSsl(boolean ssl)
Set whether SSL/TLS is enabled
|
HttpTermOptions |
setTcpKeepAlive(boolean tcpKeepAlive)
Set whether TCP keep alive is enabled
|
HttpTermOptions |
setTcpNoDelay(boolean tcpNoDelay)
Set whether TCP no delay is enabled
|
HttpTermOptions |
setTermJsResource(Buffer termJsResource)
Set
term.js resource to use. |
HttpTermOptions |
setTrafficClass(int trafficClass)
Set the value of traffic class
|
HttpTermOptions |
setTrustStoreOptions(JksOptions options)
Set the trust options in jks format, aka Java truststore
|
HttpTermOptions |
setVertsShellJsResource(Buffer vertsShellJsResource)
Set
vertxshell.js resource to use. |
addEnabledSecureTransportProtocol, addWebSocketSubProtocol, getAlpnVersions, getCompressionLevel, getDecoderInitialBufferSize, getHttp2ConnectionWindowSize, getInitialSettings, getMaxChunkSize, getMaxFormAttributeSize, getMaxHeaderSize, getMaxInitialLineLength, getMaxWebSocketFrameSize, getMaxWebSocketMessageSize, getPerFrameWebSocketCompressionSupported, getPerMessageWebSocketCompressionSupported, getTracingPolicy, getWebSocketAllowServerNoContext, getWebSocketClosingTimeout, getWebSocketCompressionLevel, getWebSocketPreferredClientNoContext, getWebSocketSubProtocols, isAcceptUnmaskedFrames, isCompressionSupported, isDecompressionSupported, isHandle100ContinueAutomatically, removeEnabledSecureTransportProtocol, setAcceptUnmaskedFrames, setAlpnVersions, setCompressionLevel, setDecoderInitialBufferSize, setDecompressionSupported, setEnabledSecureTransportProtocols, setHttp2ConnectionWindowSize, setIdleTimeoutUnit, setInitialSettings, setJdkSslEngineOptions, setKeyCertOptions, setLogActivity, setMaxChunkSize, setMaxFormAttributeSize, setMaxHeaderSize, setMaxInitialLineLength, setMaxWebSocketFrameSize, setMaxWebSocketMessageSize, setOpenSslEngineOptions, setPerFrameWebSocketCompressionSupported, setPerMessageWebSocketCompressionSupported, setProxyProtocolTimeout, setProxyProtocolTimeoutUnit, setReusePort, setSni, setSslEngineOptions, setSslHandshakeTimeout, setSslHandshakeTimeoutUnit, setTcpCork, setTcpFastOpen, setTcpQuickAck, setTracingPolicy, setTrustOptions, setUseAlpn, setUseProxyProtocol, setWebSocketAllowServerNoContext, setWebSocketClosingTimeout, setWebSocketCompressionLevel, setWebSocketPreferredClientNoContext, setWebSocketSubProtocols, toJsongetAcceptBacklog, getClientAuth, getHost, getPort, getProxyProtocolTimeout, getProxyProtocolTimeoutUnit, isSni, isUseProxyProtocolgetCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTrustOptions, getTrustStoreOptions, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpngetLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePortpublic static final String DEFAULT_CHARSET
public static final String DEFAULT_INPUTRC
public HttpTermOptions()
public HttpTermOptions(JsonObject json)
public HttpTermOptions(HttpTermOptions that)
public static Buffer defaultVertxShellJsResource()
vertxshell.js default resource as a bufferpublic static Buffer defaultTermJsResource()
term.js default resource as a bufferpublic static Buffer defaultShellHtmlResource()
shell.html default resource as a bufferpublic SockJSHandlerOptions getSockJSHandlerOptions()
public HttpTermOptions setSockJSHandlerOptions(SockJSHandlerOptions sockJSHandlerOptions)
sockJSHandlerOptions - the options to usepublic String getSockJSPath()
public HttpTermOptions setSockJSPath(String sockJSPath)
/term/*.sockJSPath - the new SockJS pathpublic JsonObject getAuthOptions()
public HttpTermOptions setAuthOptions(JsonObject authOptions)
authOptions - the auth optionspublic HttpTermOptions setSendBufferSize(int sendBufferSize)
NetworkOptionssetSendBufferSize in class HttpServerOptionssendBufferSize - the buffers size, in bytespublic HttpTermOptions setReceiveBufferSize(int receiveBufferSize)
NetworkOptionssetReceiveBufferSize in class HttpServerOptionsreceiveBufferSize - the buffers size, in bytespublic HttpTermOptions setReuseAddress(boolean reuseAddress)
NetworkOptionssetReuseAddress in class HttpServerOptionsreuseAddress - the value of reuse addresspublic HttpTermOptions setTrafficClass(int trafficClass)
NetworkOptionssetTrafficClass in class HttpServerOptionstrafficClass - the value of traffic classpublic HttpTermOptions setTcpNoDelay(boolean tcpNoDelay)
TCPSSLOptionssetTcpNoDelay in class HttpServerOptionstcpNoDelay - true if TCP no delay is enabled (Nagle disabled)public HttpTermOptions setTcpKeepAlive(boolean tcpKeepAlive)
TCPSSLOptionssetTcpKeepAlive in class HttpServerOptionstcpKeepAlive - true if TCP keep alive is enabledpublic HttpTermOptions setSoLinger(int soLinger)
TCPSSLOptionssetSoLinger in class HttpServerOptionssoLinger - true if SO_linger is enabledpublic HttpTermOptions setIdleTimeout(int idleTimeout)
TCPSSLOptionsTCPSSLOptions.setIdleTimeoutUnit(TimeUnit)setIdleTimeout in class HttpServerOptionsidleTimeout - the timeout, in secondspublic HttpTermOptions setSsl(boolean ssl)
TCPSSLOptionssetSsl in class HttpServerOptionsssl - true if enabledpublic HttpTermOptions setKeyStoreOptions(JksOptions options)
TCPSSLOptionssetKeyStoreOptions in class HttpServerOptionsoptions - the key store in jks formatpublic HttpTermOptions setPfxKeyCertOptions(PfxOptions options)
TCPSSLOptionssetPfxKeyCertOptions in class HttpServerOptionsoptions - the key cert options in pfx formatpublic HttpTermOptions setPemKeyCertOptions(PemKeyCertOptions options)
TCPSSLOptionssetPemKeyCertOptions in class HttpServerOptionsoptions - the options in pem formatpublic HttpTermOptions setTrustStoreOptions(JksOptions options)
TCPSSLOptionssetTrustStoreOptions in class HttpServerOptionsoptions - the trust options in jks formatpublic HttpTermOptions setPemTrustOptions(PemTrustOptions options)
TCPSSLOptionssetPemTrustOptions in class HttpServerOptionsoptions - the trust options in pem formatpublic HttpTermOptions setPfxTrustOptions(PfxOptions options)
TCPSSLOptionssetPfxTrustOptions in class HttpServerOptionsoptions - the trust options in pfx formatpublic HttpTermOptions addEnabledCipherSuite(String suite)
TCPSSLOptionsaddEnabledCipherSuite in class HttpServerOptionssuite - the suiteTCPSSLOptions.getEnabledCipherSuites()public HttpTermOptions addCrlPath(String crlPath) throws NullPointerException
TCPSSLOptionsaddCrlPath in class HttpServerOptionscrlPath - the pathNullPointerExceptionpublic HttpTermOptions addCrlValue(Buffer crlValue) throws NullPointerException
TCPSSLOptionsaddCrlValue in class HttpServerOptionscrlValue - the valueNullPointerExceptionpublic HttpTermOptions setAcceptBacklog(int acceptBacklog)
NetServerOptionssetAcceptBacklog in class HttpServerOptionsacceptBacklog - accept backlogpublic HttpTermOptions setPort(int port)
NetServerOptionssetPort in class HttpServerOptionsport - the portpublic HttpTermOptions setHost(String host)
NetServerOptionssetHost in class HttpServerOptionshost - the hostpublic HttpTermOptions setClientAuth(ClientAuth clientAuth)
NetServerOptionssetClientAuth in class HttpServerOptionsclientAuth - One of "NONE, REQUEST, REQUIRED". If it's set to "REQUIRED" then server will require the
SSL cert to be presented otherwise it won't accept the request. If it's set to "REQUEST" then
it won't mandate the certificate to be presented, basically make it optional.public HttpTermOptions setCompressionSupported(boolean compressionSupported)
HttpServerOptionssetCompressionSupported in class HttpServerOptionscompressionSupported - true to enable compression supportpublic HttpTermOptions setHandle100ContinueAutomatically(boolean handle100ContinueAutomatically)
HttpServerOptionssetHandle100ContinueAutomatically in class HttpServerOptionshandle100ContinueAutomatically - true if it should be handled automaticallypublic Buffer getVertsShellJsResource()
vertxshell.js resource for this serverpublic HttpTermOptions setVertsShellJsResource(Buffer vertsShellJsResource)
vertxshell.js resource to use.vertsShellJsResource - the resourcepublic Buffer getTermJsResource()
term.js resource for this serverpublic HttpTermOptions setTermJsResource(Buffer termJsResource)
term.js resource to use.termJsResource - the resourcepublic Buffer getShellHtmlResource()
shell.html resource for this serverpublic HttpTermOptions setShellHtmlResource(Buffer shellHtmlResource)
shell.html resource to use.shellHtmlResource - the resourcepublic String getCharset()
public HttpTermOptions setCharset(String charset)
charset - the charset to usepublic String getIntputrc()
public HttpTermOptions setIntputrc(String intputrc)
intputrc - the path of the inputrc configCopyright © 2021 Eclipse. All rights reserved.