io.vertx.pgclient

Class PgConnectOptions

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.pgclient.PgConnectOptions

public class PgConnectOptions
extends SqlConnectOptions

Author:

Julien Viet, Billy Yuan

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DATABASE
static String	DEFAULT_HOST
static String	DEFAULT_PASSWORD
static int	DEFAULT_PIPELINING_LIMIT
static int	DEFAULT_PORT
static Map<String,String>	DEFAULT_PROPERTIES
static SslMode	DEFAULT_SSLMODE
static boolean	DEFAULT_USE_LAYER_7_PROXY
static String	DEFAULT_USER

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, DEFAULT_REGISTER_WRITE_HANDLER

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_KEEAPLIVE_INTERVAL_SECONDS, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_KEEPALIVE_COUNT, DEFAULT_TCP_KEEPALIVE_IDLE_SECONDS, 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
PgConnectOptions()
PgConnectOptions(JsonObject json)
PgConnectOptions(PgConnectOptions other)
PgConnectOptions(SqlConnectOptions other)

Method Summary

Modifier and Type	Method and Description
PgConnectOptions	addCrlPath(String crlPath) Add a CRL path
PgConnectOptions	addCrlValue(Buffer crlValue) Add a CRL value
PgConnectOptions	addEnabledCipherSuite(String suite) Add an enabled cipher suite, appended to the ordered suites.
PgConnectOptions	addEnabledSecureTransportProtocol(String protocol) Add an enabled SSL/TLS protocols, appended to the ordered protocols.
PgConnectOptions	addProperty(String key, String value) Add a property for this client, which will be sent to server at the connection start.
boolean	equals(Object o)
static PgConnectOptions	fromEnv() Provide a PgConnectOptions configured with environment variables, if the environment variable is not set, then a default value will take precedence over this.
static PgConnectOptions	fromUri(String connectionUri) Provide a PgConnectOptions configured from a connection URI.
int	getPipeliningLimit()
SocketAddress	getSocketAddress()
SslMode	getSslMode()
boolean	getUseLayer7Proxy()
int	hashCode()
protected void	init() Initialize with the default options.
boolean	isUsingDomainSocket()
PgConnectOptions	merge(JsonObject other) Returns new options created after this object and merged with the other json config.
PgConnectOptions	setCachePreparedStatements(boolean cachePreparedStatements) Set whether prepared statements cache should be enabled.
PgConnectOptions	setConnectTimeout(int connectTimeout) Set the connect timeout
PgConnectOptions	setDatabase(String database) Specify the default database for the connection.
PgConnectOptions	setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols) Sets the list of enabled SSL/TLS protocols.
PgConnectOptions	setHost(String host) Specify the host for connecting to the server.
PgConnectOptions	setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm) Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String
PgConnectOptions	setIdleTimeout(int idleTimeout) Set the idle timeout, default time unit is seconds.
PgConnectOptions	setIdleTimeoutUnit(TimeUnit idleTimeoutUnit) Set the idle timeout unit.
PgConnectOptions	setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)
PgConnectOptions	setKeyCertOptions(KeyCertOptions options) Set the key/cert options.
PgConnectOptions	setKeyStoreOptions(JksOptions options) Set the key/cert options in jks format, aka Java keystore.
PgConnectOptions	setLocalAddress(String localAddress) Set the local interface to bind for network connections.
PgConnectOptions	setLogActivity(boolean logEnabled) Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
PgConnectOptions	setMetricsName(String metricsName) Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.
PgConnectOptions	setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
PgConnectOptions	setPassword(String password) Specify the user password to be used for the authentication.
PgConnectOptions	setPemKeyCertOptions(PemKeyCertOptions options) Set the key/cert store options in pem format.
PgConnectOptions	setPemTrustOptions(PemTrustOptions options) Set the trust options in pem format
PgConnectOptions	setPfxKeyCertOptions(PfxOptions options) Set the key/cert options in pfx format.
PgConnectOptions	setPfxTrustOptions(PfxOptions options) Set the trust options in pfx format
PgConnectOptions	setPipeliningLimit(int pipeliningLimit)
PgConnectOptions	setPort(int port) Specify the port for connecting to the server.
PgConnectOptions	setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize) Set the maximum number of prepared statements that the connection will cache.
PgConnectOptions	setPreparedStatementCacheSqlFilter(java.util.function.Predicate<String> predicate) Set a predicate filtering prepared statements that the connection will cache.
PgConnectOptions	setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit) Set the maximum length of prepared statement SQL string that the connection will cache.
PgConnectOptions	setProperties(Map<String,String> properties) Set properties for this client, which will be sent to server at the connection start.
PgConnectOptions	setProxyOptions(ProxyOptions proxyOptions) Set proxy options for connections via CONNECT proxy (e.g.
PgConnectOptions	setReceiveBufferSize(int receiveBufferSize) Set the TCP receive buffer size
PgConnectOptions	setReconnectAttempts(int attempts) Set the value of reconnect attempts
PgConnectOptions	setReconnectInterval(long interval) Set the reconnect interval
PgConnectOptions	setReuseAddress(boolean reuseAddress) Set the value of reuse address
PgConnectOptions	setReusePort(boolean reusePort) Set the value of reuse port.
PgConnectOptions	setSendBufferSize(int sendBufferSize) Set the TCP send buffer size
PgConnectOptions	setSoLinger(int soLinger) Set whether SO_linger keep alive is enabled
PgConnectOptions	setSsl(boolean ssl) Set whether SSL/TLS is enabled
PgConnectOptions	setSslEngineOptions(SSLEngineOptions sslEngineOptions) Set to use SSL engine implementation to use.
PgConnectOptions	setSslHandshakeTimeout(long sslHandshakeTimeout) Set the SSL handshake timeout, default time unit is seconds.
PgConnectOptions	setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit) Set the SSL handshake timeout unit.
PgConnectOptions	setSslMode(SslMode sslmode) Set SslMode for the client, this option can be used to provide different levels of secure protection.
PgConnectOptions	setTcpCork(boolean tcpCork) Enable the TCP_CORK option - only with linux native transport.
PgConnectOptions	setTcpFastOpen(boolean tcpFastOpen) Enable the TCP_FASTOPEN option - only with linux native transport.
PgConnectOptions	setTcpKeepAlive(boolean tcpKeepAlive) Set whether TCP keep alive is enabled
PgConnectOptions	setTcpNoDelay(boolean tcpNoDelay) Set whether TCP no delay is enabled
PgConnectOptions	setTcpQuickAck(boolean tcpQuickAck) Enable the TCP_QUICKACK option - only with linux native transport.
PgConnectOptions	setTracingPolicy(TracingPolicy tracingPolicy) Set the tracing policy for the client behavior when Vert.x has tracing enabled.
PgConnectOptions	setTrafficClass(int trafficClass) Set the value of traffic class
PgConnectOptions	setTrustAll(boolean trustAll) Set whether all server certificates should be trusted
PgConnectOptions	setTrustOptions(TrustOptions options) Set the trust options.
PgConnectOptions	setTrustStoreOptions(JksOptions options) Set the trust options in jks format, aka Java truststore
PgConnectOptions	setUseAlpn(boolean useAlpn) Set the ALPN usage.
PgConnectOptions	setUseLayer7Proxy(boolean useLayer7Proxy) Set the client to use a layer 7 (application) proxy compatible protocol, set to true when the client interacts with a layer 7 proxy like PgBouncer instead of a server.
PgConnectOptions	setUser(String user) Specify the user account to be used for the authentication.
JsonObject	toJson() Convert to JSON
static PgConnectOptions	wrap(SqlConnectOptions options)

