TCPSSLOptions (Vert.x Stack - Docs 4.5.11 API)

java.lang.Object
- io.vertx.core.net.NetworkOptions
- - io.vertx.core.net.TCPSSLOptions

Direct Known Subclasses:

ClientOptionsBase, EventBusOptions, NetServerOptions, ServerOptionsBase
```
public abstract class TCPSSLOptions
extends NetworkOptions
```
Base class. TCP and SSL related options

Author:

Tim Fox

Field Summary

Fields
Modifier and Type	Field and Description
`static List<String>`	`DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS` See `SSLOptions.DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS`
`static int`	`DEFAULT_IDLE_TIMEOUT` Default idle timeout = 0
`static TimeUnit`	`DEFAULT_IDLE_TIMEOUT_TIME_UNIT` Default idle time unit = SECONDS
`static int`	`DEFAULT_READ_IDLE_TIMEOUT` Default read idle timeout = 0
`static int`	`DEFAULT_SO_LINGER` The default value of SO_linger = -1
`static boolean`	`DEFAULT_SSL` SSL enable by default = false
`static SSLEngineOptions`	`DEFAULT_SSL_ENGINE` The default SSL engine options = null (autoguess)
`static long`	`DEFAULT_SSL_HANDSHAKE_TIMEOUT` See `SSLOptions.DEFAULT_SSL_HANDSHAKE_TIMEOUT`
`static TimeUnit`	`DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT` See `SSLOptions.DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT`
`static boolean`	`DEFAULT_TCP_CORK` The default TCP_CORK value = false
`static boolean`	`DEFAULT_TCP_FAST_OPEN` The default TCP_FASTOPEN value = false
`static int`	`DEFAULT_TCP_KEEAPLIVE_INTERVAL_SECONDS` Default value for tcp keepalive interval -1 defaults to OS settings
`static boolean`	`DEFAULT_TCP_KEEP_ALIVE` The default value of TCP keep alive = false
`static int`	`DEFAULT_TCP_KEEPALIVE_COUNT` Default value for tcp keepalive count -1 defaults to OS settings
`static int`	`DEFAULT_TCP_KEEPALIVE_IDLE_SECONDS` Default value for tcp keepalive idle time -1 defaults to OS settings
`static boolean`	`DEFAULT_TCP_NO_DELAY` The default value of TCP-no-delay = true (Nagle disabled)
`static boolean`	`DEFAULT_TCP_QUICKACK` The default TCP_QUICKACK value = false
`static int`	`DEFAULT_TCP_USER_TIMEOUT` The default TCP_USER_TIMEOUT value in milliseconds = 0 When the default value of 0 is used, TCP will use the system default.
`static boolean`	`DEFAULT_USE_ALPN` See `SSLOptions.DEFAULT_USE_ALPN`
`static int`	`DEFAULT_WRITE_IDLE_TIMEOUT` Default write idle timeout = 0

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 and Description
`TCPSSLOptions()` Default constructor
`TCPSSLOptions(JsonObject json)` Create options from JSON
`TCPSSLOptions(TCPSSLOptions other)` Copy constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`TCPSSLOptions`	`addCrlPath(String crlPath)` Add a CRL path
`TCPSSLOptions`	`addCrlValue(Buffer crlValue)` Add a CRL value
`TCPSSLOptions`	`addEnabledCipherSuite(String suite)` Add an enabled cipher suite, appended to the ordered suites.
`TCPSSLOptions`	`addEnabledSecureTransportProtocol(String protocol)` Add an enabled SSL/TLS protocols, appended to the ordered protocols.
`List<String>`	`getCrlPaths()`
`List<Buffer>`	`getCrlValues()` Get the CRL values
`Set<String>`	`getEnabledCipherSuites()` Return an ordered set of the cipher suites.
`Set<String>`	`getEnabledSecureTransportProtocols()` Returns the enabled SSL/TLS protocols
`int`	`getIdleTimeout()`
`TimeUnit`	`getIdleTimeoutUnit()`
`JdkSSLEngineOptions`	`getJdkSslEngineOptions()` Deprecated. instead use `getSslEngineOptions()`
`KeyCertOptions`	`getKeyCertOptions()`
`JksOptions`	`getKeyStoreOptions()` Deprecated. instead use `getKeyCertOptions()`
`OpenSSLEngineOptions`	`getOpenSslEngineOptions()` Deprecated. instead use `getSslEngineOptions()`
`PemKeyCertOptions`	`getPemKeyCertOptions()` Deprecated. instead use `getKeyCertOptions()`
`PemTrustOptions`	`getPemTrustOptions()` Deprecated. instead use `getTrustOptions()`
`PfxOptions`	`getPfxKeyCertOptions()` Deprecated. instead use `getKeyCertOptions()`
`PfxOptions`	`getPfxTrustOptions()` Deprecated. instead use `getTrustOptions()`
`int`	`getReadIdleTimeout()`
`int`	`getSoLinger()`
`SSLEngineOptions`	`getSslEngineOptions()`
`long`	`getSslHandshakeTimeout()`
`TimeUnit`	`getSslHandshakeTimeoutUnit()`
`SSLOptions`	`getSslOptions()`
`int`	`getTcpKeepAliveCount()`
`int`	`getTcpKeepAliveIdleSeconds()`
`int`	`getTcpKeepAliveIntervalSeconds()`
`int`	`getTcpUserTimeout()`
`TrustOptions`	`getTrustOptions()`
`JksOptions`	`getTrustStoreOptions()` Deprecated. instead use `getTrustOptions()`
`int`	`getWriteIdleTimeout()`
`boolean`	`isSsl()`
`boolean`	`isTcpCork()`
`boolean`	`isTcpFastOpen()`
`boolean`	`isTcpKeepAlive()`
`boolean`	`isTcpNoDelay()`
`boolean`	`isTcpQuickAck()`
`boolean`	`isUseAlpn()`
`TCPSSLOptions`	`removeEnabledCipherSuite(String suite)` Removes an enabled cipher suite from the ordered suites.
`TCPSSLOptions`	`removeEnabledSecureTransportProtocol(String protocol)` Removes an enabled SSL/TLS protocol from the ordered protocols.
`TCPSSLOptions`	`setActivityLogDataFormat(ByteBufFormat activityLogDataFormat)` Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.
`TCPSSLOptions`	`setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)` Sets the list of enabled SSL/TLS protocols.
`TCPSSLOptions`	`setIdleTimeout(int idleTimeout)` Set the idle timeout, default time unit is seconds.
`TCPSSLOptions`	`setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)` Set the idle timeout unit.
`TCPSSLOptions`	`setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)` Deprecated. instead use `setSslEngineOptions(SSLEngineOptions)`
`TCPSSLOptions`	`setKeyCertOptions(KeyCertOptions options)` Set the key/cert options.
`TCPSSLOptions`	`setKeyStoreOptions(JksOptions options)` Deprecated. instead use `setKeyCertOptions(KeyCertOptions)`
`TCPSSLOptions`	`setLogActivity(boolean logEnabled)` Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
`TCPSSLOptions`	`setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)` Deprecated. instead use `setSslEngineOptions(SSLEngineOptions)`
`TCPSSLOptions`	`setPemKeyCertOptions(PemKeyCertOptions options)` Deprecated. instead use `setKeyCertOptions(KeyCertOptions)`
`TCPSSLOptions`	`setPemTrustOptions(PemTrustOptions options)` Deprecated. instead use `setTrustOptions(TrustOptions)`
`TCPSSLOptions`	`setPfxKeyCertOptions(PfxOptions options)` Deprecated. instead use `setKeyCertOptions(KeyCertOptions)`
`TCPSSLOptions`	`setPfxTrustOptions(PfxOptions options)` Deprecated. instead use `setTrustOptions(TrustOptions)`
`TCPSSLOptions`	`setReadIdleTimeout(int idleTimeout)` Set the read idle timeout, default time unit is seconds.
`TCPSSLOptions`	`setReceiveBufferSize(int receiveBufferSize)` Set the TCP receive buffer size
`TCPSSLOptions`	`setReuseAddress(boolean reuseAddress)` Set the value of reuse address
`TCPSSLOptions`	`setReusePort(boolean reusePort)` Set the value of reuse port.
`TCPSSLOptions`	`setSendBufferSize(int sendBufferSize)` Set the TCP send buffer size
`TCPSSLOptions`	`setSoLinger(int soLinger)` Set whether SO_linger keep alive is enabled
`TCPSSLOptions`	`setSsl(boolean ssl)` Set whether SSL/TLS is enabled
`TCPSSLOptions`	`setSslEngineOptions(SSLEngineOptions sslEngineOptions)` Set to use SSL engine implementation to use.
`TCPSSLOptions`	`setSslHandshakeTimeout(long sslHandshakeTimeout)` Set the SSL handshake timeout, default time unit is seconds.
`TCPSSLOptions`	`setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)` Set the SSL handshake timeout unit.
`TCPSSLOptions`	`setTcpCork(boolean tcpCork)` Enable the `TCP_CORK` option - only with linux native transport.
`TCPSSLOptions`	`setTcpFastOpen(boolean tcpFastOpen)` Enable the `TCP_FASTOPEN` option - only with linux native transport.
`TCPSSLOptions`	`setTcpKeepAlive(boolean tcpKeepAlive)` Set whether TCP keep alive is enabled
`TCPSSLOptions`	`setTcpKeepAliveCount(int tcpKeepAliveCount)` The maximum number of keepalive probes TCP should send before dropping the connection.
`TCPSSLOptions`	`setTcpKeepAliveIdleSeconds(int tcpKeepAliveIdleSeconds)` The time in seconds the connection needs to remain idle before TCP starts sending keepalive probes, if the socket option keepalive has been set.
`TCPSSLOptions`	`setTcpKeepAliveIntervalSeconds(int tcpKeepAliveIntervalSeconds)` The time in seconds between individual keepalive probes.
`TCPSSLOptions`	`setTcpNoDelay(boolean tcpNoDelay)` Set whether TCP no delay is enabled
`TCPSSLOptions`	`setTcpQuickAck(boolean tcpQuickAck)` Enable the `TCP_QUICKACK` option - only with linux native transport.
`TCPSSLOptions`	`setTcpUserTimeout(int tcpUserTimeout)` Sets the `TCP_USER_TIMEOUT` option - only with linux native transport.
`TCPSSLOptions`	`setTrafficClass(int trafficClass)` Set the value of traffic class
`TCPSSLOptions`	`setTrustOptions(TrustOptions options)` Set the trust options.
`TCPSSLOptions`	`setTrustStoreOptions(JksOptions options)` Deprecated. instead use `setTrustOptions(TrustOptions)`
`TCPSSLOptions`	`setUseAlpn(boolean useAlpn)` Set the ALPN usage.
`TCPSSLOptions`	`setWriteIdleTimeout(int idleTimeout)` Set the write idle timeout, default time unit is seconds.
`JsonObject`	`toJson()` Convert to JSON

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_TCP_NO_DELAY
```
public static final boolean DEFAULT_TCP_NO_DELAY
```
    The default value of TCP-no-delay = true (Nagle disabled)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TCP_KEEP_ALIVE
