io.vertx.mysqlclient

Class MySQLConnectOptions

java.lang.Object

io.vertx.core.net.NetworkOptions

io.vertx.core.net.TCPSSLOptions

io.vertx.core.net.ClientOptionsBase

io.vertx.core.net.NetClientOptions

io.vertx.sqlclient.SqlConnectOptions

io.vertx.mysqlclient.MySQLConnectOptions

public class MySQLConnectOptions
extends SqlConnectOptions

Connect options for configuring MySQLConnection or MySQLPool.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COLLATION
static Map<String,String>	DEFAULT_CONNECTION_ATTRIBUTES
static String	DEFAULT_HOST
static String	DEFAULT_PASSWORD
static int	DEFAULT_PORT
static String	DEFAULT_SCHEMA
static String	DEFAULT_USER

Fields inherited from class io.vertx.sqlclient.SqlConnectOptions

DEFAULT_CACHE_PREPARED_STATEMENTS, DEFAULT_PREPARED_STATEMENT_CACHE_MAX_SIZE, DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT

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

DEFAULT_HOSTNAME_VERIFICATION_ALGORITHM, DEFAULT_RECONNECT_ATTEMPTS, DEFAULT_RECONNECT_INTERVAL

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

DEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME, DEFAULT_TRUST_ALL

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

DEFAULT_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_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
MySQLConnectOptions()
MySQLConnectOptions(JsonObject json)
MySQLConnectOptions(MySQLConnectOptions other)

Method Summary

Modifier and Type	Method and Description
MySQLConnectOptions	addCrlPath(String crlPath)
MySQLConnectOptions	addCrlValue(Buffer crlValue)
MySQLConnectOptions	addEnabledCipherSuite(String suite)
MySQLConnectOptions	addEnabledSecureTransportProtocol(String protocol)
MySQLConnectOptions	addProperty(String key, String value)
static MySQLConnectOptions	fromUri(String connectionUri) Provide a MySQLConnectOptions configured from a connection URI.
String	getCollation() Get the collation for the connection.
protected void	init() Initialize with the default options.
MySQLConnectOptions	removeEnabledSecureTransportProtocol(String protocol)
MySQLConnectOptions	setCachePreparedStatements(boolean cachePreparedStatements)
MySQLConnectOptions	setCollation(String collation) Set the collation for the connection.
MySQLConnectOptions	setConnectTimeout(int connectTimeout)
MySQLConnectOptions	setDatabase(String database)
MySQLConnectOptions	setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
MySQLConnectOptions	setHost(String host)
MySQLConnectOptions	setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)
MySQLConnectOptions	setIdleTimeout(int idleTimeout)
MySQLConnectOptions	setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
MySQLConnectOptions	setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)
MySQLConnectOptions	setKeyCertOptions(KeyCertOptions options)
MySQLConnectOptions	setKeyStoreOptions(JksOptions options)
MySQLConnectOptions	setLocalAddress(String localAddress)
MySQLConnectOptions	setLogActivity(boolean logEnabled)
MySQLConnectOptions	setMetricsName(String metricsName)
ClientOptionsBase	setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
MySQLConnectOptions	setPassword(String password)
MySQLConnectOptions	setPemKeyCertOptions(PemKeyCertOptions options)
MySQLConnectOptions	setPemTrustOptions(PemTrustOptions options)
MySQLConnectOptions	setPfxKeyCertOptions(PfxOptions options)
MySQLConnectOptions	setPfxTrustOptions(PfxOptions options)
MySQLConnectOptions	setPort(int port)
MySQLConnectOptions	setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)
MySQLConnectOptions	setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)
MySQLConnectOptions	setProperties(Map<String,String> properties)
MySQLConnectOptions	setProxyOptions(ProxyOptions proxyOptions)
MySQLConnectOptions	setReceiveBufferSize(int receiveBufferSize)
MySQLConnectOptions	setReconnectAttempts(int attempts)
MySQLConnectOptions	setReconnectInterval(long interval)
MySQLConnectOptions	setReuseAddress(boolean reuseAddress)
MySQLConnectOptions	setReusePort(boolean reusePort)
MySQLConnectOptions	setSendBufferSize(int sendBufferSize)
MySQLConnectOptions	setSoLinger(int soLinger)
MySQLConnectOptions	setSslEngineOptions(SSLEngineOptions sslEngineOptions)
MySQLConnectOptions	setSslHandshakeTimeout(long sslHandshakeTimeout)
MySQLConnectOptions	setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
MySQLConnectOptions	setTcpCork(boolean tcpCork)
MySQLConnectOptions	setTcpFastOpen(boolean tcpFastOpen)
MySQLConnectOptions	setTcpKeepAlive(boolean tcpKeepAlive)
MySQLConnectOptions	setTcpNoDelay(boolean tcpNoDelay)
MySQLConnectOptions	setTcpQuickAck(boolean tcpQuickAck)
MySQLConnectOptions	setTrafficClass(int trafficClass)
MySQLConnectOptions	setTrustAll(boolean trustAll)
MySQLConnectOptions	setTrustOptions(TrustOptions options)
MySQLConnectOptions	setTrustStoreOptions(JksOptions options)
MySQLConnectOptions	setUseAlpn(boolean useAlpn)
MySQLConnectOptions	setUsePooledBuffers(boolean usePooledBuffers)
MySQLConnectOptions	setUser(String user)
JsonObject	toJson()

