io.vertx.mssqlclient

Class MSSQLConnectOptions

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.mssqlclient.MSSQLConnectOptions

public class MSSQLConnectOptions
extends SqlConnectOptions

Connect options for configuring MSSQLConnection.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_APP_NAME
static String	DEFAULT_CLIENT_INTERFACE_NAME
static String	DEFAULT_DATABASE
static String	DEFAULT_HOST
static int	DEFAULT_PACKET_SIZE
static String	DEFAULT_PASSWORD
static int	DEFAULT_PORT
static Map<String,String>	DEFAULT_PROPERTIES
static String	DEFAULT_USER
static int	MAX_PACKET_SIZE
static int	MIN_PACKET_SIZE

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_READ_IDLE_TIMEOUT, 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_TCP_USER_TIMEOUT, DEFAULT_USE_ALPN, 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 and Description
MSSQLConnectOptions()
MSSQLConnectOptions(JsonObject json)
MSSQLConnectOptions(MSSQLConnectOptions other)
MSSQLConnectOptions(SqlConnectOptions other)

Method Summary

Modifier and Type	Method and Description
MSSQLConnectOptions	addCrlPath(String crlPath)
MSSQLConnectOptions	addCrlValue(Buffer crlValue)
MSSQLConnectOptions	addEnabledCipherSuite(String suite)
MSSQLConnectOptions	addEnabledSecureTransportProtocol(String protocol)
MSSQLConnectOptions	addProperty(String key, String value)
static MSSQLConnectOptions	fromUri(String connectionUri) Provide a MSSQLConnectOptions configured from a connection URI.
int	getPacketSize() Get the desired size (in bytes) for TDS packets.
protected void	init() Initialize with the default options.
MSSQLConnectOptions	merge(JsonObject other)
MSSQLConnectOptions	removeEnabledSecureTransportProtocol(String protocol)
MSSQLConnectOptions	setConnectTimeout(int connectTimeout)
MSSQLConnectOptions	setDatabase(String database)
MSSQLConnectOptions	setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
MSSQLConnectOptions	setHost(String host)
MSSQLConnectOptions	setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)
MSSQLConnectOptions	setIdleTimeout(int idleTimeout)
MSSQLConnectOptions	setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
MSSQLConnectOptions	setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)
MSSQLConnectOptions	setKeyCertOptions(KeyCertOptions options)
MSSQLConnectOptions	setKeyStoreOptions(JksOptions options)
MSSQLConnectOptions	setLocalAddress(String localAddress)
MSSQLConnectOptions	setLogActivity(boolean logEnabled)
MSSQLConnectOptions	setMetricsName(String metricsName)
MSSQLConnectOptions	setNonProxyHosts(List<String> nonProxyHosts)
MSSQLConnectOptions	setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
MSSQLConnectOptions	setPacketSize(int packetSize) Set the desired size (in bytes) for TDS packets.
MSSQLConnectOptions	setPassword(String password)
MSSQLConnectOptions	setPemKeyCertOptions(PemKeyCertOptions options)
MSSQLConnectOptions	setPemTrustOptions(PemTrustOptions options)
MSSQLConnectOptions	setPfxKeyCertOptions(PfxOptions options)
MSSQLConnectOptions	setPfxTrustOptions(PfxOptions options)
MSSQLConnectOptions	setPort(int port)
MSSQLConnectOptions	setProperties(Map<String,String> properties)
MSSQLConnectOptions	setProxyOptions(ProxyOptions proxyOptions)
MSSQLConnectOptions	setReceiveBufferSize(int receiveBufferSize)
MSSQLConnectOptions	setReconnectAttempts(int attempts)
MSSQLConnectOptions	setReconnectInterval(long interval)
MSSQLConnectOptions	setReuseAddress(boolean reuseAddress)
MSSQLConnectOptions	setReusePort(boolean reusePort)
MSSQLConnectOptions	setSendBufferSize(int sendBufferSize)
MSSQLConnectOptions	setSoLinger(int soLinger)
MSSQLConnectOptions	setSsl(boolean ssl)
MSSQLConnectOptions	setSslEngineOptions(SSLEngineOptions sslEngineOptions)
MSSQLConnectOptions	setSslHandshakeTimeout(long sslHandshakeTimeout)
MSSQLConnectOptions	setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
MSSQLConnectOptions	setTcpCork(boolean tcpCork)
MSSQLConnectOptions	setTcpFastOpen(boolean tcpFastOpen)
MSSQLConnectOptions	setTcpKeepAlive(boolean tcpKeepAlive)
MSSQLConnectOptions	setTcpNoDelay(boolean tcpNoDelay)
MSSQLConnectOptions	setTcpQuickAck(boolean tcpQuickAck)
MSSQLConnectOptions	setTracingPolicy(TracingPolicy tracingPolicy)
MSSQLConnectOptions	setTrafficClass(int trafficClass)
MSSQLConnectOptions	setTrustAll(boolean trustAll)
MSSQLConnectOptions	setTrustOptions(TrustOptions options)
MSSQLConnectOptions	setTrustStoreOptions(JksOptions options)
MSSQLConnectOptions	setUseAlpn(boolean useAlpn)
MSSQLConnectOptions	setUser(String user)
JsonObject	toJson()
static MSSQLConnectOptions	wrap(SqlConnectOptions options)