```
public static final boolean DEFAULT_TCP_KEEP_ALIVE
```
    The default value of TCP keep alive = false
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TCP_KEEPALIVE_IDLE_SECONDS
```
public static final int DEFAULT_TCP_KEEPALIVE_IDLE_SECONDS
```
    Default value for tcp keepalive idle time -1 defaults to OS settings
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TCP_KEEPALIVE_COUNT
```
public static final int DEFAULT_TCP_KEEPALIVE_COUNT
```
    Default value for tcp keepalive count -1 defaults to OS settings
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TCP_KEEAPLIVE_INTERVAL_SECONDS
```
public static final int DEFAULT_TCP_KEEAPLIVE_INTERVAL_SECONDS
```
    Default value for tcp keepalive interval -1 defaults to OS settings
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SO_LINGER
```
public static final int DEFAULT_SO_LINGER
```
    The default value of SO_linger = -1
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL
```
public static final boolean DEFAULT_SSL
```
    SSL enable by default = false
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IDLE_TIMEOUT
```
public static final int DEFAULT_IDLE_TIMEOUT
```
    Default idle timeout = 0
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IDLE_TIMEOUT_TIME_UNIT
```
public static final TimeUnit DEFAULT_IDLE_TIMEOUT_TIME_UNIT
```
    Default idle time unit = SECONDS
  - DEFAULT_READ_IDLE_TIMEOUT