Methods inherited from class io.vertx.sqlclient.SqlConnectOptions

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

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

addNonProxyHost, getApplicationLayerProtocols, getHostnameVerificationAlgorithm, getReconnectAttempts, getReconnectInterval, isRegisterWriteHandler, removeEnabledCipherSuite, removeEnabledSecureTransportProtocol, setActivityLogDataFormat, setApplicationLayerProtocols, setNonProxyHosts, setReadIdleTimeout, setRegisterWriteHandler, 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, getSslOptions, getTcpKeepAliveCount, getTcpKeepAliveIdleSeconds, getTcpKeepAliveIntervalSeconds, getTcpUserTimeout, getTrustOptions, getTrustStoreOptions, getWriteIdleTimeout, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn, setTcpKeepAliveCount, setTcpKeepAliveIdleSeconds, setTcpKeepAliveIntervalSeconds

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

getActivityLogDataFormat, 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 int DEFAULT_PORT

DEFAULT_DATABASE

public static final String DEFAULT_DATABASE

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_PIPELINING_LIMIT

public static final int DEFAULT_PIPELINING_LIMIT

See Also:

Constant Field Values

DEFAULT_SSLMODE

public static final SslMode DEFAULT_SSLMODE

DEFAULT_USE_LAYER_7_PROXY