Methods inherited from class io.vertx.sqlclient.SqlConnectOptions

getCachePreparedStatements, getDatabase, getHost, getPassword, getPort, getPreparedStatementCacheMaxSize, getPreparedStatementCacheSqlFilter, getProperties, getSocketAddress, getTracingPolicy, getUser, isUsingDomainSocket, setCachePreparedStatements, setPreparedStatementCacheMaxSize, setPreparedStatementCacheSqlFilter, setPreparedStatementCacheSqlLimit

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

addNonProxyHost, getApplicationLayerProtocols, getHostnameVerificationAlgorithm, getReconnectAttempts, getReconnectInterval, removeEnabledCipherSuite, setActivityLogDataFormat, setApplicationLayerProtocols, setReadIdleTimeout, setWriteIdleTimeout

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

getConnectTimeout, getLocalAddress, getMetricsName, getNonProxyHosts, getProxyOptions, isTrustAll, setTcpUserTimeout

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

getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getReadIdleTimeout, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTcpUserTimeout, getTrustOptions, getTrustStoreOptions, getWriteIdleTimeout, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn

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_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_DATABASE

public static final String DEFAULT_DATABASE

See Also:

Constant Field Values

DEFAULT_APP_NAME

public static final String DEFAULT_APP_NAME

See Also:

Constant Field Values

DEFAULT_CLIENT_INTERFACE_NAME

public static final String DEFAULT_CLIENT_INTERFACE_NAME

See Also:

Constant Field Values

DEFAULT_PROPERTIES

public static final Map<String,String> DEFAULT_PROPERTIES

MIN_PACKET_SIZE

public static final int MIN_PACKET_SIZE

See Also:

Constant Field Values

MAX_PACKET_SIZE

public static final int MAX_PACKET_SIZE

See Also:

Constant Field Values

DEFAULT_PACKET_SIZE

public static final int DEFAULT_PACKET_SIZE

See Also:

Constant Field Values

Constructor Detail

MSSQLConnectOptions

public MSSQLConnectOptions()

MSSQLConnectOptions

public MSSQLConnectOptions(JsonObject json)

MSSQLConnectOptions

public MSSQLConnectOptions(SqlConnectOptions other)

MSSQLConnectOptions

public MSSQLConnectOptions(MSSQLConnectOptions other)

Method Detail

wrap

public static MSSQLConnectOptions wrap(SqlConnectOptions options)

Returns:

the options as MSSQL specific connect options

fromUri

public static MSSQLConnectOptions fromUri(String connectionUri)
                                   throws IllegalArgumentException

Provide a MSSQLConnectOptions configured from a connection URI.

Parameters:

connectionUri - the connection URI to configure from

Returns:

a MSSQLConnectOptions parsed from the connection URI

Throws:

IllegalArgumentException - when the connectionUri is in an invalid format

setHost

public MSSQLConnectOptions setHost(String host)

Overrides:

setHost in class SqlConnectOptions

setPort

public MSSQLConnectOptions setPort(int port)

Overrides:

setPort in class SqlConnectOptions

setUser

public MSSQLConnectOptions setUser(String user)

Overrides:

setUser in class SqlConnectOptions

setPassword

public MSSQLConnectOptions setPassword(String password)

Overrides:

setPassword in class SqlConnectOptions

setDatabase

public MSSQLConnectOptions setDatabase(String database)

Overrides:

setDatabase in class SqlConnectOptions

setProperties

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

Overrides:

setProperties in class SqlConnectOptions

addProperty

public MSSQLConnectOptions addProperty(String key,
                                       String value)

Overrides:

addProperty in class SqlConnectOptions

getPacketSize

public int getPacketSize()

Get the desired size (in bytes) for TDS packets.

Returns:

the desired packet size

setPacketSize

public MSSQLConnectOptions setPacketSize(int packetSize)

Set the desired size (in bytes) for TDS packets.

The client will use the value as a parameter in the LOGIN7 packet. The server may or may not accept it.

Parameters:

packetSize - the desired packet size (in bytes)

Returns:

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

Throws:

IllegalArgumentException - if packetSize is smaller than MIN_PACKET_SIZE or bigger than MAX_PACKET_SIZE

setSendBufferSize

public MSSQLConnectOptions setSendBufferSize(int sendBufferSize)

Overrides:

setSendBufferSize in class NetClientOptions

setReceiveBufferSize

public MSSQLConnectOptions setReceiveBufferSize(int receiveBufferSize)

Overrides:

setReceiveBufferSize in class NetClientOptions

setReuseAddress

public MSSQLConnectOptions setReuseAddress(boolean reuseAddress)

Overrides:

setReuseAddress in class NetClientOptions

setReusePort

public MSSQLConnectOptions setReusePort(boolean reusePort)

Overrides:

setReusePort in class NetClientOptions

setTrafficClass

public MSSQLConnectOptions setTrafficClass(int trafficClass)

Overrides:

setTrafficClass in class NetClientOptions

setTcpNoDelay

public MSSQLConnectOptions setTcpNoDelay(boolean tcpNoDelay)

Overrides:

setTcpNoDelay in class NetClientOptions

setTcpKeepAlive

public MSSQLConnectOptions setTcpKeepAlive(boolean tcpKeepAlive)

Overrides:

setTcpKeepAlive in class NetClientOptions

setSoLinger

public MSSQLConnectOptions setSoLinger(int soLinger)

Overrides:

setSoLinger in class NetClientOptions

setIdleTimeout

public MSSQLConnectOptions setIdleTimeout(int idleTimeout)

Overrides:

setIdleTimeout in class NetClientOptions

setIdleTimeoutUnit

public MSSQLConnectOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)

Overrides:

setIdleTimeoutUnit in class NetClientOptions

setKeyCertOptions

public MSSQLConnectOptions setKeyCertOptions(KeyCertOptions options)

Overrides:

setKeyCertOptions in class NetClientOptions

setKeyStoreOptions

public MSSQLConnectOptions setKeyStoreOptions(JksOptions options)

Overrides:

setKeyStoreOptions in class NetClientOptions

setPfxKeyCertOptions

public MSSQLConnectOptions setPfxKeyCertOptions(PfxOptions options)

Overrides:

setPfxKeyCertOptions in class NetClientOptions

setPemKeyCertOptions

public MSSQLConnectOptions setPemKeyCertOptions(PemKeyCertOptions options)

Overrides:

setPemKeyCertOptions in class NetClientOptions

setTrustOptions

public MSSQLConnectOptions setTrustOptions(TrustOptions options)

Overrides:

setTrustOptions in class NetClientOptions

setTrustStoreOptions

public MSSQLConnectOptions setTrustStoreOptions(JksOptions options)

Overrides:

setTrustStoreOptions in class NetClientOptions

setPemTrustOptions

public MSSQLConnectOptions setPemTrustOptions(PemTrustOptions options)

Overrides:

setPemTrustOptions in class NetClientOptions

setPfxTrustOptions

public MSSQLConnectOptions setPfxTrustOptions(PfxOptions options)

Overrides:

setPfxTrustOptions in class NetClientOptions

addEnabledCipherSuite

public MSSQLConnectOptions addEnabledCipherSuite(String suite)

Overrides:

addEnabledCipherSuite in class NetClientOptions

addEnabledSecureTransportProtocol

public MSSQLConnectOptions addEnabledSecureTransportProtocol(String protocol)

Overrides:

addEnabledSecureTransportProtocol in class NetClientOptions

removeEnabledSecureTransportProtocol

