software.amazon.jdbc

Class HikariPooledConnectionProvider

java.lang.Object

software.amazon.jdbc.HikariPooledConnectionProvider

All Implemented Interfaces:

CanReleaseResources, ConnectionProvider, PooledConnectionProvider

public class HikariPooledConnectionProvider
extends java.lang.Object
implements PooledConnectionProvider, CanReleaseResources

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Map<java.lang.String,HostSelector>	acceptedStrategies
protected AcceptsUrlFunc	acceptsUrlFunc
protected LeastConnectionsHostSelector	leastConnectionsHostSelector
protected HikariPoolConfigurator	poolConfigurator
protected static long	poolExpirationCheckNanos
protected HikariPoolMapping	poolMapping
protected static RdsUtils	rdsUtils

Constructor Summary

Constructors

Constructor and Description
HikariPooledConnectionProvider(HikariPoolConfigurator hikariPoolConfigurator) HikariPooledConnectionProvider constructor.
HikariPooledConnectionProvider(HikariPoolConfigurator hikariPoolConfigurator, HikariPoolMapping mapping) HikariPooledConnectionProvider constructor.
HikariPooledConnectionProvider(HikariPoolConfigurator hikariPoolConfigurator, HikariPoolMapping mapping, AcceptsUrlFunc acceptsUrlFunc, long poolExpirationNanos, long poolCleanupNanos) HikariPooledConnectionProvider constructor.
HikariPooledConnectionProvider(HikariPoolConfigurator hikariPoolConfigurator, HikariPoolMapping mapping, long poolExpirationNanos, long poolCleanupNanos) HikariPooledConnectionProvider constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptsStrategy(@NonNull HostRole role, @NonNull java.lang.String strategy) Indicates whether the selection strategy is supported by the connection provider.
boolean	acceptsUrl(@NonNull java.lang.String protocol, @NonNull HostSpec hostSpec, @NonNull java.util.Properties props) Indicates whether this ConnectionProvider can provide connections for the given host and properties.
protected void	configurePool(com.zaxxer.hikari.HikariConfig config, java.lang.String protocol, HostSpec hostSpec, java.util.Properties connectionProps, @NonNull TargetDriverDialect targetDriverDialect) Configures the default required settings for the internal connection pool.
java.sql.Connection	connect(@NonNull java.lang.String protocol, @NonNull Dialect dialect, @NonNull TargetDriverDialect targetDriverDialect, @NonNull HostSpec hostSpec, @NonNull java.util.Properties props) Called once per connection that needs to be created.
int	getHostCount() Returns the number of active connection pools.
java.util.Set<java.lang.String>	getHosts() Returns a set containing every host URL for which there are one or more connection pool(s).
HostSpec	getHostSpecByStrategy(@NonNull java.util.List<HostSpec> hosts, @NonNull HostRole role, @NonNull java.lang.String strategy, @Nullable java.util.Properties props) Return a reader or a writer node using the specified strategy.
java.util.Set<Pair>	getKeys() Returns a set containing every key associated with an active connection pool.
protected java.lang.String	getPoolKey(HostSpec hostSpec, java.util.Properties props)
java.lang.String	getTargetName()
void	logConnections() Logs information for every active connection pool.
void	releaseResources() An object that implements this interface should release all acquired resources assuming it may be disposed at any time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

acceptedStrategies

protected static final java.util.Map<java.lang.String,HostSelector> acceptedStrategies

rdsUtils

protected static final RdsUtils rdsUtils

poolExpirationCheckNanos

protected static long poolExpirationCheckNanos

poolConfigurator

protected final HikariPoolConfigurator poolConfigurator

poolMapping

protected final HikariPoolMapping poolMapping

acceptsUrlFunc

protected final AcceptsUrlFunc acceptsUrlFunc

leastConnectionsHostSelector

protected final LeastConnectionsHostSelector leastConnectionsHostSelector

Constructor Detail

HikariPooledConnectionProvider

public HikariPooledConnectionProvider(HikariPoolConfigurator hikariPoolConfigurator)

HikariPooledConnectionProvider constructor. This class can be passed to Driver.setCustomConnectionProvider(ConnectionProvider) to enable internal connection pools for each database instance in a cluster. By maintaining internal connection pools, the driver can improve performance by reusing old Connection objects.

Parameters:

hikariPoolConfigurator - a function that returns a HikariConfig with specific Hikari configurations. By default, the HikariPooledConnectionProvider will configure the jdbcUrl, exceptionOverrideClassName, username, and password. Any additional configuration should be defined by passing in this parameter. If no additional configuration is desired, pass in a HikariPoolConfigurator that returns an empty HikariConfig.

HikariPooledConnectionProvider

public HikariPooledConnectionProvider(HikariPoolConfigurator hikariPoolConfigurator,
                                      HikariPoolMapping mapping)

HikariPooledConnectionProvider constructor. This class can be passed to Driver.setCustomConnectionProvider(ConnectionProvider) to enable internal connection pools for each database instance in a cluster. By maintaining internal connection pools, the driver can improve performance by reusing old Connection objects.

Parameters:

hikariPoolConfigurator - a function that returns a HikariConfig with specific Hikari configurations. By default, the HikariPooledConnectionProvider will configure the jdbcUrl, exceptionOverrideClassName, username, and password. Any additional configuration should be defined by passing in this parameter. If no additional configuration is desired, pass in a HikariPoolConfigurator that returns an empty HikariConfig.

mapping - a function that returns a String key used for the internal connection pool keys. An internal connection pool will be generated for each unique key returned by this function.

HikariPooledConnectionProvider

public HikariPooledConnectionProvider(HikariPoolConfigurator hikariPoolConfigurator,
                                      HikariPoolMapping mapping,
                                      long poolExpirationNanos,
                                      long poolCleanupNanos)

HikariPooledConnectionProvider constructor. This class can be passed to Driver.setCustomConnectionProvider(ConnectionProvider) to enable internal connection pools for each database instance in a cluster. By maintaining internal connection pools, the driver can improve performance by reusing old Connection objects.

Parameters:

hikariPoolConfigurator - a function that returns a HikariConfig with specific Hikari configurations. By default, the HikariPooledConnectionProvider will configure the jdbcUrl, exceptionOverrideClassName, username, and password. Any additional configuration should be defined by passing in this parameter. If no additional configuration is desired, pass in a HikariPoolConfigurator that returns an empty HikariConfig.

mapping - a function that returns a String key used for the internal connection pool keys. An internal connection pool will be generated for each unique key returned by this function.

poolExpirationNanos - the amount of time that a pool should sit in the cache before being marked as expired for cleanup, in nanoseconds. Expired pools can still be used and will not be closed unless there are no active connections.

poolCleanupNanos - the interval defining how often expired connection pools should be cleaned up, in nanoseconds. Note that expired pools will not be closed unless there are no active connections.

HikariPooledConnectionProvider

public HikariPooledConnectionProvider(HikariPoolConfigurator hikariPoolConfigurator,
                                      HikariPoolMapping mapping,
                                      AcceptsUrlFunc acceptsUrlFunc,
                                      long poolExpirationNanos,
                                      long poolCleanupNanos)

HikariPooledConnectionProvider constructor. This class can be passed to Driver.setCustomConnectionProvider(ConnectionProvider) to enable internal connection pools for each database instance in a cluster. By maintaining internal connection pools, the driver can improve performance by reusing old Connection objects.

Parameters:

hikariPoolConfigurator - a function that returns a HikariConfig with specific Hikari configurations. By default, the HikariPooledConnectionProvider will configure the jdbcUrl, exceptionOverrideClassName, username, and password. Any additional configuration should be defined by passing in this parameter. If no additional configuration is desired, pass in a HikariPoolConfigurator that returns an empty HikariConfig.

mapping - a function that returns a String key used for the internal connection pool keys. An internal connection pool will be generated for each unique key returned by this function.

acceptsUrlFunc - a function that defines when an internal connection pool should be created for a requested connection. An internal connection pool will be created when the connect pipeline is being executed and this function returns true.

poolExpirationNanos - the amount of time that a pool should sit in the cache before being marked as expired for cleanup, in nanoseconds. Expired pools can still be used and will not be closed unless there are no active connections.

poolCleanupNanos - the interval defining how often expired connection pools should be cleaned up, in nanoseconds. Note that expired pools will not be closed unless there are no active connections.

Method Detail

acceptsUrl

public boolean acceptsUrl(@NonNull java.lang.String protocol,
                          @NonNull HostSpec hostSpec,
                          @NonNull java.util.Properties props)

Description copied from interface: ConnectionProvider