```
public static final int DEFAULT_READ_IDLE_TIMEOUT
```
    Default read idle timeout = 0
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WRITE_IDLE_TIMEOUT
```
public static final int DEFAULT_WRITE_IDLE_TIMEOUT
```
    Default write idle timeout = 0
    
    See Also:
    
    Constant Field Values
  - DEFAULT_USE_ALPN
```
public static final boolean DEFAULT_USE_ALPN
```
    See SSLOptions.DEFAULT_USE_ALPN
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_ENGINE
```
public static final SSLEngineOptions DEFAULT_SSL_ENGINE
```
    The default SSL engine options = null (autoguess)
  - DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS
```
public static final List<String> DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS
```
    See SSLOptions.DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS
  - DEFAULT_TCP_FAST_OPEN
```
public static final boolean DEFAULT_TCP_FAST_OPEN
```
    The default TCP_FASTOPEN value = false
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TCP_CORK
```
public static final boolean DEFAULT_TCP_CORK
```
    The default TCP_CORK value = false
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TCP_QUICKACK
```
public static final boolean DEFAULT_TCP_QUICKACK
```
    The default TCP_QUICKACK value = false
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TCP_USER_TIMEOUT
```
public static final int DEFAULT_TCP_USER_TIMEOUT
```
    The default TCP_USER_TIMEOUT value in milliseconds = 0
    When the default value of 0 is used, TCP will use the system default.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_HANDSHAKE_TIMEOUT