public MSSQLConnectOptions removeEnabledSecureTransportProtocol(String protocol)

Overrides:

removeEnabledSecureTransportProtocol in class NetClientOptions

setUseAlpn

public MSSQLConnectOptions setUseAlpn(boolean useAlpn)

Overrides:

setUseAlpn in class NetClientOptions

setSslEngineOptions

public MSSQLConnectOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)

Overrides:

setSslEngineOptions in class NetClientOptions

setJdkSslEngineOptions

public MSSQLConnectOptions setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)

Overrides:

setJdkSslEngineOptions in class NetClientOptions

setTcpFastOpen

public MSSQLConnectOptions setTcpFastOpen(boolean tcpFastOpen)

Overrides:

setTcpFastOpen in class NetClientOptions

setTcpCork

public MSSQLConnectOptions setTcpCork(boolean tcpCork)

Overrides:

setTcpCork in class NetClientOptions

setTcpQuickAck

public MSSQLConnectOptions setTcpQuickAck(boolean tcpQuickAck)

Overrides:

setTcpQuickAck in class NetClientOptions

setOpenSslEngineOptions

public MSSQLConnectOptions setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)

Overrides:

setOpenSslEngineOptions in class NetClientOptions

addCrlPath

public MSSQLConnectOptions addCrlPath(String crlPath)
                               throws NullPointerException

Overrides:

addCrlPath in class NetClientOptions

Throws:

NullPointerException

addCrlValue

public MSSQLConnectOptions addCrlValue(Buffer crlValue)
                                throws NullPointerException

Overrides:

addCrlValue in class NetClientOptions

Throws:

NullPointerException

setTrustAll

public MSSQLConnectOptions setTrustAll(boolean trustAll)

Overrides:

setTrustAll in class NetClientOptions

setConnectTimeout

public MSSQLConnectOptions setConnectTimeout(int connectTimeout)

Overrides:

setConnectTimeout in class NetClientOptions

setMetricsName

public MSSQLConnectOptions setMetricsName(String metricsName)

Overrides:

setMetricsName in class NetClientOptions

setReconnectAttempts

public MSSQLConnectOptions setReconnectAttempts(int attempts)

Overrides:

setReconnectAttempts in class NetClientOptions

setReconnectInterval

public MSSQLConnectOptions setReconnectInterval(long interval)

Overrides:

setReconnectInterval in class NetClientOptions

setHostnameVerificationAlgorithm

public MSSQLConnectOptions setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)

Overrides:

setHostnameVerificationAlgorithm in class NetClientOptions

setLogActivity

public MSSQLConnectOptions setLogActivity(boolean logEnabled)

Overrides:

setLogActivity in class NetClientOptions

setProxyOptions

public MSSQLConnectOptions setProxyOptions(ProxyOptions proxyOptions)

Overrides:

setProxyOptions in class NetClientOptions

setLocalAddress

public MSSQLConnectOptions setLocalAddress(String localAddress)

Overrides:

setLocalAddress in class NetClientOptions

setEnabledSecureTransportProtocols

public MSSQLConnectOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)

Overrides:

setEnabledSecureTransportProtocols in class NetClientOptions

setSslHandshakeTimeout

public MSSQLConnectOptions setSslHandshakeTimeout(long sslHandshakeTimeout)

Overrides:

setSslHandshakeTimeout in class NetClientOptions

setSslHandshakeTimeoutUnit

public MSSQLConnectOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)

Overrides:

setSslHandshakeTimeoutUnit in class NetClientOptions

setTracingPolicy

public MSSQLConnectOptions setTracingPolicy(TracingPolicy tracingPolicy)

Overrides:

setTracingPolicy in class SqlConnectOptions

setSsl

public MSSQLConnectOptions setSsl(boolean ssl)

Overrides:

setSsl in class NetClientOptions

setNonProxyHosts

public MSSQLConnectOptions setNonProxyHosts(List<String> nonProxyHosts)

Overrides:

setNonProxyHosts in class NetClientOptions

init

protected void init()

Initialize with the default options.

Overrides:

init in class SqlConnectOptions

toJson

public JsonObject toJson()

Overrides:

toJson in class SqlConnectOptions

merge

public MSSQLConnectOptions merge(JsonObject other)

Overrides:

merge in class SqlConnectOptions