public static final boolean DEFAULT_USE_LAYER_7_PROXY

See Also:

Constant Field Values

DEFAULT_PROPERTIES

public static final Map<String,String> DEFAULT_PROPERTIES

Constructor Detail

PgConnectOptions

public PgConnectOptions()

PgConnectOptions

public PgConnectOptions(JsonObject json)

PgConnectOptions

public PgConnectOptions(SqlConnectOptions other)

PgConnectOptions

public PgConnectOptions(PgConnectOptions other)

Method Detail

wrap

public static PgConnectOptions wrap(SqlConnectOptions options)

Returns:

the options as PostgreSQL specific connect options

fromUri

public static PgConnectOptions fromUri(String connectionUri)
                                throws IllegalArgumentException

Provide a PgConnectOptions configured from a connection URI.

Parameters:

connectionUri - the connection URI to configure from

Returns:

a PgConnectOptions parsed from the connection URI

Throws:

IllegalArgumentException - when the connectionUri is in an invalid format

fromEnv

public static PgConnectOptions fromEnv()

Provide a PgConnectOptions configured with environment variables, if the environment variable is not set, then a default value will take precedence over this.

setHost

public PgConnectOptions setHost(String host)

Description copied from class: SqlConnectOptions

Specify the host for connecting to the server.

Overrides:

setHost in class SqlConnectOptions

Parameters:

host - the host to specify

Returns:

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

setPort

public PgConnectOptions setPort(int port)

Description copied from class: SqlConnectOptions

Specify the port for connecting to the server.

Overrides:

setPort in class SqlConnectOptions

Parameters:

port - the port to specify

Returns:

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

setUser

public PgConnectOptions setUser(String user)

Description copied from class: SqlConnectOptions

Specify the user account to be used for the authentication.

Overrides:

setUser in class SqlConnectOptions

Parameters:

user - the user to specify

Returns:

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

setPassword

public PgConnectOptions setPassword(String password)

Description copied from class: SqlConnectOptions

Specify the user password to be used for the authentication.

Overrides:

setPassword in class SqlConnectOptions

Parameters:

password - the password to specify

Returns:

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

setDatabase

public PgConnectOptions setDatabase(String database)

Description copied from class: SqlConnectOptions

Specify the default database for the connection.

Overrides:

setDatabase in class SqlConnectOptions

Parameters:

database - the database name to specify

Returns:

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

getPipeliningLimit

public int getPipeliningLimit()

setPipeliningLimit

public PgConnectOptions setPipeliningLimit(int pipeliningLimit)

setCachePreparedStatements

public PgConnectOptions setCachePreparedStatements(boolean cachePreparedStatements)

Description copied from class: SqlConnectOptions

Set whether prepared statements cache should be enabled.

Overrides:

setCachePreparedStatements in class SqlConnectOptions

Parameters:

cachePreparedStatements - true if cache should be enabled

Returns:

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

setPreparedStatementCacheMaxSize

public PgConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)

Description copied from class: SqlConnectOptions

