Package io.vertx.ext.shell.term

Class HttpTermOptions

java.lang.Object

io.vertx.core.net.NetworkOptions

io.vertx.core.net.TCPSSLOptions

io.vertx.core.net.NetServerOptions

io.vertx.core.http.HttpServerOptions

io.vertx.ext.shell.term.HttpTermOptions

public class HttpTermOptions
extends HttpServerOptions

The web term configuration options.

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_CHARSET
static String	DEFAULT_INPUTRC

Fields inherited from class io.vertx.core.http.HttpServerOptions

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_CLEAR_TEXT_ENABLED, DEFAULT_HTTP2_CONNECTION_WINDOW_SIZE, DEFAULT_HTTP2_RST_FLOOD_MAX_RST_FRAME_PER_WINDOW, DEFAULT_HTTP2_RST_FLOOD_WINDOW_DURATION, DEFAULT_HTTP2_RST_FLOOD_WINDOW_DURATION_TIME_UNIT, DEFAULT_INITIAL_SETTINGS_MAX_CONCURRENT_STREAMS, DEFAULT_MAX_CHUNK_SIZE, DEFAULT_MAX_FORM_ATTRIBUTE_SIZE, DEFAULT_MAX_FORM_BUFFERED_SIZE, DEFAULT_MAX_FORM_FIELDS, 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_REGISTER_WEBSOCKET_WRITE_HANDLERS, DEFAULT_TRACING_POLICY, DEFAULT_WEBSOCKET_ALLOW_SERVER_NO_CONTEXT, DEFAULT_WEBSOCKET_CLOSING_TIMEOUT, DEFAULT_WEBSOCKET_COMPRESSION_LEVEL, DEFAULT_WEBSOCKET_PREFERRED_CLIENT_NO_CONTEXT

Fields inherited from class io.vertx.core.net.NetServerOptions

DEFAULT_ACCEPT_BACKLOG, DEFAULT_HOST, DEFAULT_PROXY_PROTOCOL_TIMEOUT, DEFAULT_PROXY_PROTOCOL_TIMEOUT_TIME_UNIT, DEFAULT_REGISTER_WRITE_HANDLER, DEFAULT_USE_PROXY_PROTOCOL

Fields inherited from class io.vertx.core.net.TCPSSLOptions

DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, DEFAULT_READ_IDLE_TIMEOUT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_TCP_CORK, DEFAULT_TCP_FAST_OPEN, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_QUICKACK, DEFAULT_TCP_USER_TIMEOUT, DEFAULT_WRITE_IDLE_TIMEOUT

Fields inherited from class io.vertx.core.net.NetworkOptions

DEFAULT_LOG_ACTIVITY_FORMAT, DEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS

Constructor Summary

Constructors

Constructor	Description
HttpTermOptions()
HttpTermOptions(JsonObject json)
HttpTermOptions(HttpTermOptions that)

Method Summary

Modifier and Type	Method	Description
HttpTermOptions	addCrlPath(String crlPath)
HttpTermOptions	addCrlValue(Buffer crlValue)
HttpTermOptions	addEnabledCipherSuite(String suite)
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)
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)
HttpTermOptions	setCompressionSupported(boolean compressionSupported)
HttpTermOptions	setHandle100ContinueAutomatically(boolean handle100ContinueAutomatically)
HttpTermOptions	setHost(String host)
HttpTermOptions	setIdleTimeout(int idleTimeout)
HttpTermOptions	setIntputrc(String intputrc)	The path of the inputrc config.
HttpTermOptions	setPort(int port)
HttpTermOptions	setReceiveBufferSize(int receiveBufferSize)
HttpTermOptions	setReuseAddress(boolean reuseAddress)
HttpTermOptions	setSendBufferSize(int sendBufferSize)
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)
HttpTermOptions	setSsl(boolean ssl)
HttpTermOptions	setTcpKeepAlive(boolean tcpKeepAlive)
HttpTermOptions	setTcpNoDelay(boolean tcpNoDelay)
HttpTermOptions	setTermJsResource(Buffer termJsResource)	Set term.js resource to use.
HttpTermOptions	setTrafficClass(int trafficClass)
HttpTermOptions	setVertsShellJsResource(Buffer vertsShellJsResource)	Set vertxshell.js resource to use.

Methods inherited from class io.vertx.core.http.HttpServerOptions

