io.vertx.db2client

Class DB2ConnectOptions

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.db2client.DB2ConnectOptions

public class DB2ConnectOptions
extends SqlConnectOptions

Connect options for configuring DB2Connection or DB2Pool.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CHARSET
static Map<String,String>	DEFAULT_CONNECTION_ATTRIBUTES
static String	DEFAULT_HOST
static int	DEFAULT_PIPELINING_LIMIT
static int	DEFAULT_PORT
static boolean	DEFAULT_USE_AFFECTED_ROWS

Fields inherited from class io.vertx.sqlclient.SqlConnectOptions

DEFAULT_CACHE_PREPARED_STATEMENTS, DEFAULT_PREPARED_STATEMENT_CACHE_FILTER, 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
DB2ConnectOptions()
DB2ConnectOptions(DB2ConnectOptions other)
DB2ConnectOptions(JsonObject json)
DB2ConnectOptions(SqlConnectOptions other)

Method Summary

Modifier and Type	Method and Description
DB2ConnectOptions	addProperty(String key, String value)
boolean	equals(Object o)
static DB2ConnectOptions	fromUri(String connectionUri) Provide a DB2ConnectOptions configured from a connection URI.
int	getPipeliningLimit()
int	hashCode()
protected void	init() Initialize with the default options.
DB2ConnectOptions	setCachePreparedStatements(boolean cachePreparedStatements)
DB2ConnectOptions	setDatabase(String database)
DB2ConnectOptions	setHost(String host)
DB2ConnectOptions	setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)
DB2ConnectOptions	setKeyCertOptions(KeyCertOptions options)
DB2ConnectOptions	setKeyStoreOptions(JksOptions options)
DB2ConnectOptions	setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
DB2ConnectOptions	setPassword(String password)
DB2ConnectOptions	setPemKeyCertOptions(PemKeyCertOptions options)
DB2ConnectOptions	setPemTrustOptions(PemTrustOptions options)
DB2ConnectOptions	setPipeliningLimit(int pipeliningLimit) Deprecated. UNSTABLE FEATURE: Current default value is 1, anything higher than 1 will result in errors currently.
DB2ConnectOptions	setPort(int port)
DB2ConnectOptions	setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)
DB2ConnectOptions	setPreparedStatementCacheSqlFilter(Predicate<String> predicate)
DB2ConnectOptions	setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)
DB2ConnectOptions	setProperties(Map<String,String> properties)
DB2ConnectOptions	setSsl(boolean ssl)
DB2ConnectOptions	setSslEngineOptions(SSLEngineOptions sslEngineOptions)
DB2ConnectOptions	setSslHandshakeTimeout(long sslHandshakeTimeout)
DB2ConnectOptions	setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
DB2ConnectOptions	setTrustAll(boolean trustAll)
DB2ConnectOptions	setTrustOptions(TrustOptions options)
DB2ConnectOptions	setTrustStoreOptions(JksOptions options)
DB2ConnectOptions	setUser(String user)
JsonObject	toJson()

Methods inherited from class io.vertx.sqlclient.SqlConnectOptions

getCachePreparedStatements, getDatabase, getHost, getPassword, getPort, getPreparedStatementCacheMaxSize, getPreparedStatementCacheSqlFilter, getProperties, getUser

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

addCrlPath, addCrlValue, addEnabledCipherSuite, addEnabledSecureTransportProtocol, getHostnameVerificationAlgorithm, getReconnectAttempts, getReconnectInterval, removeEnabledSecureTransportProtocol, setConnectTimeout, setEnabledSecureTransportProtocols, setHostnameVerificationAlgorithm, setIdleTimeout, setIdleTimeoutUnit, setLocalAddress, setLogActivity, setMetricsName, setPfxKeyCertOptions, setPfxTrustOptions, setProxyOptions, setReceiveBufferSize, setReconnectAttempts, setReconnectInterval, setReuseAddress, setReusePort, setSendBufferSize, setSoLinger, setTcpCork, setTcpFastOpen, setTcpKeepAlive, setTcpNoDelay, setTcpQuickAck, setTrafficClass, setUseAlpn, setUsePooledBuffers

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_CHARSET

public static final String DEFAULT_CHARSET

See Also:

Constant Field Values

DEFAULT_USE_AFFECTED_ROWS

public static final boolean DEFAULT_USE_AFFECTED_ROWS

See Also:

Constant Field Values

DEFAULT_PIPELINING_LIMIT

public static final int DEFAULT_PIPELINING_LIMIT

See Also:

Constant Field Values

DEFAULT_CONNECTION_ATTRIBUTES

public static final Map<String,String> DEFAULT_CONNECTION_ATTRIBUTES

Constructor Detail

DB2ConnectOptions

public DB2ConnectOptions()

DB2ConnectOptions

public DB2ConnectOptions(JsonObject json)

