io.vertx.ext.shell.term

Class TelnetTermOptions

java.lang.Object

io.vertx.core.net.NetworkOptions

io.vertx.core.net.TCPSSLOptions

io.vertx.core.net.NetServerOptions

io.vertx.ext.shell.term.TelnetTermOptions

public class TelnetTermOptions
extends NetServerOptions

Telnet terminal options configuration, extends NetServerOptions.

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CHARSET
static boolean	DEFAULT_IN_BINARY
static String	DEFAULT_INPUTRC
static boolean	DEFAULT_OUT_BINARY

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

DEFAULT_ACCEPT_BACKLOG, DEFAULT_CLIENT_AUTH, DEFAULT_HOST, DEFAULT_PORT, DEFAULT_SNI

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

DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS, DEFAULT_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_USE_ALPN, DEFAULT_USE_POOLED_BUFFERS

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

DEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS

Constructor Summary

Constructors

Constructor and Description
TelnetTermOptions()
TelnetTermOptions(JsonObject json)
TelnetTermOptions(TelnetTermOptions other)

Method Summary

Modifier and Type	Method and Description
TelnetTermOptions	addCrlPath(String crlPath)
TelnetTermOptions	addCrlValue(Buffer crlValue)
TelnetTermOptions	addEnabledCipherSuite(String suite)
String	getCharset()
boolean	getInBinary()
String	getIntputrc()
boolean	getOutBinary()
TelnetTermOptions	setAcceptBacklog(int acceptBacklog)
TelnetTermOptions	setCharset(String charset) Set the charset to use when binary mode is active, see setInBinary(boolean) and setOutBinary(boolean).
TelnetTermOptions	setClientAuthRequired(boolean clientAuthRequired)
TelnetTermOptions	setHost(String host)
TelnetTermOptions	setIdleTimeout(int idleTimeout)
TelnetTermOptions	setInBinary(boolean inBinary) Set the telnet connection to negociate binary data format when receiving from the client, the default value is true.
TelnetTermOptions	setIntputrc(String intputrc) The path of the inputrc config.
TelnetTermOptions	setKeyStoreOptions(JksOptions options)
TelnetTermOptions	setOutBinary(boolean outBinary) Set the telnet connection to negociate binary data format when sending to the client, the default value is true.
TelnetTermOptions	setPemKeyCertOptions(PemKeyCertOptions options)
TelnetTermOptions	setPemTrustOptions(PemTrustOptions options)
TelnetTermOptions	setPfxKeyCertOptions(PfxOptions options)
TelnetTermOptions	setPfxTrustOptions(PfxOptions options)
TelnetTermOptions	setPort(int port)
TelnetTermOptions	setReceiveBufferSize(int receiveBufferSize)
TelnetTermOptions	setReuseAddress(boolean reuseAddress)
TelnetTermOptions	setSendBufferSize(int sendBufferSize)
TelnetTermOptions	setSoLinger(int soLinger)
TelnetTermOptions	setSsl(boolean ssl)
TelnetTermOptions	setTcpKeepAlive(boolean tcpKeepAlive)
TelnetTermOptions	setTcpNoDelay(boolean tcpNoDelay)
TelnetTermOptions	setTrafficClass(int trafficClass)
TelnetTermOptions	setTrustStoreOptions(JksOptions options)
TelnetTermOptions	setUsePooledBuffers(boolean usePooledBuffers)

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

addEnabledSecureTransportProtocol, equals, getAcceptBacklog, getClientAuth, getHost, getPort, hashCode, isClientAuthRequired, isSni, removeEnabledSecureTransportProtocol, setClientAuth, setJdkSslEngineOptions, setKeyCertOptions, setLogActivity, setOpenSslEngineOptions, setReusePort, setSni, setSslEngineOptions, setTcpCork, setTcpFastOpen, setTcpQuickAck, setTrustOptions, setUseAlpn, toJson

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

getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getSoLinger, getSslEngineOptions, getTrustOptions, getTrustStoreOptions, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn, isUsePooledBuffers, setEnabledSecureTransportProtocols

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

getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_IN_BINARY

public static final boolean DEFAULT_IN_BINARY

See Also:

Constant Field Values

DEFAULT_OUT_BINARY

public static final boolean DEFAULT_OUT_BINARY

See Also:

Constant Field Values

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

DEFAULT_INPUTRC

public static final String DEFAULT_INPUTRC

See Also:

Constant Field Values

Constructor Detail

TelnetTermOptions

public TelnetTermOptions()

