manifold.sql.rt.api

Interface ConnectionProvider

All Known Implementing Classes:

HikariConnectionProvider

public interface ConnectionProvider

Implementors provide JDBC connections for all manifold-sql JDBC operations.

Method Summary

Modifier and Type	Method and Description
void	closeAll() Close all resources.
void	closeDataSource(DbConfig dbconfig) Close the data source from which connections are made.
java.sql.Connection	getConnection(DbConfig dbConfig) Provides a JDBC connection configured with the provided DbConfing.
java.sql.Connection	getConnection(java.lang.String configName, java.lang.Class<?> classContext) Provides a JDBC connection corresponding with the configName DbConfig and optional classContext.

Method Detail

getConnection

java.sql.Connection getConnection(java.lang.String configName,
                                  java.lang.Class<?> classContext)

Provides a JDBC connection corresponding with the configName DbConfig and optional classContext. A standard implementation sources the configName DbConfig in the following order:

Consult DbConfigProvider implementations From <configName>.dbconfig file in the /config subdir of the current directory (runtime only) From <configName>.dbconfig file in the current directory (runtime only) From <configName>.dbconfig resource file in the <module-name>.config package (JDK 11+) From <configName>.dbconfig resource file in the config package (JDK 8+)

This method is exclusive to runtime use.

Parameters:

configName - The name of the DbConfig. Does not include a file extension.

classContext - The class initiating the connection. Used for context when searching for the DbConfig as a resource file.

Returns:

The JDBC connection

getConnection

java.sql.Connection getConnection(DbConfig dbConfig)
                           throws java.sql.SQLException

Provides a JDBC connection configured with the provided DbConfing.

This method is exclusive to build-time use.

Parameters:

dbConfig - The configuration for the connection

Returns:

The JDBC connection

Throws:

java.sql.SQLException

closeDataSource

void closeDataSource(DbConfig dbconfig)

Close the data source from which connections are made.

This should be called only from IDE environments where the dbconfig can change while developing.

Parameters:

dbconfig - The DbConfig corresponding with the data source.

closeAll

void closeAll()

Close all resources.