io.reactiverse.pgclient

Class PgPoolOptions

java.lang.Object

io.vertx.core.net.NetworkOptions

io.vertx.core.net.TCPSSLOptions

io.vertx.core.net.ClientOptionsBase

io.vertx.core.net.NetClientOptions

io.reactiverse.pgclient.PgConnectOptions

io.reactiverse.pgclient.PgPoolOptions

public class PgPoolOptions
extends PgConnectOptions

The options for configuring a connection pool.

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_SIZE The default maximum number of connections a client will pool = 4
static int	DEFAULT_MAX_WAIT_QUEUE_SIZE Default max wait queue size = -1 (unbounded)

Fields inherited from class io.reactiverse.pgclient.PgConnectOptions

DEFAULT_CACHE_PREPARED_STATEMENTS, DEFAULT_DATABASE, DEFAULT_HOST, DEFAULT_PASSWORD, DEFAULT_PIPELINING_LIMIT, DEFAULT_PORT, DEFAULT_SSLMODE, DEFAULT_USER

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_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
PgPoolOptions()
PgPoolOptions(io.vertx.core.json.JsonObject json)
PgPoolOptions(PgConnectOptions other)
PgPoolOptions(PgPoolOptions other)

Method Summary

Modifier and Type	Method and Description
PgPoolOptions	addCrlPath(String crlPath)
PgPoolOptions	addCrlValue(io.vertx.core.buffer.Buffer crlValue)
PgPoolOptions	addEnabledCipherSuite(String suite)
PgPoolOptions	addEnabledSecureTransportProtocol(String protocol)
boolean	equals(Object o)
static PgPoolOptions	fromEnv() Provide a PgPoolOptions configured with environment variables, if the environment variable is not set, then a default value will take precedence over this.
static PgPoolOptions	fromUri(String connectionUri) Provide a PgPoolOptions configured from a connection URI.
int	getMaxSize()
int	getMaxWaitQueueSize()
int	hashCode()
PgPoolOptions	setCachePreparedStatements(boolean cachePreparedStatements)
PgPoolOptions	setConnectTimeout(int connectTimeout)
PgPoolOptions	setDatabase(String database)
PgPoolOptions	setHost(String host)
PgPoolOptions	setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)
PgPoolOptions	setIdleTimeout(int idleTimeout)
PgPoolOptions	setJdkSslEngineOptions(io.vertx.core.net.JdkSSLEngineOptions sslEngineOptions)
PgPoolOptions	setKeyCertOptions(io.vertx.core.net.KeyCertOptions options)
PgPoolOptions	setKeyStoreOptions(io.vertx.core.net.JksOptions options)
PgPoolOptions	setLocalAddress(String localAddress)
PgPoolOptions	setLogActivity(boolean logEnabled)
PgPoolOptions	setMaxSize(int maxSize) Set the maximum pool size
PgPoolOptions	setMaxWaitQueueSize(int maxWaitQueueSize) Set the maximum connection request allowed in the wait queue, any requests beyond the max size will result in an failure.
PgPoolOptions	setMetricsName(String metricsName)
PgPoolOptions	setOpenSslEngineOptions(io.vertx.core.net.OpenSSLEngineOptions sslEngineOptions)
PgPoolOptions	setPassword(String password)
PgPoolOptions	setPemKeyCertOptions(io.vertx.core.net.PemKeyCertOptions options)
PgPoolOptions	setPemTrustOptions(io.vertx.core.net.PemTrustOptions options)
PgPoolOptions	setPfxKeyCertOptions(io.vertx.core.net.PfxOptions options)
PgPoolOptions	setPfxTrustOptions(io.vertx.core.net.PfxOptions options)
PgPoolOptions	setPipeliningLimit(int pipeliningLimit)
PgPoolOptions	setPort(int port)
PgPoolOptions	setProxyOptions(io.vertx.core.net.ProxyOptions proxyOptions)
PgPoolOptions	setReceiveBufferSize(int receiveBufferSize)
PgPoolOptions	setReconnectAttempts(int attempts)
PgPoolOptions	setReconnectInterval(long interval)
PgPoolOptions	setReuseAddress(boolean reuseAddress)
PgPoolOptions	setReusePort(boolean reusePort)
PgPoolOptions	setSendBufferSize(int sendBufferSize)
PgPoolOptions	setSoLinger(int soLinger)
PgPoolOptions	setSsl(boolean ssl)
PgPoolOptions	setSslEngineOptions(io.vertx.core.net.SSLEngineOptions sslEngineOptions)
PgPoolOptions	setSslMode(SslMode sslmode) Set SslMode for the client, this option can be used to provide different levels of secure protection.
PgPoolOptions	setTcpCork(boolean tcpCork)
PgPoolOptions	setTcpFastOpen(boolean tcpFastOpen)
PgPoolOptions	setTcpKeepAlive(boolean tcpKeepAlive)
PgPoolOptions	setTcpNoDelay(boolean tcpNoDelay)
PgPoolOptions	setTcpQuickAck(boolean tcpQuickAck)
PgPoolOptions	setTrafficClass(int trafficClass)
PgPoolOptions	setTrustAll(boolean trustAll)
PgPoolOptions	setTrustOptions(io.vertx.core.net.TrustOptions options)
PgPoolOptions	setTrustStoreOptions(io.vertx.core.net.JksOptions options)
PgPoolOptions	setUseAlpn(boolean useAlpn)
PgPoolOptions	setUsePooledBuffers(boolean usePooledBuffers)
PgPoolOptions	setUser(String user)
io.vertx.core.json.JsonObject	toJson()