Methods inherited from class io.vertx.sqlclient.SqlConnectOptions

checkParameterNonNull, getCachePreparedStatements, getDatabase, getHost, getPassword, getPort, getPreparedStatementCacheMaxSize, getPreparedStatementCacheSqlLimit, getProperties, getUser

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

equals, getHostnameVerificationAlgorithm, getReconnectAttempts, getReconnectInterval, hashCode, setSsl

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

getConnectTimeout, getLocalAddress, getMetricsName, getProxyOptions, isTrustAll

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

getCrlPaths, 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, isUseAlpn, isUsePooledBuffers

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_HOST

public static final String DEFAULT_HOST

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_USER

public static final String DEFAULT_USER

See Also:

Constant Field Values

DEFAULT_PASSWORD

public static final String DEFAULT_PASSWORD

See Also:

Constant Field Values

DEFAULT_SCHEMA

public static final String DEFAULT_SCHEMA

See Also:

Constant Field Values

DEFAULT_COLLATION

public static final String DEFAULT_COLLATION

See Also:

Constant Field Values

DEFAULT_CONNECTION_ATTRIBUTES

public static final Map<String,String> DEFAULT_CONNECTION_ATTRIBUTES

Constructor Detail

MySQLConnectOptions

public MySQLConnectOptions()

MySQLConnectOptions

public MySQLConnectOptions(JsonObject json)

MySQLConnectOptions

public MySQLConnectOptions(MySQLConnectOptions other)

Method Detail

fromUri

public static MySQLConnectOptions fromUri(String connectionUri)
                                   throws IllegalArgumentException

Provide a MySQLConnectOptions configured from a connection URI.

Parameters:

connectionUri - the connection URI to configure from

Returns:

a MySQLConnectOptions parsed from the connection URI

Throws:

IllegalArgumentException - when the connectionUri is in an invalid format

getCollation

public String getCollation()

Get the collation for the connection.

Returns:

the MySQL collation

setCollation

public MySQLConnectOptions setCollation(String collation)

Set the collation for the connection.

Parameters:

collation - the collation to set

Returns:

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

setHost

public MySQLConnectOptions setHost(String host)

Overrides:

setHost in class SqlConnectOptions

setPort

public MySQLConnectOptions setPort(int port)

Overrides:

setPort in class SqlConnectOptions

setUser

public MySQLConnectOptions setUser(String user)

Overrides:

setUser in class SqlConnectOptions

setPassword

public MySQLConnectOptions setPassword(String password)

Overrides:

setPassword in class SqlConnectOptions

setDatabase