```
public static final long DEFAULT_SSL_HANDSHAKE_TIMEOUT
```
    See SSLOptions.DEFAULT_SSL_HANDSHAKE_TIMEOUT
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT
```
public static final TimeUnit DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT
```
    See SSLOptions.DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT
- Constructor Detail
  - TCPSSLOptions
```
public TCPSSLOptions()
```
    Default constructor
  - TCPSSLOptions
```
public TCPSSLOptions(TCPSSLOptions other)
```
    Copy constructor
    
    Parameters:
    
    other - the options to copy
  - TCPSSLOptions
```
public TCPSSLOptions(JsonObject json)
```
    Create options from JSON
    
    Parameters:
    
    json - the JSON
- Method Detail
  - toJson
```
public JsonObject toJson()
```
    Convert to JSON
    
    Overrides:
    
    toJson in class NetworkOptions
    
    Returns:
    
    the JSON
  - getSslOptions
```
public SSLOptions getSslOptions()
```
  - isTcpNoDelay
```
public boolean isTcpNoDelay()
```
    Returns:
    
    TCP no delay enabled ?
  - setTcpNoDelay
```
public TCPSSLOptions setTcpNoDelay(boolean tcpNoDelay)
```
    Set whether TCP no delay is enabled
    
    Parameters:
    
    tcpNoDelay - true if TCP no delay is enabled (Nagle disabled)
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - isTcpKeepAlive
```
public boolean isTcpKeepAlive()
```
    Returns:
    
    is TCP keep alive enabled?
  - setTcpKeepAlive
```
public TCPSSLOptions setTcpKeepAlive(boolean tcpKeepAlive)
```
    Set whether TCP keep alive is enabled
    
    Parameters:
    
    tcpKeepAlive - true if TCP keep alive is enabled
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getTcpKeepAliveIdleSeconds
```
public int getTcpKeepAliveIdleSeconds()
```
    Returns:
    
    the time in seconds the connection needs to remain idle before TCP starts sending keepalive probes
  - setTcpKeepAliveIdleSeconds
```
public TCPSSLOptions setTcpKeepAliveIdleSeconds(int tcpKeepAliveIdleSeconds)
```
    The time in seconds the connection needs to remain idle before TCP starts sending keepalive probes, if the socket option keepalive has been set.
    
    Parameters:
    
    tcpKeepAliveIdleSeconds -
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getTcpKeepAliveCount
```
public int getTcpKeepAliveCount()
```
    Returns:
    
    the maximum number of keepalive probes TCP should send before dropping the connection.
  - setTcpKeepAliveCount
```
public TCPSSLOptions setTcpKeepAliveCount(int tcpKeepAliveCount)
```
    The maximum number of keepalive probes TCP should send before dropping the connection.
    
    Parameters:
    
    tcpKeepAliveCount -
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getTcpKeepAliveIntervalSeconds
```
public int getTcpKeepAliveIntervalSeconds()
```
    Returns:
    
    the time in seconds between individual keepalive probes.
  - setTcpKeepAliveIntervalSeconds
```
public TCPSSLOptions setTcpKeepAliveIntervalSeconds(int tcpKeepAliveIntervalSeconds)
```
    The time in seconds between individual keepalive probes.
    
    Parameters:
    
    tcpKeepAliveIntervalSeconds -
    
    Returns:
  - getSoLinger