Methods inherited from class io.reactiverse.pgclient.PgConnectOptions

getCachePreparedStatements, getDatabase, getHost, getPassword, getPipeliningLimit, getPort, getSslMode, getUser, isUsingDomainSocket, setEnabledSecureTransportProtocols

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

getHostnameVerificationAlgorithm, getReconnectAttempts, getReconnectInterval, removeEnabledSecureTransportProtocol, setIdleTimeoutUnit

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

public static final int DEFAULT_MAX_SIZE

The default maximum number of connections a client will pool = 4

See Also:

Constant Field Values

DEFAULT_MAX_WAIT_QUEUE_SIZE

public static final int DEFAULT_MAX_WAIT_QUEUE_SIZE

Default max wait queue size = -1 (unbounded)

See Also:

Constant Field Values

Constructor Detail

PgPoolOptions

public PgPoolOptions()

PgPoolOptions

public PgPoolOptions(io.vertx.core.json.JsonObject json)

PgPoolOptions

public PgPoolOptions(PgPoolOptions other)

PgPoolOptions

public PgPoolOptions(PgConnectOptions other)

Method Detail

fromUri

public static PgPoolOptions fromUri(String connectionUri)
                             throws IllegalArgumentException

Provide a PgPoolOptions configured from a connection URI.

Parameters:

connectionUri - the connection URI to configure from

Returns:

a PgPoolOptions parsed from the connection URI

Throws:

IllegalArgumentException - when the connectionUri is in an invalid format

fromEnv

public static PgPoolOptions fromEnv()

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

getMaxSize

public int getMaxSize()

Returns:

the maximum pool size

setMaxSize

public PgPoolOptions setMaxSize(int maxSize)

Set the maximum pool size

Parameters:

maxSize - the maximum pool size

Returns:

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

getMaxWaitQueueSize

public int getMaxWaitQueueSize()

Returns:

the maximum wait queue size

setMaxWaitQueueSize

public PgPoolOptions setMaxWaitQueueSize(int maxWaitQueueSize)

Set the maximum connection request allowed in the wait queue, any requests beyond the max size will result in an failure. If the value is set to a negative number then the queue will be unbounded.

Parameters:

maxWaitQueueSize - the maximum number of waiting requests

Returns:

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

setHost

public PgPoolOptions setHost(String host)

Overrides:

setHost in class PgConnectOptions

setPort