public MySQLConnectOptions setDatabase(String database)

Overrides:

setDatabase in class SqlConnectOptions

setCachePreparedStatements

public MySQLConnectOptions setCachePreparedStatements(boolean cachePreparedStatements)

Overrides:

setCachePreparedStatements in class SqlConnectOptions

setPreparedStatementCacheMaxSize

public MySQLConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)

Overrides:

setPreparedStatementCacheMaxSize in class SqlConnectOptions

setPreparedStatementCacheSqlLimit

public MySQLConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)

Overrides:

setPreparedStatementCacheSqlLimit in class SqlConnectOptions

setProperties

public MySQLConnectOptions setProperties(Map<String,String> properties)

Overrides:

setProperties in class SqlConnectOptions

addProperty

public MySQLConnectOptions addProperty(String key,
                                       String value)

Overrides:

addProperty in class SqlConnectOptions

setSendBufferSize

public MySQLConnectOptions setSendBufferSize(int sendBufferSize)

Overrides:

setSendBufferSize in class NetClientOptions

setReceiveBufferSize

public MySQLConnectOptions setReceiveBufferSize(int receiveBufferSize)

Overrides:

setReceiveBufferSize in class NetClientOptions

setReuseAddress

public MySQLConnectOptions setReuseAddress(boolean reuseAddress)

Overrides:

setReuseAddress in class NetClientOptions

setReusePort

public MySQLConnectOptions setReusePort(boolean reusePort)

Overrides:

setReusePort in class NetClientOptions

setTrafficClass

public MySQLConnectOptions setTrafficClass(int trafficClass)

Overrides:

setTrafficClass in class NetClientOptions

setTcpNoDelay

public MySQLConnectOptions setTcpNoDelay(boolean tcpNoDelay)

Overrides:

setTcpNoDelay in class NetClientOptions

setTcpKeepAlive

public MySQLConnectOptions setTcpKeepAlive(boolean tcpKeepAlive)

Overrides:

setTcpKeepAlive in class NetClientOptions

setSoLinger

public MySQLConnectOptions setSoLinger(int soLinger)

Overrides:

setSoLinger in class NetClientOptions

setUsePooledBuffers

public MySQLConnectOptions setUsePooledBuffers(boolean usePooledBuffers)

Overrides:

setUsePooledBuffers in class NetClientOptions

setIdleTimeout

public MySQLConnectOptions setIdleTimeout(int idleTimeout)

Overrides:

setIdleTimeout in class NetClientOptions

setIdleTimeoutUnit

public MySQLConnectOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)

Overrides:

setIdleTimeoutUnit in class NetClientOptions

setKeyCertOptions

public MySQLConnectOptions setKeyCertOptions(KeyCertOptions options)

Overrides:

setKeyCertOptions in class NetClientOptions

setKeyStoreOptions

public MySQLConnectOptions setKeyStoreOptions(JksOptions options)

Overrides:

setKeyStoreOptions in class NetClientOptions

setPfxKeyCertOptions

public MySQLConnectOptions setPfxKeyCertOptions(PfxOptions options)

Overrides:

setPfxKeyCertOptions in class NetClientOptions

setPemKeyCertOptions

public MySQLConnectOptions setPemKeyCertOptions(PemKeyCertOptions options)

Overrides:

setPemKeyCertOptions in class NetClientOptions

setTrustOptions

public MySQLConnectOptions setTrustOptions(TrustOptions options)

Overrides:

setTrustOptions in class NetClientOptions

setTrustStoreOptions

public MySQLConnectOptions setTrustStoreOptions(JksOptions options)

Overrides:

setTrustStoreOptions in class NetClientOptions

setPemTrustOptions

public MySQLConnectOptions setPemTrustOptions(PemTrustOptions options)

Overrides:

setPemTrustOptions in class NetClientOptions

setPfxTrustOptions

public MySQLConnectOptions setPfxTrustOptions(PfxOptions options)

Overrides:

setPfxTrustOptions in class NetClientOptions

addEnabledCipherSuite

