software.amazon.jdbc

Interface HikariPoolMapping

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface HikariPoolMapping

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey(HostSpec hostSpec, java.util.Properties originalProps) A function that can optionally be passed to the HikariPooledConnectionProvider constructor to define a mapping from the given parameters to an internal connection pool key.

Method Detail

getKey

java.lang.String getKey(HostSpec hostSpec,
                        java.util.Properties originalProps)

A function that can optionally be passed to the HikariPooledConnectionProvider constructor to define a mapping from the given parameters to an internal connection pool key.

By default, the HikariPooledConnectionProvider will create an internal connection pool for each database instance in the database cluster. This function allows you to define your own key mapping if the default behavior does not suit your needs. For example, if your application establishes multiple connections to the same instance under different users, you can implement this function to return a key that incorporates the HostSpec URL and the user specified in the properties. The resulting HikariPooledConnectionProvider will then create a new internal connection pool for each instance-user combination.

Parameters:

hostSpec - the host details for the internal connection pool

originalProps - the properties specified for the original connection through DriverManager.getConnection(String, Properties)

Returns:

the key that should be used for the given host and properties. An internal connection pool will be created for each unique key returned by this function.