Indicates whether this ConnectionProvider can provide connections for the given host and properties. Some ConnectionProvider implementations may not be able to handle certain URL types or properties.

Specified by:

acceptsUrl in interface ConnectionProvider

Parameters:

protocol - the connection protocol (example "jdbc:mysql://")

hostSpec - the HostSpec containing the host-port information for the host to connect to

props - the Properties to use for the connection

Returns:

true if this ConnectionProvider can provide connections for the given URL, otherwise return false

acceptsStrategy

public boolean acceptsStrategy(@NonNull HostRole role,
                               @NonNull java.lang.String strategy)

Description copied from interface: ConnectionProvider

Indicates whether the selection strategy is supported by the connection provider.

Specified by:

acceptsStrategy in interface ConnectionProvider

Parameters:

role - determines if the connection provider should return a reader host or a writer host

strategy - the selection strategy to use

Returns:

whether the strategy is supported

getHostSpecByStrategy

public HostSpec getHostSpecByStrategy(@NonNull java.util.List<HostSpec> hosts,
                                      @NonNull HostRole role,
                                      @NonNull java.lang.String strategy,
                                      @Nullable java.util.Properties props)
                               throws java.sql.SQLException

Description copied from interface: ConnectionProvider

Return a reader or a writer node using the specified strategy. This method should raise an UnsupportedOperationException if the specified strategy is unsupported.

Specified by:

getHostSpecByStrategy in interface ConnectionProvider

Parameters:

hosts - the list of HostSpec to select from

role - determines if the connection provider should return a writer or a reader

strategy - the strategy determining how the HostSpec should be selected, e.g., random or round-robin

props - any properties that are required by the provided strategy to select a host

Returns:

the HostSpec selected using the specified strategy

Throws:

java.sql.SQLException - if an error occurred while returning the hosts

connect

public java.sql.Connection connect(@NonNull java.lang.String protocol,
                                   @NonNull Dialect dialect,
                                   @NonNull TargetDriverDialect targetDriverDialect,
                                   @NonNull HostSpec hostSpec,
                                   @NonNull java.util.Properties props)
                            throws java.sql.SQLException

Description copied from interface: ConnectionProvider

Called once per connection that needs to be created.

Specified by:

connect in interface ConnectionProvider

Parameters:

protocol - the connection protocol (example "jdbc:mysql://")

dialect - the database dialect

targetDriverDialect - the target driver dialect

hostSpec - the HostSpec containing the host-port information for the host to connect to

props - the Properties to use for the connection

Returns:

Connection resulting from the given connection information

Throws:

java.sql.SQLException - if an error occurs

getPoolKey

protected java.lang.String getPoolKey(HostSpec hostSpec,
                                      java.util.Properties props)

releaseResources

public void releaseResources()

Description copied from interface: CanReleaseResources

An object that implements this interface should release all acquired resources assuming it may be disposed at any time. This method may be called more than once.

Calling this method does NOT mean that an object is disposing and there won't be any further calls. An object should keep its functional state after calling this method.

Specified by:

releaseResources in interface CanReleaseResources

configurePool

protected void configurePool(com.zaxxer.hikari.HikariConfig config,
                             java.lang.String protocol,
                             HostSpec hostSpec,
                             java.util.Properties connectionProps,
                             @NonNull TargetDriverDialect targetDriverDialect)

Configures the default required settings for the internal connection pool.

Parameters:

config - the HikariConfig to configure. By default, this method sets the jdbcUrl, exceptionOverrideClassName, username, and password. The HikariConfig passed to this method should be created via a HikariPoolConfigurator, which allows the user to specify any additional configuration properties.

protocol - the driver protocol that should be used to form connections

hostSpec - the host details used to form the connection

connectionProps - the connection properties

targetDriverDialect - the target driver dialect TargetDriverDialect

getHostCount

public int getHostCount()

Returns the number of active connection pools.

Returns:

the number of active connection pools

getHosts

public java.util.Set<java.lang.String> getHosts()

Returns a set containing every host URL for which there are one or more connection pool(s).

Returns:

a set containing every host URL for which there are one or more connection pool(s).

getKeys

public java.util.Set<Pair> getKeys()

Returns a set containing every key associated with an active connection pool.

Returns:

a set containing every key associated with an active connection pool

getTargetName

public java.lang.String getTargetName()

Specified by:

getTargetName in interface ConnectionProvider

logConnections

public void logConnections()

Logs information for every active connection pool.