Set the maximum number of prepared statements that the connection will cache.

Overrides:

setPreparedStatementCacheMaxSize in class SqlConnectOptions

Parameters:

preparedStatementCacheMaxSize - the size to set

Returns:

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

setPreparedStatementCacheSqlFilter

public PgConnectOptions setPreparedStatementCacheSqlFilter(java.util.function.Predicate<String> predicate)

Description copied from class: SqlConnectOptions

Set a predicate filtering prepared statements that the connection will cache.

The default predicate accepts predicate having query length < SqlConnectOptions.DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT

Overrides:

setPreparedStatementCacheSqlFilter in class SqlConnectOptions

Parameters:

predicate - the filter

setPreparedStatementCacheSqlLimit

public PgConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)

Description copied from class: SqlConnectOptions

Set the maximum length of prepared statement SQL string that the connection will cache.

This is an helper setting the SqlConnectOptions.setPreparedStatementCacheSqlFilter(Predicate).

Overrides:

setPreparedStatementCacheSqlLimit in class SqlConnectOptions

Parameters:

preparedStatementCacheSqlLimit - the maximum length limit of SQL string to set

Returns:

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

setProperties

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

Description copied from class: SqlConnectOptions

Set properties for this client, which will be sent to server at the connection start.

Overrides:

setProperties in class SqlConnectOptions

Parameters:

properties - the value of properties to specify

Returns:

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

addProperty

public PgConnectOptions addProperty(String key,
                                    String value)

Description copied from class: SqlConnectOptions

Add a property for this client, which will be sent to server at the connection start.

Overrides:

addProperty in class SqlConnectOptions

Parameters:

key - the value of property key

value - the value of property value

Returns:

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

getSslMode

public SslMode getSslMode()

Returns:

the value of current sslmode

setSslMode

public PgConnectOptions setSslMode(SslMode sslmode)

Set SslMode for the client, this option can be used to provide different levels of secure protection.

Parameters:

sslmode - the value of sslmode

Returns:

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

getUseLayer7Proxy

@Unstable
public boolean getUseLayer7Proxy()

Returns:

whether the client interacts with a layer 7 proxy instead of a server

setUseLayer7Proxy

@Unstable
public PgConnectOptions setUseLayer7Proxy(boolean useLayer7Proxy)

Set the client to use a layer 7 (application) proxy compatible protocol, set to true when the client interacts with a layer 7 proxy like PgBouncer instead of a server. Prepared statement caching must be disabled.

Parameters:

useLayer7Proxy - whether to use a layer 7 proxy instead of a server

Returns:

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

setSendBufferSize

public PgConnectOptions setSendBufferSize(int sendBufferSize)

Description copied from class: NetworkOptions

Set the TCP send buffer size

Overrides:

setSendBufferSize in class NetClientOptions

Parameters:

sendBufferSize - the buffers size, in bytes

Returns:

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

setReceiveBufferSize

public PgConnectOptions setReceiveBufferSize(int receiveBufferSize)

Description copied from class: NetworkOptions

Set the TCP receive buffer size

Overrides:

setReceiveBufferSize in class NetClientOptions

Parameters:

receiveBufferSize - the buffers size, in bytes

Returns:

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

setReuseAddress

public PgConnectOptions setReuseAddress(boolean reuseAddress)

Description copied from class: NetworkOptions

Set the value of reuse address

Overrides:

setReuseAddress in class NetClientOptions

Parameters:

reuseAddress - the value of reuse address

Returns:

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

setTrafficClass

public PgConnectOptions setTrafficClass(int trafficClass)

Description copied from class: NetworkOptions

Set the value of traffic class

Overrides:

setTrafficClass in class NetClientOptions

Parameters:

trafficClass - the value of traffic class

Returns:

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

setTcpNoDelay

public PgConnectOptions setTcpNoDelay(boolean tcpNoDelay)

Description copied from class: TCPSSLOptions

Set whether TCP no delay is enabled

Overrides:

setTcpNoDelay in class NetClientOptions

Parameters:

tcpNoDelay - true if TCP no delay is enabled (Nagle disabled)

Returns:

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

setTcpKeepAlive

public PgConnectOptions setTcpKeepAlive(boolean tcpKeepAlive)

Description copied from class: TCPSSLOptions

Set whether TCP keep alive is enabled

Overrides:

setTcpKeepAlive in class NetClientOptions

Parameters:

tcpKeepAlive - true if TCP keep alive is enabled

Returns:

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

setSoLinger

public PgConnectOptions setSoLinger(int soLinger)

Description copied from class: TCPSSLOptions

Set whether SO_linger keep alive is enabled

Overrides:

setSoLinger in class NetClientOptions

Parameters:

soLinger - true if SO_linger is enabled

Returns:

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

setIdleTimeout

public PgConnectOptions setIdleTimeout(int idleTimeout)

Description copied from class: TCPSSLOptions

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 TCPSSLOptions.setIdleTimeoutUnit(TimeUnit)

Overrides:

setIdleTimeout in class NetClientOptions

Parameters:

idleTimeout - the timeout

Returns:

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

setIdleTimeoutUnit

public PgConnectOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)

Description copied from class: TCPSSLOptions

Set the idle timeout unit. If not specified, default is seconds.

Overrides:

setIdleTimeoutUnit in class NetClientOptions

Parameters:

idleTimeoutUnit - specify time unit.

Returns:

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

setSsl

public PgConnectOptions setSsl(boolean ssl)

Description copied from class: TCPSSLOptions

Set whether SSL/TLS is enabled

Overrides:

setSsl in class NetClientOptions

Parameters:

ssl - true if enabled

Returns:

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

setKeyCertOptions

public PgConnectOptions setKeyCertOptions(KeyCertOptions options)

Description copied from class: TCPSSLOptions

Set the key/cert options.

Overrides:

setKeyCertOptions in class NetClientOptions

Parameters:

options - the key store options

Returns:

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

setKeyStoreOptions

public PgConnectOptions setKeyStoreOptions(JksOptions options)

Description copied from class: TCPSSLOptions

Set the key/cert options in jks format, aka Java keystore.

Overrides:

setKeyStoreOptions in class NetClientOptions

Parameters:

options - the key store in jks format

Returns:

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

setPfxKeyCertOptions

public PgConnectOptions setPfxKeyCertOptions(PfxOptions options)

Description copied from class: TCPSSLOptions

Set the key/cert options in pfx format.

Overrides:

setPfxKeyCertOptions in class NetClientOptions

Parameters:

options - the key cert options in pfx format

Returns:

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

setPemKeyCertOptions

public PgConnectOptions setPemKeyCertOptions(PemKeyCertOptions options)

Description copied from class: TCPSSLOptions

Set the key/cert store options in pem format.

Overrides:

setPemKeyCertOptions in class NetClientOptions

Parameters:

options - the options in pem format

Returns:

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

setTrustOptions

public PgConnectOptions setTrustOptions(TrustOptions options)

Description copied from class: TCPSSLOptions

Set the trust options.

Overrides:

setTrustOptions in class NetClientOptions

Parameters:

options - the trust options

Returns:

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

setTrustStoreOptions

public PgConnectOptions setTrustStoreOptions(JksOptions options)

Description copied from class: TCPSSLOptions

Set the trust options in jks format, aka Java truststore

Overrides:

setTrustStoreOptions in class NetClientOptions

Parameters:

options - the trust options in jks format

Returns:

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

setPemTrustOptions

public PgConnectOptions setPemTrustOptions(PemTrustOptions options)

Description copied from class: TCPSSLOptions

Set the trust options in pem format

Overrides:

setPemTrustOptions in class NetClientOptions

Parameters:

options - the trust options in pem format

Returns:

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

setPfxTrustOptions

public PgConnectOptions setPfxTrustOptions(PfxOptions options)

Description copied from class: TCPSSLOptions

Set the trust options in pfx format

Overrides:

setPfxTrustOptions in class NetClientOptions