public PgPoolOptions setPort(int port)

Overrides:

setPort in class PgConnectOptions

setDatabase

public PgPoolOptions setDatabase(String database)

Overrides:

setDatabase in class PgConnectOptions

setUser

public PgPoolOptions setUser(String user)

Overrides:

setUser in class PgConnectOptions

setPassword

public PgPoolOptions setPassword(String password)

Overrides:

setPassword in class PgConnectOptions

setPipeliningLimit

public PgPoolOptions setPipeliningLimit(int pipeliningLimit)

Overrides:

setPipeliningLimit in class PgConnectOptions

setCachePreparedStatements

public PgPoolOptions setCachePreparedStatements(boolean cachePreparedStatements)

Overrides:

setCachePreparedStatements in class PgConnectOptions

setSslMode

public PgPoolOptions setSslMode(SslMode sslmode)

Description copied from class: PgConnectOptions

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

Overrides:

setSslMode in class PgConnectOptions

Parameters:

sslmode - the value of sslmode

Returns:

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

setSendBufferSize

public PgPoolOptions setSendBufferSize(int sendBufferSize)

Overrides:

setSendBufferSize in class PgConnectOptions

setReceiveBufferSize

public PgPoolOptions setReceiveBufferSize(int receiveBufferSize)

Overrides:

setReceiveBufferSize in class PgConnectOptions

setReuseAddress

public PgPoolOptions setReuseAddress(boolean reuseAddress)

Overrides:

setReuseAddress in class PgConnectOptions

setTrafficClass

public PgPoolOptions setTrafficClass(int trafficClass)

Overrides:

setTrafficClass in class PgConnectOptions

setTcpNoDelay

public PgPoolOptions setTcpNoDelay(boolean tcpNoDelay)

Overrides:

setTcpNoDelay in class PgConnectOptions

setTcpKeepAlive

public PgPoolOptions setTcpKeepAlive(boolean tcpKeepAlive)

Overrides:

setTcpKeepAlive in class PgConnectOptions

setSoLinger

public PgPoolOptions setSoLinger(int soLinger)

Overrides:

setSoLinger in class PgConnectOptions

setUsePooledBuffers

public PgPoolOptions setUsePooledBuffers(boolean usePooledBuffers)

Overrides:

setUsePooledBuffers in class PgConnectOptions

setIdleTimeout

public PgPoolOptions setIdleTimeout(int idleTimeout)

Overrides:

setIdleTimeout in class PgConnectOptions

setSsl

public PgPoolOptions setSsl(boolean ssl)

Overrides:

setSsl in class PgConnectOptions

setKeyCertOptions

public PgPoolOptions setKeyCertOptions(io.vertx.core.net.KeyCertOptions options)

Overrides:

setKeyCertOptions in class PgConnectOptions

setKeyStoreOptions

public PgPoolOptions setKeyStoreOptions(io.vertx.core.net.JksOptions options)

Overrides:

setKeyStoreOptions in class PgConnectOptions

setPfxKeyCertOptions

public PgPoolOptions setPfxKeyCertOptions(io.vertx.core.net.PfxOptions options)

Overrides:

setPfxKeyCertOptions in class PgConnectOptions

setPemKeyCertOptions

public PgPoolOptions setPemKeyCertOptions(io.vertx.core.net.PemKeyCertOptions options)

Overrides:

setPemKeyCertOptions in class PgConnectOptions

setTrustOptions

public PgPoolOptions setTrustOptions(io.vertx.core.net.TrustOptions options)

Overrides:

setTrustOptions in class PgConnectOptions

setTrustStoreOptions

public PgPoolOptions setTrustStoreOptions(io.vertx.core.net.JksOptions options)

Overrides:

setTrustStoreOptions in class PgConnectOptions

setPemTrustOptions

public PgPoolOptions setPemTrustOptions(io.vertx.core.net.PemTrustOptions options)

Overrides:

setPemTrustOptions in class PgConnectOptions

setPfxTrustOptions

