Package org.quartz.utils

Class HikariCpPoolingConnectionProvider

java.lang.Object

org.quartz.utils.HikariCpPoolingConnectionProvider

All Implemented Interfaces:

ConnectionProvider, PoolingConnectionProvider

public class HikariCpPoolingConnectionProvider
extends java.lang.Object
implements PoolingConnectionProvider

A ConnectionProvider implementation that creates its own pool of connections.

This class uses HikariCP (https://brettwooldridge.github.io/HikariCP/) as the underlying pool implementation.

Author:

Ludovic Orban

See Also:

DBConnectionManager, ConnectionProvider

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	POOLING_PROVIDER_NAME	This pooling provider name.

Fields inherited from interface org.quartz.utils.PoolingConnectionProvider

DB_DRIVER, DB_MAX_CONNECTIONS, DB_PASSWORD, DB_URL, DB_USER, DB_VALIDATION_QUERY, DEFAULT_DB_MAX_CONNECTIONS, POOLING_PROVIDER, POOLING_PROVIDER_C3P0, POOLING_PROVIDER_HIKARICP

Constructor Summary

Constructors

Constructor	Description
HikariCpPoolingConnectionProvider(java.lang.String dbDriver, java.lang.String dbURL, java.lang.String dbUser, java.lang.String dbPassword, int maxConnections, java.lang.String dbValidationQuery)
HikariCpPoolingConnectionProvider(java.util.Properties config)	Create a connection pool using the given properties.

Method Summary

Modifier and Type	Method	Description
java.sql.Connection	getConnection()
com.zaxxer.hikari.HikariDataSource	getDataSource()	Get the HikariCP HikariDataSource created during initialization.
void	initialize()
void	shutdown()

Methods inherited from class java.lang.Object

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

Field Detail

POOLING_PROVIDER_NAME

public static final java.lang.String POOLING_PROVIDER_NAME

This pooling provider name.

See Also:

Constant Field Values

Constructor Detail

HikariCpPoolingConnectionProvider

public HikariCpPoolingConnectionProvider(java.lang.String dbDriver,
                                         java.lang.String dbURL,
                                         java.lang.String dbUser,
                                         java.lang.String dbPassword,
                                         int maxConnections,
                                         java.lang.String dbValidationQuery)
                                  throws java.sql.SQLException,
                                         SchedulerException

Throws:

java.sql.SQLException

SchedulerException

HikariCpPoolingConnectionProvider

public HikariCpPoolingConnectionProvider(java.util.Properties config)
                                  throws SchedulerException,
                                         java.sql.SQLException

Create a connection pool using the given properties.

The properties passed should contain:

• PoolingConnectionProvider.DB_DRIVER- The database driver class name
• PoolingConnectionProvider.DB_URL- The database URL
• PoolingConnectionProvider.DB_USER- The database user
• PoolingConnectionProvider.DB_PASSWORD- The database password
• PoolingConnectionProvider.DB_MAX_CONNECTIONS- The maximum # connections in the pool, optional
• PoolingConnectionProvider.DB_VALIDATION_QUERY- The sql validation query, optional

Parameters:

config - configuration properties

Throws:

SchedulerException

java.sql.SQLException

Method Detail

getDataSource

public com.zaxxer.hikari.HikariDataSource getDataSource()

Get the HikariCP HikariDataSource created during initialization.

This can be used to set additional data source properties in a subclass's constructor.

Specified by:

getDataSource in interface PoolingConnectionProvider

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Specified by:

getConnection in interface ConnectionProvider

Returns:

connection managed by this provider

Throws:

java.sql.SQLException

shutdown

public void shutdown()
              throws java.sql.SQLException

Specified by:

shutdown in interface ConnectionProvider

Throws:

java.sql.SQLException

initialize

public void initialize()
                throws java.sql.SQLException

Specified by:

initialize in interface ConnectionProvider

Throws:

java.sql.SQLException