Parameters:

options - the trust options in pfx format

Returns:

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

addEnabledCipherSuite

public PgConnectOptions addEnabledCipherSuite(String suite)

Description copied from class: TCPSSLOptions

Add an enabled cipher suite, appended to the ordered suites.

Overrides:

addEnabledCipherSuite in class NetClientOptions

Parameters:

suite - the suite

Returns:

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

See Also:

TCPSSLOptions.getEnabledCipherSuites()

addEnabledSecureTransportProtocol

public PgConnectOptions addEnabledSecureTransportProtocol(String protocol)

Description copied from class: TCPSSLOptions

Add an enabled SSL/TLS protocols, appended to the ordered protocols.

Overrides:

addEnabledSecureTransportProtocol in class NetClientOptions

Parameters:

protocol - the SSL/TLS protocol to enable

Returns:

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

addCrlPath

public PgConnectOptions addCrlPath(String crlPath)
                            throws NullPointerException

Description copied from class: TCPSSLOptions

Add a CRL path

Overrides:

addCrlPath in class NetClientOptions

Parameters:

crlPath - the path

Returns:

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

Throws:

NullPointerException

addCrlValue

public PgConnectOptions addCrlValue(Buffer crlValue)
                             throws NullPointerException

Description copied from class: TCPSSLOptions

Add a CRL value

Overrides:

addCrlValue in class NetClientOptions

Parameters:

crlValue - the value

Returns:

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

Throws:

NullPointerException

setTrustAll

public PgConnectOptions setTrustAll(boolean trustAll)

Description copied from class: ClientOptionsBase

Set whether all server certificates should be trusted

Overrides:

setTrustAll in class NetClientOptions

Parameters:

trustAll - true if all should be trusted

Returns:

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

setConnectTimeout

public PgConnectOptions setConnectTimeout(int connectTimeout)

Description copied from class: ClientOptionsBase

Set the connect timeout

Overrides:

setConnectTimeout in class NetClientOptions

Parameters:

connectTimeout - connect timeout, in ms

Returns:

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

setMetricsName

public PgConnectOptions setMetricsName(String metricsName)

Description copied from class: ClientOptionsBase

Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

Overrides:

setMetricsName in class NetClientOptions

Parameters:

metricsName - the metrics name

Returns:

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

setReconnectAttempts

public PgConnectOptions setReconnectAttempts(int attempts)

Description copied from class: NetClientOptions

Set the value of reconnect attempts

Overrides:

setReconnectAttempts in class NetClientOptions

Parameters:

attempts - the maximum number of reconnect attempts

Returns:

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

setHostnameVerificationAlgorithm

public PgConnectOptions setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)

Description copied from class: NetClientOptions

Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

Overrides:

setHostnameVerificationAlgorithm in class NetClientOptions

Parameters:

hostnameVerificationAlgorithm - should be HTTPS, LDAPS or an empty String

Returns:

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

setLogActivity

public PgConnectOptions 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 NetClientOptions

Parameters:

logEnabled - true for logging the network activity

Returns:

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

setReconnectInterval

public PgConnectOptions setReconnectInterval(long interval)

Description copied from class: NetClientOptions

Set the reconnect interval

Overrides:

setReconnectInterval in class NetClientOptions

Parameters:

interval - the reconnect interval in ms

Returns:

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

setProxyOptions

public PgConnectOptions setProxyOptions(ProxyOptions proxyOptions)

Description copied from class: ClientOptionsBase

Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

Overrides:

setProxyOptions in class NetClientOptions

Parameters:

proxyOptions - proxy options object

Returns:

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

setLocalAddress

public PgConnectOptions setLocalAddress(String localAddress)

Description copied from class: ClientOptionsBase

Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.

Overrides:

setLocalAddress in class NetClientOptions

Parameters:

localAddress - the local address

Returns:

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

setUseAlpn

public PgConnectOptions setUseAlpn(boolean useAlpn)

Description copied from class: TCPSSLOptions

Set the ALPN usage.

Overrides:

setUseAlpn in class NetClientOptions