public MySQLConnectOptions addEnabledCipherSuite(String suite)

Overrides:

addEnabledCipherSuite in class NetClientOptions

addEnabledSecureTransportProtocol

public MySQLConnectOptions addEnabledSecureTransportProtocol(String protocol)

Overrides:

addEnabledSecureTransportProtocol in class NetClientOptions

removeEnabledSecureTransportProtocol

public MySQLConnectOptions removeEnabledSecureTransportProtocol(String protocol)

Overrides:

removeEnabledSecureTransportProtocol in class NetClientOptions

setUseAlpn

public MySQLConnectOptions setUseAlpn(boolean useAlpn)

Overrides:

setUseAlpn in class NetClientOptions

setSslEngineOptions

public MySQLConnectOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)

Overrides:

setSslEngineOptions in class NetClientOptions

setJdkSslEngineOptions

public MySQLConnectOptions setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)

Overrides:

setJdkSslEngineOptions in class NetClientOptions

setTcpFastOpen

public MySQLConnectOptions setTcpFastOpen(boolean tcpFastOpen)

Overrides:

setTcpFastOpen in class NetClientOptions

setTcpCork

public MySQLConnectOptions setTcpCork(boolean tcpCork)

Overrides:

setTcpCork in class NetClientOptions

setTcpQuickAck

public MySQLConnectOptions setTcpQuickAck(boolean tcpQuickAck)

Overrides:

setTcpQuickAck in class NetClientOptions

setOpenSslEngineOptions

public ClientOptionsBase setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)

Overrides:

setOpenSslEngineOptions in class NetClientOptions

addCrlPath

public MySQLConnectOptions addCrlPath(String crlPath)
                               throws NullPointerException

Overrides:

addCrlPath in class NetClientOptions

Throws:

NullPointerException

addCrlValue

public MySQLConnectOptions addCrlValue(Buffer crlValue)
                                throws NullPointerException

Overrides:

addCrlValue in class NetClientOptions

Throws:

NullPointerException

setTrustAll

public MySQLConnectOptions setTrustAll(boolean trustAll)

Overrides:

setTrustAll in class NetClientOptions

setConnectTimeout

public MySQLConnectOptions setConnectTimeout(int connectTimeout)

Overrides:

setConnectTimeout in class NetClientOptions

setMetricsName

public MySQLConnectOptions setMetricsName(String metricsName)

Overrides:

setMetricsName in class NetClientOptions

setReconnectAttempts

public MySQLConnectOptions setReconnectAttempts(int attempts)

Overrides:

setReconnectAttempts in class NetClientOptions

setReconnectInterval

public MySQLConnectOptions setReconnectInterval(long interval)

Overrides:

setReconnectInterval in class NetClientOptions

setHostnameVerificationAlgorithm

public MySQLConnectOptions setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)

Overrides:

setHostnameVerificationAlgorithm in class NetClientOptions

setLogActivity

public MySQLConnectOptions setLogActivity(boolean logEnabled)

Overrides:

setLogActivity in class NetClientOptions

setProxyOptions

public MySQLConnectOptions setProxyOptions(ProxyOptions proxyOptions)

Overrides:

setProxyOptions in class NetClientOptions

setLocalAddress

public MySQLConnectOptions setLocalAddress(String localAddress)

Overrides:

setLocalAddress in class NetClientOptions

setEnabledSecureTransportProtocols

public MySQLConnectOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)

Overrides:

setEnabledSecureTransportProtocols in class NetClientOptions

setSslHandshakeTimeout

public MySQLConnectOptions setSslHandshakeTimeout(long sslHandshakeTimeout)

Overrides:

setSslHandshakeTimeout in class NetClientOptions

setSslHandshakeTimeoutUnit

public MySQLConnectOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)

Overrides:

setSslHandshakeTimeoutUnit in class NetClientOptions

init

protected void init()

Initialize with the default options.

Specified by:

init in class SqlConnectOptions

toJson

public JsonObject toJson()

Overrides:

toJson in class SqlConnectOptions