public PgPoolOptions setPfxTrustOptions(io.vertx.core.net.PfxOptions options)

Overrides:

setPfxTrustOptions in class PgConnectOptions

addEnabledCipherSuite

public PgPoolOptions addEnabledCipherSuite(String suite)

Overrides:

addEnabledCipherSuite in class PgConnectOptions

addEnabledSecureTransportProtocol

public PgPoolOptions addEnabledSecureTransportProtocol(String protocol)

Overrides:

addEnabledSecureTransportProtocol in class PgConnectOptions

addCrlPath

public PgPoolOptions addCrlPath(String crlPath)
                         throws NullPointerException

Overrides:

addCrlPath in class PgConnectOptions

Throws:

NullPointerException

addCrlValue

public PgPoolOptions addCrlValue(io.vertx.core.buffer.Buffer crlValue)
                          throws NullPointerException

Overrides:

addCrlValue in class PgConnectOptions

Throws:

NullPointerException

setTrustAll

public PgPoolOptions setTrustAll(boolean trustAll)

Overrides:

setTrustAll in class PgConnectOptions

setConnectTimeout

public PgPoolOptions setConnectTimeout(int connectTimeout)

Overrides:

setConnectTimeout in class PgConnectOptions

setMetricsName

public PgPoolOptions setMetricsName(String metricsName)

Overrides:

setMetricsName in class PgConnectOptions

setReconnectAttempts

public PgPoolOptions setReconnectAttempts(int attempts)

Overrides:

setReconnectAttempts in class PgConnectOptions

setHostnameVerificationAlgorithm

public PgPoolOptions setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)

Overrides:

setHostnameVerificationAlgorithm in class PgConnectOptions

setLogActivity

public PgPoolOptions setLogActivity(boolean logEnabled)

Overrides:

setLogActivity in class PgConnectOptions

setReconnectInterval

public PgPoolOptions setReconnectInterval(long interval)

Overrides:

setReconnectInterval in class PgConnectOptions

setProxyOptions

public PgPoolOptions setProxyOptions(io.vertx.core.net.ProxyOptions proxyOptions)

Overrides:

setProxyOptions in class PgConnectOptions

setLocalAddress

public PgPoolOptions setLocalAddress(String localAddress)

Overrides:

setLocalAddress in class PgConnectOptions

setUseAlpn

public PgPoolOptions setUseAlpn(boolean useAlpn)

Overrides:

setUseAlpn in class PgConnectOptions

setSslEngineOptions

public PgPoolOptions setSslEngineOptions(io.vertx.core.net.SSLEngineOptions sslEngineOptions)

Overrides:

setSslEngineOptions in class PgConnectOptions

setJdkSslEngineOptions

public PgPoolOptions setJdkSslEngineOptions(io.vertx.core.net.JdkSSLEngineOptions sslEngineOptions)

Overrides:

setJdkSslEngineOptions in class PgConnectOptions

setOpenSslEngineOptions

public PgPoolOptions setOpenSslEngineOptions(io.vertx.core.net.OpenSSLEngineOptions sslEngineOptions)

Overrides:

setOpenSslEngineOptions in class PgConnectOptions

setReusePort

public PgPoolOptions setReusePort(boolean reusePort)

Overrides:

setReusePort in class PgConnectOptions

setTcpFastOpen

public PgPoolOptions setTcpFastOpen(boolean tcpFastOpen)

Overrides:

setTcpFastOpen in class PgConnectOptions

setTcpCork

public PgPoolOptions setTcpCork(boolean tcpCork)

Overrides:

setTcpCork in class PgConnectOptions

setTcpQuickAck

public PgPoolOptions setTcpQuickAck(boolean tcpQuickAck)

Overrides:

setTcpQuickAck in class PgConnectOptions

toJson

public io.vertx.core.json.JsonObject toJson()

Overrides:

toJson in class PgConnectOptions

equals

public boolean equals(Object o)

Overrides:

equals in class PgConnectOptions

hashCode

public int hashCode()

Overrides:

hashCode in class PgConnectOptions