TelnetTermOptions

public TelnetTermOptions(TelnetTermOptions other)

TelnetTermOptions

public TelnetTermOptions(JsonObject json)

Method Detail

setSendBufferSize

public TelnetTermOptions setSendBufferSize(int sendBufferSize)

Overrides:

setSendBufferSize in class NetServerOptions

setReceiveBufferSize

public TelnetTermOptions setReceiveBufferSize(int receiveBufferSize)

Overrides:

setReceiveBufferSize in class NetServerOptions

setReuseAddress

public TelnetTermOptions setReuseAddress(boolean reuseAddress)

Overrides:

setReuseAddress in class NetServerOptions

setTrafficClass

public TelnetTermOptions setTrafficClass(int trafficClass)

Overrides:

setTrafficClass in class NetServerOptions

setTcpNoDelay

public TelnetTermOptions setTcpNoDelay(boolean tcpNoDelay)

Overrides:

setTcpNoDelay in class NetServerOptions

setTcpKeepAlive

public TelnetTermOptions setTcpKeepAlive(boolean tcpKeepAlive)

Overrides:

setTcpKeepAlive in class NetServerOptions

setSoLinger

public TelnetTermOptions setSoLinger(int soLinger)

Overrides:

setSoLinger in class NetServerOptions

setUsePooledBuffers

public TelnetTermOptions setUsePooledBuffers(boolean usePooledBuffers)

Overrides:

setUsePooledBuffers in class NetServerOptions

setIdleTimeout

public TelnetTermOptions setIdleTimeout(int idleTimeout)

Overrides:

setIdleTimeout in class NetServerOptions

setSsl

public TelnetTermOptions setSsl(boolean ssl)

Overrides:

setSsl in class NetServerOptions

setKeyStoreOptions

public TelnetTermOptions setKeyStoreOptions(JksOptions options)

Overrides:

setKeyStoreOptions in class NetServerOptions

setPfxKeyCertOptions

public TelnetTermOptions setPfxKeyCertOptions(PfxOptions options)

Overrides:

setPfxKeyCertOptions in class NetServerOptions

setPemKeyCertOptions

public TelnetTermOptions setPemKeyCertOptions(PemKeyCertOptions options)

Overrides:

setPemKeyCertOptions in class NetServerOptions

setTrustStoreOptions

public TelnetTermOptions setTrustStoreOptions(JksOptions options)

Overrides:

setTrustStoreOptions in class NetServerOptions

setPfxTrustOptions

public TelnetTermOptions setPfxTrustOptions(PfxOptions options)

Overrides:

setPfxTrustOptions in class NetServerOptions

setPemTrustOptions

public TelnetTermOptions setPemTrustOptions(PemTrustOptions options)

Overrides:

setPemTrustOptions in class NetServerOptions

addEnabledCipherSuite

public TelnetTermOptions addEnabledCipherSuite(String suite)

Overrides:

addEnabledCipherSuite in class NetServerOptions

addCrlPath

public TelnetTermOptions addCrlPath(String crlPath)
                             throws NullPointerException

Overrides:

addCrlPath in class NetServerOptions

Throws:

NullPointerException

addCrlValue

public TelnetTermOptions addCrlValue(Buffer crlValue)
                              throws NullPointerException

Overrides:

addCrlValue in class NetServerOptions

Throws:

NullPointerException

setAcceptBacklog

public TelnetTermOptions setAcceptBacklog(int acceptBacklog)

Overrides:

setAcceptBacklog in class NetServerOptions

setHost

public TelnetTermOptions setHost(String host)

Overrides:

setHost in class NetServerOptions

setPort

public TelnetTermOptions setPort(int port)

Overrides:

setPort in class NetServerOptions

setClientAuthRequired

public TelnetTermOptions setClientAuthRequired(boolean clientAuthRequired)

Overrides:

setClientAuthRequired in class NetServerOptions

getOutBinary

public boolean getOutBinary()

setOutBinary

public TelnetTermOptions setOutBinary(boolean outBinary)

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.

Parameters:

outBinary - the out binary value

Returns:

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

getInBinary

public boolean getInBinary()

setInBinary

public TelnetTermOptions setInBinary(boolean inBinary)

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.

Parameters:

inBinary - the in binary value

Returns:

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

getCharset

public String getCharset()

setCharset

public TelnetTermOptions setCharset(String charset)

Set the charset to use when binary mode is active, see setInBinary(boolean) and setOutBinary(boolean).

Parameters:

charset - the charset

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 TelnetTermOptions 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