DB2ConnectOptions

public DB2ConnectOptions(SqlConnectOptions other)

DB2ConnectOptions

public DB2ConnectOptions(DB2ConnectOptions other)

Method Detail

fromUri

public static DB2ConnectOptions fromUri(String connectionUri)
                                 throws IllegalArgumentException

Provide a DB2ConnectOptions configured from a connection URI.

Parameters:

connectionUri - the connection URI to configure from

Returns:

a DB2ConnectOptions parsed from the connection URI

Throws:

IllegalArgumentException - when the connectionUri is in an invalid format

setHost

public DB2ConnectOptions setHost(String host)

Overrides:

setHost in class SqlConnectOptions

setPort

public DB2ConnectOptions setPort(int port)

Overrides:

setPort in class SqlConnectOptions

setUser

public DB2ConnectOptions setUser(String user)

Overrides:

setUser in class SqlConnectOptions

setPassword

public DB2ConnectOptions setPassword(String password)

Overrides:

setPassword in class SqlConnectOptions

setDatabase

public DB2ConnectOptions setDatabase(String database)

Overrides:

setDatabase in class SqlConnectOptions

setCachePreparedStatements

public DB2ConnectOptions setCachePreparedStatements(boolean cachePreparedStatements)

Overrides:

setCachePreparedStatements in class SqlConnectOptions

setPreparedStatementCacheMaxSize

public DB2ConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)

Overrides:

setPreparedStatementCacheMaxSize in class SqlConnectOptions

setPreparedStatementCacheSqlFilter

public DB2ConnectOptions setPreparedStatementCacheSqlFilter(Predicate<String> predicate)

Overrides:

setPreparedStatementCacheSqlFilter in class SqlConnectOptions

setPreparedStatementCacheSqlLimit

public DB2ConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)

Overrides:

setPreparedStatementCacheSqlLimit in class SqlConnectOptions

setSsl

public DB2ConnectOptions setSsl(boolean ssl)

Overrides:

setSsl in class NetClientOptions

setSslHandshakeTimeout

public DB2ConnectOptions setSslHandshakeTimeout(long sslHandshakeTimeout)

Overrides:

setSslHandshakeTimeout in class NetClientOptions

setSslHandshakeTimeoutUnit

public DB2ConnectOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)

Overrides:

setSslHandshakeTimeoutUnit in class NetClientOptions

setSslEngineOptions

public DB2ConnectOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)

Overrides:

setSslEngineOptions in class NetClientOptions

setJdkSslEngineOptions

public DB2ConnectOptions setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)

Overrides:

setJdkSslEngineOptions in class NetClientOptions

setKeyCertOptions

public DB2ConnectOptions setKeyCertOptions(KeyCertOptions options)

Overrides:

setKeyCertOptions in class NetClientOptions

setKeyStoreOptions

public DB2ConnectOptions setKeyStoreOptions(JksOptions options)

Overrides:

setKeyStoreOptions in class NetClientOptions

setOpenSslEngineOptions

public DB2ConnectOptions setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)

Overrides:

setOpenSslEngineOptions in class NetClientOptions

setPemKeyCertOptions

public DB2ConnectOptions setPemKeyCertOptions(PemKeyCertOptions options)

Overrides:

setPemKeyCertOptions in class NetClientOptions

setPemTrustOptions

public DB2ConnectOptions setPemTrustOptions(PemTrustOptions options)

Overrides:

setPemTrustOptions in class NetClientOptions

setTrustAll

public DB2ConnectOptions setTrustAll(boolean trustAll)

Overrides:

setTrustAll in class NetClientOptions

setTrustOptions

public DB2ConnectOptions setTrustOptions(TrustOptions options)

Overrides:

setTrustOptions in class NetClientOptions

setTrustStoreOptions

public DB2ConnectOptions setTrustStoreOptions(JksOptions options)

Overrides:

setTrustStoreOptions in class NetClientOptions

getPipeliningLimit

public int getPipeliningLimit()

setPipeliningLimit

@Deprecated
public DB2ConnectOptions setPipeliningLimit(int pipeliningLimit)

Deprecated. UNSTABLE FEATURE: Current default value is 1, anything higher than 1 will result in errors currently.

Parameters:

pipeliningLimit - the number of commands that can simultaneously use the same physical socket connection.

Returns:

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

setProperties

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

Overrides:

setProperties in class SqlConnectOptions

addProperty

public DB2ConnectOptions addProperty(String key,
                                     String value)

Overrides:

addProperty in class SqlConnectOptions

init

protected void init()

Initialize with the default options.

Overrides:

init in class SqlConnectOptions

toJson

public JsonObject toJson()

Overrides:

toJson in class SqlConnectOptions

equals

public boolean equals(Object o)

Overrides:

equals in class NetClientOptions

hashCode

public int hashCode()

Overrides:

hashCode in class NetClientOptions