addCompressor, addEnabledSecureTransportProtocol, addWebSocketSubProtocol, copy, getAlpnVersions, getCompressionLevel, getCompressors, getDecoderInitialBufferSize, getHttp2ConnectionWindowSize, getHttp2RstFloodMaxRstFramePerWindow, getHttp2RstFloodWindowDuration, getHttp2RstFloodWindowDurationTimeUnit, getInitialSettings, getMaxChunkSize, getMaxFormAttributeSize, getMaxFormBufferedBytes, getMaxFormFields, getMaxHeaderSize, getMaxInitialLineLength, getMaxWebSocketFrameSize, getMaxWebSocketMessageSize, getPerFrameWebSocketCompressionSupported, getPerMessageWebSocketCompressionSupported, getTracingPolicy, getWebSocketAllowServerNoContext, getWebSocketClosingTimeout, getWebSocketCompressionLevel, getWebSocketPreferredClientNoContext, getWebSocketSubProtocols, isAcceptUnmaskedFrames, isCompressionSupported, isDecompressionSupported, isFileRegionEnabled, isHandle100ContinueAutomatically, isHttp2ClearTextEnabled, isRegisterWebSocketWriteHandlers, isRegisterWriteHandler, removeEnabledCipherSuite, removeEnabledSecureTransportProtocol, setAcceptUnmaskedFrames, setActivityLogDataFormat, setAlpnVersions, setCompressionLevel, setCompressors, setDecoderInitialBufferSize, setDecompressionSupported, setEnabledSecureTransportProtocols, setHttp2ClearTextEnabled, setHttp2ConnectionWindowSize, setHttp2RstFloodMaxRstFramePerWindow, setHttp2RstFloodWindowDuration, setHttp2RstFloodWindowDurationTimeUnit, setIdleTimeoutUnit, setInitialSettings, setKeyCertOptions, setLogActivity, setMaxChunkSize, setMaxFormAttributeSize, setMaxFormBufferedBytes, setMaxFormFields, setMaxHeaderSize, setMaxInitialLineLength, setMaxWebSocketFrameSize, setMaxWebSocketMessageSize, setPerFrameWebSocketCompressionSupported, setPerMessageWebSocketCompressionSupported, setProxyProtocolTimeout, setProxyProtocolTimeoutUnit, setReadIdleTimeout, setRegisterWebSocketWriteHandlers, setRegisterWriteHandler, setReusePort, setSni, setSslEngineOptions, setSslHandshakeTimeout, setSslHandshakeTimeoutUnit, setTcpCork, setTcpFastOpen, setTcpQuickAck, setTracingPolicy, setTrafficShapingOptions, setTrustOptions, setUseAlpn, setUseProxyProtocol, setWebSocketAllowServerNoContext, setWebSocketClosingTimeout, setWebSocketCompressionLevel, setWebSocketPreferredClientNoContext, setWebSocketSubProtocols, setWriteIdleTimeout, toJson

Methods inherited from class io.vertx.core.net.NetServerOptions

getAcceptBacklog, getClientAuth, getHost, getOrCreateSSLOptions, getPort, getProxyProtocolTimeout, getProxyProtocolTimeoutUnit, getSslOptions, getTrafficShapingOptions, isSni, isUseProxyProtocol

Methods inherited from class io.vertx.core.net.TCPSSLOptions

getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getKeyCertOptions, getReadIdleTimeout, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTcpUserTimeout, getTrustOptions, getWriteIdleTimeout, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn, setTcpUserTimeout

Methods inherited from class io.vertx.core.net.NetworkOptions

getActivityLogDataFormat, getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

DEFAULT_INPUTRC

public static final String DEFAULT_INPUTRC

See Also:

Constant Field Values

Constructor Detail

HttpTermOptions

public HttpTermOptions()

HttpTermOptions

public HttpTermOptions(JsonObject json)

HttpTermOptions

public HttpTermOptions(HttpTermOptions that)

Method Detail

defaultVertxShellJsResource

public static Buffer defaultVertxShellJsResource()

Returns:

the vertxshell.js default resource as a buffer

defaultTermJsResource

public static Buffer defaultTermJsResource()

Returns:

the term.js default resource as a buffer

defaultShellHtmlResource

public static Buffer defaultShellHtmlResource()

Returns:

the shell.html default resource as a buffer

getSockJSHandlerOptions

public SockJSHandlerOptions getSockJSHandlerOptions()

Returns:

the SockJS handler options

setSockJSHandlerOptions

public HttpTermOptions setSockJSHandlerOptions(SockJSHandlerOptions sockJSHandlerOptions)

The SockJS handler options.

Parameters:

sockJSHandlerOptions - the options to use

Returns:

a reference to this, so the API can be used fluently

getSockJSPath

public String getSockJSPath()

Returns:

the SockJS path

setSockJSPath

public HttpTermOptions setSockJSPath(String sockJSPath)

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

Parameters:

sockJSPath - the new SockJS path

Returns:

a reference to this, so the API can be used fluently