```
public int getSoLinger()
```
    Returns:
    
    is SO_linger enabled
  - setSoLinger
```
public TCPSSLOptions setSoLinger(int soLinger)
```
    Set whether SO_linger keep alive is enabled
    
    Parameters:
    
    soLinger - true if SO_linger is enabled
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setIdleTimeout
```
public TCPSSLOptions setIdleTimeout(int 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 setIdleTimeoutUnit(TimeUnit)
    
    Parameters:
    
    idleTimeout - the timeout
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getIdleTimeout
```
public int getIdleTimeout()
```
    Returns:
    
    the idle timeout, in time unit specified by getIdleTimeoutUnit().
  - setReadIdleTimeout
```
public TCPSSLOptions setReadIdleTimeout(int idleTimeout)
```
    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 setIdleTimeoutUnit(TimeUnit)
    
    Parameters:
    
    idleTimeout - the read timeout
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getReadIdleTimeout
```
public int getReadIdleTimeout()
```
    Returns:
    
    the read idle timeout, in time unit specified by getIdleTimeoutUnit().
  - setWriteIdleTimeout
```
public TCPSSLOptions setWriteIdleTimeout(int idleTimeout)
```
    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 setIdleTimeoutUnit(TimeUnit)
    
    Parameters:
    
    idleTimeout - the write timeout
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getWriteIdleTimeout
```
public int getWriteIdleTimeout()
```
    Returns:
    
    the write idle timeout, in time unit specified by getIdleTimeoutUnit().
  - setIdleTimeoutUnit
```
public TCPSSLOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
```
    Set the idle timeout unit. If not specified, default is seconds.
    
    Parameters:
    
    idleTimeoutUnit - specify time unit.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getIdleTimeoutUnit
```
public TimeUnit getIdleTimeoutUnit()
```
    Returns:
    
    the idle timeout unit.
  - isSsl
```
public boolean isSsl()
```
    Returns:
    
    is SSL/TLS enabled?
  - setSsl
```
public TCPSSLOptions setSsl(boolean ssl)
```
    Set whether SSL/TLS is enabled
    
    Parameters:
    
    ssl - true if enabled
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getKeyCertOptions
```
public KeyCertOptions getKeyCertOptions()
```
    Returns:
    
    the key/cert options
  - setKeyCertOptions
```
public TCPSSLOptions setKeyCertOptions(KeyCertOptions options)
```
    Set the key/cert options.
    
    Parameters:
    
    options - the key store options
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getKeyStoreOptions
```
@Deprecated
public JksOptions getKeyStoreOptions()
```
    Deprecated. instead use getKeyCertOptions()
    
    Get the key/cert options in jks format, aka Java keystore.
    
    Returns:
    
    the key/cert options in jks format, aka Java keystore.
  - setKeyStoreOptions
```
@Deprecated
public TCPSSLOptions setKeyStoreOptions(JksOptions options)
```
    Deprecated. instead use setKeyCertOptions(KeyCertOptions)
    
    Set the key/cert options in jks format, aka Java keystore.
    
    Parameters:
    
    options - the key store in jks format
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getPfxKeyCertOptions
```
@Deprecated
public PfxOptions getPfxKeyCertOptions()
```
    Deprecated. instead use getKeyCertOptions()
    
    Get the key/cert options in pfx format.
    
    Returns:
    
    the key/cert options in pfx format.
  - setPfxKeyCertOptions
```
@Deprecated
public TCPSSLOptions setPfxKeyCertOptions(PfxOptions options)
```
    Deprecated. instead use setKeyCertOptions(KeyCertOptions)
    
    Set the key/cert options in pfx format.
    
    Parameters:
    
    options - the key cert options in pfx format
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getPemKeyCertOptions
```
@Deprecated
public PemKeyCertOptions getPemKeyCertOptions()
```
    Deprecated. instead use getKeyCertOptions()
    
    Get the key/cert store options in pem format.
    
    Returns:
    
    the key/cert store options in pem format.
  - setPemKeyCertOptions
```
@Deprecated
public TCPSSLOptions setPemKeyCertOptions(PemKeyCertOptions options)
```
    Deprecated. instead use setKeyCertOptions(KeyCertOptions)
    
    Set the key/cert store options in pem format.
    
    Parameters:
    
    options - the options in pem format
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getTrustOptions
```
public TrustOptions getTrustOptions()
```
    Returns:
    
    the trust options
  - setTrustOptions
```
public TCPSSLOptions setTrustOptions(TrustOptions options)
```
    Set the trust options.
    
    Parameters:
    
    options - the trust options
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getTrustStoreOptions
```
@Deprecated
public JksOptions getTrustStoreOptions()
```
    Deprecated. instead use getTrustOptions()
    
    Get the trust options in jks format, aka Java truststore
    
    Returns:
    
    the trust options in jks format, aka Java truststore
  - setTrustStoreOptions
```
@Deprecated
public TCPSSLOptions setTrustStoreOptions(JksOptions options)
```
    Deprecated. instead use setTrustOptions(TrustOptions)
    
    Set the trust options in jks format, aka Java truststore
    
    Parameters:
    
    options - the trust options in jks format
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getPfxTrustOptions
```
@Deprecated
public PfxOptions getPfxTrustOptions()
```
    Deprecated. instead use getTrustOptions()
    
    Get the trust options in pfx format
    
    Returns:
    
    the trust options in pfx format
  - setPfxTrustOptions
```
@Deprecated
public TCPSSLOptions setPfxTrustOptions(PfxOptions options)
```
    Deprecated. instead use setTrustOptions(TrustOptions)
    
    Set the trust options in pfx format
    
    Parameters:
    
    options - the trust options in pfx format
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getPemTrustOptions
```
@Deprecated
public PemTrustOptions getPemTrustOptions()
```
    Deprecated. instead use getTrustOptions()
    
    Get the trust options in pem format
    
    Returns:
    
    the trust options in pem format
  - setPemTrustOptions
```
@Deprecated
public TCPSSLOptions setPemTrustOptions(PemTrustOptions options)
```
    Deprecated. instead use setTrustOptions(TrustOptions)
    
    Set the trust options in pem format
    
    Parameters:
    
    options - the trust options in pem format
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - addEnabledCipherSuite
```
public TCPSSLOptions addEnabledCipherSuite(String suite)
```
    Add an enabled cipher suite, appended to the ordered suites.
    
    Parameters:
    
    suite - the suite
    
    Returns:
    
    a reference to this, so the API can be used fluently
    
    See Also:
    
    getEnabledCipherSuites()
  - removeEnabledCipherSuite
```
public TCPSSLOptions removeEnabledCipherSuite(String suite)
```
    Removes an enabled cipher suite from the ordered suites.
    
    Parameters:
    
    suite - the suite
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getEnabledCipherSuites
```
public Set<String> getEnabledCipherSuites()
```
    Return an ordered set of the cipher suites.
    The set is initially empty and suite should be added to this set in the desired order.
    When suites are added and therefore the list is not empty, it takes precedence over the default suite defined by the SSLEngineOptions in use.
    
    Returns:
    
    the enabled cipher suites
  - getCrlPaths
```
public List<String> getCrlPaths()
```
    Returns:
    
    the CRL (Certificate revocation list) paths
  - addCrlPath
```
public TCPSSLOptions addCrlPath(String crlPath)
```
    Add a CRL path
    
    Parameters:
    
    crlPath - the path
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getCrlValues
```
public List<Buffer> getCrlValues()
```
    Get the CRL values
    
    Returns:
    
    the list of values
  - addCrlValue
```
public TCPSSLOptions addCrlValue(Buffer crlValue)
```
    Add a CRL value
    
    Parameters:
    
    crlValue - the value
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - isUseAlpn
```
public boolean isUseAlpn()
```
    Returns:
    
    whether to use or not Application-Layer Protocol Negotiation
  - setUseAlpn
```
public TCPSSLOptions setUseAlpn(boolean useAlpn)
```
    Set the ALPN usage.
    
    Parameters:
    
    useAlpn - true when Application-Layer Protocol Negotiation should be used
  - getSslEngineOptions
```
public SSLEngineOptions getSslEngineOptions()
```
    Returns:
    
    the SSL engine implementation to use
  - setSslEngineOptions
```
public TCPSSLOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)
```
    Set to use SSL engine implementation to use.
    
    Parameters:
    
    sslEngineOptions - the ssl engine to use
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getJdkSslEngineOptions
```
@Deprecated
public JdkSSLEngineOptions getJdkSslEngineOptions()
```
    Deprecated. instead use getSslEngineOptions()
  - setJdkSslEngineOptions
```
@Deprecated
public TCPSSLOptions setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)
```
    Deprecated. instead use setSslEngineOptions(SSLEngineOptions)
  - getOpenSslEngineOptions
```
@Deprecated
public OpenSSLEngineOptions getOpenSslEngineOptions()
```
    Deprecated. instead use getSslEngineOptions()
  - setOpenSslEngineOptions
```
@Deprecated
public TCPSSLOptions setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
```
    Deprecated. instead use setSslEngineOptions(SSLEngineOptions)
  - setEnabledSecureTransportProtocols
```
public TCPSSLOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
```
    Sets the list of enabled SSL/TLS protocols.
    
    Parameters:
    
    enabledSecureTransportProtocols - the SSL/TLS protocols to enable
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - addEnabledSecureTransportProtocol
```
public TCPSSLOptions addEnabledSecureTransportProtocol(String protocol)
```
    Add an enabled SSL/TLS protocols, appended to the ordered protocols.
    
    Parameters:
    
    protocol - the SSL/TLS protocol to enable
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - removeEnabledSecureTransportProtocol
```
public TCPSSLOptions removeEnabledSecureTransportProtocol(String protocol)
```
    Removes an enabled SSL/TLS protocol from the ordered protocols.
    
    Parameters:
    
    protocol - the SSL/TLS protocol to disable
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - isTcpFastOpen
```
public boolean isTcpFastOpen()
```
    Returns:
    
    wether TCP_FASTOPEN option is enabled
  - setTcpFastOpen
```
public TCPSSLOptions setTcpFastOpen(boolean tcpFastOpen)
```
    Enable the TCP_FASTOPEN option - only with linux native transport.
    
    Parameters:
    
    tcpFastOpen - the fast open value
  - isTcpCork
```
public boolean isTcpCork()
```
    Returns:
    
    wether TCP_CORK option is enabled
  - setTcpCork
```
public TCPSSLOptions setTcpCork(boolean tcpCork)
```
    Enable the TCP_CORK option - only with linux native transport.
    
    Parameters:
    
    tcpCork - the cork value
  - isTcpQuickAck
```
public boolean isTcpQuickAck()
```
    Returns:
    
    wether TCP_QUICKACK option is enabled
  - setTcpQuickAck
```
public TCPSSLOptions setTcpQuickAck(boolean tcpQuickAck)
```
    Enable the TCP_QUICKACK option - only with linux native transport.
    
    Parameters:
    
    tcpQuickAck - the quick ack value
  - getTcpUserTimeout
```
public int getTcpUserTimeout()
```
    Returns:
    
    the TCP_USER_TIMEOUT value
  - setTcpUserTimeout
```
public TCPSSLOptions setTcpUserTimeout(int tcpUserTimeout)
```
    Sets the TCP_USER_TIMEOUT option - only with linux native transport.
    
    Parameters:
    
    tcpUserTimeout - the tcp user timeout value
  - getEnabledSecureTransportProtocols
```
public Set<String> getEnabledSecureTransportProtocols()
```
    Returns the enabled SSL/TLS protocols
    
    Returns:
    
    the enabled protocols
  - getSslHandshakeTimeout
```
public long getSslHandshakeTimeout()
```
    Returns:
    
    the SSL handshake timeout, in time unit specified by getSslHandshakeTimeoutUnit().
  - setSslHandshakeTimeout
```
public TCPSSLOptions setSslHandshakeTimeout(long sslHandshakeTimeout)
```
    Set the SSL handshake timeout, default time unit is seconds.
    
    Parameters:
    
    sslHandshakeTimeout - the SSL handshake timeout to set, in milliseconds
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setSslHandshakeTimeoutUnit
```
public TCPSSLOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
```
    Set the SSL handshake timeout unit. If not specified, default is seconds.
    
    Parameters:
    
    sslHandshakeTimeoutUnit - specify time unit.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getSslHandshakeTimeoutUnit
```
public TimeUnit getSslHandshakeTimeoutUnit()
```
    Returns:
    
    the SSL handshake timeout unit.
  - setLogActivity
```
public TCPSSLOptions setLogActivity(boolean logEnabled)
```
    Description copied from class: NetworkOptions
    
    Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
    
    Overrides:
    
    setLogActivity in class NetworkOptions
    
    Parameters:
    
    logEnabled - true for logging the network activity
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setActivityLogDataFormat
```
public TCPSSLOptions setActivityLogDataFormat(ByteBufFormat activityLogDataFormat)
```
    Description copied from class: NetworkOptions
    
    Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.
    
    Overrides:
    
    setActivityLogDataFormat in class NetworkOptions
    
    Parameters:
    
    activityLogDataFormat - the format to use
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setSendBufferSize
```
public TCPSSLOptions setSendBufferSize(int sendBufferSize)
```
    Description copied from class: NetworkOptions
    
    Set the TCP send buffer size
    
    Overrides:
    
    setSendBufferSize in class NetworkOptions
    
    Parameters:
    
    sendBufferSize - the buffers size, in bytes
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setReceiveBufferSize
```
public TCPSSLOptions setReceiveBufferSize(int receiveBufferSize)
```
    Description copied from class: NetworkOptions
    
    Set the TCP receive buffer size
    
    Overrides:
    
    setReceiveBufferSize in class NetworkOptions
    
    Parameters:
    
    receiveBufferSize - the buffers size, in bytes
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setReuseAddress
```
public TCPSSLOptions setReuseAddress(boolean reuseAddress)
```
    Description copied from class: NetworkOptions
    
    Set the value of reuse address
    
    Overrides:
    
    setReuseAddress in class NetworkOptions
    
    Parameters:
    
    reuseAddress - the value of reuse address
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setTrafficClass
```
public TCPSSLOptions setTrafficClass(int trafficClass)
```
    Description copied from class: NetworkOptions
    
    Set the value of traffic class
    
    Overrides:
    
    setTrafficClass in class NetworkOptions
    
    Parameters:
    
    trafficClass - the value of traffic class
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setReusePort
```
public TCPSSLOptions setReusePort(boolean reusePort)
```
    Description copied from class: NetworkOptions
    
    Set the value of reuse port.
    This is only supported by native transports.
    
    Overrides:
    
    setReusePort in class NetworkOptions
    
    Parameters:
    
    reusePort - the value of reuse port
    
    Returns:
    
    a reference to this, so the API can be used fluently

Class TCPSSLOptions

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TCP_NO_DELAY

DEFAULT_TCP_KEEP_ALIVE

DEFAULT_TCP_KEEPALIVE_IDLE_SECONDS

DEFAULT_TCP_KEEPALIVE_COUNT

DEFAULT_TCP_KEEAPLIVE_INTERVAL_SECONDS

DEFAULT_SO_LINGER

DEFAULT_SSL

DEFAULT_IDLE_TIMEOUT

DEFAULT_IDLE_TIMEOUT_TIME_UNIT

DEFAULT_READ_IDLE_TIMEOUT

DEFAULT_WRITE_IDLE_TIMEOUT

DEFAULT_USE_ALPN

DEFAULT_SSL_ENGINE

DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS

DEFAULT_TCP_FAST_OPEN

DEFAULT_TCP_CORK

DEFAULT_TCP_QUICKACK

DEFAULT_TCP_USER_TIMEOUT

DEFAULT_SSL_HANDSHAKE_TIMEOUT

DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT

Constructor Detail

TCPSSLOptions

TCPSSLOptions

TCPSSLOptions

Method Detail

toJson

getSslOptions

isTcpNoDelay

setTcpNoDelay

isTcpKeepAlive

setTcpKeepAlive

getTcpKeepAliveIdleSeconds

setTcpKeepAliveIdleSeconds

getTcpKeepAliveCount

setTcpKeepAliveCount

getTcpKeepAliveIntervalSeconds

setTcpKeepAliveIntervalSeconds

getSoLinger

setSoLinger

setIdleTimeout

getIdleTimeout

setReadIdleTimeout

getReadIdleTimeout

setWriteIdleTimeout

getWriteIdleTimeout

setIdleTimeoutUnit

getIdleTimeoutUnit

isSsl

setSsl

getKeyCertOptions

setKeyCertOptions

getKeyStoreOptions

setKeyStoreOptions

getPfxKeyCertOptions

setPfxKeyCertOptions

getPemKeyCertOptions

setPemKeyCertOptions

getTrustOptions

setTrustOptions

getTrustStoreOptions

setTrustStoreOptions

getPfxTrustOptions

setPfxTrustOptions

getPemTrustOptions

setPemTrustOptions

addEnabledCipherSuite

removeEnabledCipherSuite

getEnabledCipherSuites

getCrlPaths

addCrlPath

getCrlValues

addCrlValue