Parameters:

useAlpn - true when Application-Layer Protocol Negotiation should be used

setSslEngineOptions

public PgConnectOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)

Description copied from class: TCPSSLOptions

Set to use SSL engine implementation to use.

Overrides:

setSslEngineOptions in class NetClientOptions

Parameters:

sslEngineOptions - the ssl engine to use

Returns:

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

setJdkSslEngineOptions

public PgConnectOptions setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)

Overrides:

setJdkSslEngineOptions in class NetClientOptions

setOpenSslEngineOptions

public PgConnectOptions setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)

Overrides:

setOpenSslEngineOptions in class NetClientOptions

setReusePort

public PgConnectOptions 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 NetClientOptions

Parameters:

reusePort - the value of reuse port

Returns:

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

setTcpFastOpen

public PgConnectOptions setTcpFastOpen(boolean tcpFastOpen)

Description copied from class: TCPSSLOptions

Enable the TCP_FASTOPEN option - only with linux native transport.

Overrides:

setTcpFastOpen in class NetClientOptions

Parameters:

tcpFastOpen - the fast open value

setTcpCork

public PgConnectOptions setTcpCork(boolean tcpCork)

Description copied from class: TCPSSLOptions

Enable the TCP_CORK option - only with linux native transport.

Overrides:

setTcpCork in class NetClientOptions

Parameters:

tcpCork - the cork value

setTcpQuickAck

public PgConnectOptions setTcpQuickAck(boolean tcpQuickAck)

Description copied from class: TCPSSLOptions

Enable the TCP_QUICKACK option - only with linux native transport.

Overrides:

setTcpQuickAck in class NetClientOptions

Parameters:

tcpQuickAck - the quick ack value

setEnabledSecureTransportProtocols

public PgConnectOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)

Description copied from class: TCPSSLOptions

Sets the list of enabled SSL/TLS protocols.

Overrides:

setEnabledSecureTransportProtocols in class NetClientOptions

Parameters:

enabledSecureTransportProtocols - the SSL/TLS protocols to enable

Returns:

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

setSslHandshakeTimeout

public PgConnectOptions setSslHandshakeTimeout(long sslHandshakeTimeout)

Description copied from class: TCPSSLOptions

Set the SSL handshake timeout, default time unit is seconds.

Overrides:

setSslHandshakeTimeout in class NetClientOptions

Parameters:

sslHandshakeTimeout - the SSL handshake timeout to set, in milliseconds

Returns:

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

setSslHandshakeTimeoutUnit

public PgConnectOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)

Description copied from class: TCPSSLOptions

Set the SSL handshake timeout unit. If not specified, default is seconds.

Overrides:

setSslHandshakeTimeoutUnit in class NetClientOptions

Parameters:

sslHandshakeTimeoutUnit - specify time unit.

Returns:

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

setTracingPolicy

public PgConnectOptions setTracingPolicy(TracingPolicy tracingPolicy)

Description copied from class: SqlConnectOptions

Set the tracing policy for the client behavior when Vert.x has tracing enabled.

Overrides:

setTracingPolicy in class SqlConnectOptions

Parameters:

tracingPolicy - the tracing policy

Returns:

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

init

protected void init()

Initialize with the default options.

Overrides:

init in class SqlConnectOptions

toJson

public JsonObject toJson()

Description copied from class: ClientOptionsBase

Convert to JSON

Overrides:

toJson in class SqlConnectOptions

Returns:

the JSON

getSocketAddress

public SocketAddress getSocketAddress()

Overrides:

getSocketAddress in class SqlConnectOptions

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isUsingDomainSocket

public boolean isUsingDomainSocket()

Overrides:

isUsingDomainSocket in class SqlConnectOptions

merge

public PgConnectOptions merge(JsonObject other)

Description copied from class: SqlConnectOptions

Returns new options created after this object and merged with the other json config.

Overrides:

merge in class SqlConnectOptions

Parameters:

other - the other JSON object

Returns:

new options created after this object and merged with the other json config