getAuthOptions

public JsonObject getAuthOptions()

Returns:

the auth options

setAuthOptions

public HttpTermOptions setAuthOptions(JsonObject authOptions)

Set the auth options.

Parameters:

authOptions - the auth options

Returns:

a reference to this, so the API can be used fluently

setSendBufferSize

public HttpTermOptions setSendBufferSize(int sendBufferSize)

Overrides:

setSendBufferSize in class HttpServerOptions

setReceiveBufferSize

public HttpTermOptions setReceiveBufferSize(int receiveBufferSize)

Overrides:

setReceiveBufferSize in class HttpServerOptions

setReuseAddress

public HttpTermOptions setReuseAddress(boolean reuseAddress)

Overrides:

setReuseAddress in class HttpServerOptions

setTrafficClass

public HttpTermOptions setTrafficClass(int trafficClass)

Overrides:

setTrafficClass in class HttpServerOptions

setTcpNoDelay

public HttpTermOptions setTcpNoDelay(boolean tcpNoDelay)

Overrides:

setTcpNoDelay in class HttpServerOptions

setTcpKeepAlive

public HttpTermOptions setTcpKeepAlive(boolean tcpKeepAlive)

Overrides:

setTcpKeepAlive in class HttpServerOptions

setSoLinger

public HttpTermOptions setSoLinger(int soLinger)

Overrides:

setSoLinger in class HttpServerOptions

setIdleTimeout

public HttpTermOptions setIdleTimeout(int idleTimeout)

Overrides:

setIdleTimeout in class HttpServerOptions

setSsl

public HttpTermOptions setSsl(boolean ssl)

Overrides:

setSsl in class HttpServerOptions

addEnabledCipherSuite

public HttpTermOptions addEnabledCipherSuite(String suite)

Overrides:

addEnabledCipherSuite in class HttpServerOptions

addCrlPath

public HttpTermOptions addCrlPath(String crlPath)
                           throws NullPointerException

Overrides:

addCrlPath in class HttpServerOptions

Throws:

NullPointerException

addCrlValue

public HttpTermOptions addCrlValue(Buffer crlValue)
                            throws NullPointerException

Overrides:

addCrlValue in class HttpServerOptions

Throws:

NullPointerException

setAcceptBacklog

public HttpTermOptions setAcceptBacklog(int acceptBacklog)

Overrides:

setAcceptBacklog in class HttpServerOptions

setPort

public HttpTermOptions setPort(int port)

Overrides:

setPort in class HttpServerOptions

setHost

public HttpTermOptions setHost(String host)

Overrides:

setHost in class HttpServerOptions

setClientAuth

public HttpTermOptions setClientAuth(ClientAuth clientAuth)

Overrides:

setClientAuth in class HttpServerOptions

setCompressionSupported

public HttpTermOptions setCompressionSupported(boolean compressionSupported)

Overrides:

setCompressionSupported in class HttpServerOptions

setHandle100ContinueAutomatically

public HttpTermOptions setHandle100ContinueAutomatically(boolean handle100ContinueAutomatically)

Overrides:

setHandle100ContinueAutomatically in class HttpServerOptions

getVertsShellJsResource

public Buffer getVertsShellJsResource()

Returns:

the vertxshell.js resource for this server

setVertsShellJsResource

public HttpTermOptions setVertsShellJsResource(Buffer vertsShellJsResource)

Set vertxshell.js resource to use.

Parameters:

vertsShellJsResource - the resource

Returns:

a reference to this, so the API can be used fluently

getTermJsResource

public Buffer getTermJsResource()

Returns:

the term.js resource for this server

setTermJsResource

public HttpTermOptions setTermJsResource(Buffer termJsResource)

Set term.js resource to use.

Parameters:

termJsResource - the resource

Returns:

a reference to this, so the API can be used fluently

getShellHtmlResource

public Buffer getShellHtmlResource()

Returns:

the shell.html resource for this server

setShellHtmlResource

public HttpTermOptions setShellHtmlResource(Buffer shellHtmlResource)

Set shell.html resource to use.

Parameters:

shellHtmlResource - the resource

Returns:

a reference to this, so the API can be used fluently

getCharset

public String getCharset()

Returns:

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

setCharset

public HttpTermOptions setCharset(String charset)

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

Parameters:

charset - the charset to use

Returns:

a reference to this, so the API can be used fluently

getIntputrc

public String getIntputrc()

Returns:

the current path of the inputrc config

setIntputrc

public HttpTermOptions setIntputrc(String intputrc)

The path of the inputrc config.

Parameters:

intputrc - the path of the inputrc config

Returns:

a reference to this, so the API can be used fluently