public class HikariDataSource extends HikariConfig implements DataSource, Closeable
Constructor and Description |
---|
HikariDataSource()
Default constructor.
|
HikariDataSource(HikariConfig configuration)
Construct a HikariDataSource with the specified configuration.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Shutdown the DataSource and its associated pool.
|
void |
evictConnection(Connection connection)
Evict a connection from the pool.
|
Connection |
getConnection() |
Connection |
getConnection(String username,
String password) |
HikariConfigMXBean |
getHikariConfigMXBean()
Get the
HikariConfigMXBean for this HikariDataSource instance. |
HikariPoolMXBean |
getHikariPoolMXBean()
Get the
HikariPoolMXBean for this HikariDataSource instance. |
int |
getLoginTimeout() |
PrintWriter |
getLogWriter() |
Logger |
getParentLogger() |
boolean |
isClosed()
Determine whether the HikariDataSource has been closed.
|
boolean |
isWrapperFor(Class<?> iface) |
void |
resumePool()
Deprecated.
Call the
HikariPoolMXBean#resumePool() method on the HikariPoolMXBean
obtained by #getHikariPoolMXBean() or JMX lookup. |
void |
setHealthCheckRegistry(Object healthCheckRegistry)
Set a Codahale HealthCheckRegistry to use for HikariCP.
|
void |
setLoginTimeout(int seconds) |
void |
setLogWriter(PrintWriter out) |
void |
setMetricRegistry(Object metricRegistry)
Set a Codahale MetricRegistry to use for HikariCP.
|
void |
setMetricsTrackerFactory(MetricsTrackerFactory metricsTrackerFactory) |
void |
shutdown()
Deprecated.
This method has been deprecated, please use
close() instead |
void |
suspendPool()
Deprecated.
Call the
HikariPoolMXBean#suspendPool() method on the HikariPoolMXBean
obtained by #getHikariPoolMXBean() or JMX lookup. |
String |
toString() |
<T> T |
unwrap(Class<T> iface) |
addDataSourceProperty, addHealthCheckProperty, copyState, getCatalog, getConnectionInitSql, getConnectionTestQuery, getConnectionTimeout, getDataSource, getDataSourceClassName, getDataSourceJNDI, getDataSourceProperties, getDriverClassName, getHealthCheckProperties, getHealthCheckRegistry, getIdleTimeout, getInitializationFailTimeout, getJdbcUrl, getLeakDetectionThreshold, getMaximumPoolSize, getMaxLifetime, getMetricRegistry, getMetricsTrackerFactory, getMinimumIdle, getPassword, getPoolName, getScheduledExecutor, getScheduledExecutorService, getSchema, getThreadFactory, getTransactionIsolation, getUsername, getValidationTimeout, isAllowPoolSuspension, isAutoCommit, isInitializationFailFast, isIsolateInternalQueries, isJdbc4ConnectionTest, isReadOnly, isRegisterMbeans, setAllowPoolSuspension, setAutoCommit, setCatalog, setConnectionInitSql, setConnectionTestQuery, setConnectionTimeout, setDataSource, setDataSourceClassName, setDataSourceJNDI, setDataSourceProperties, setDriverClassName, setHealthCheckProperties, setIdleTimeout, setInitializationFailFast, setInitializationFailTimeout, setIsolateInternalQueries, setJdbc4ConnectionTest, setJdbcUrl, setLeakDetectionThreshold, setMaximumPoolSize, setMaxLifetime, setMinimumIdle, setPassword, setPoolName, setReadOnly, setRegisterMbeans, setScheduledExecutor, setScheduledExecutorService, setSchema, setThreadFactory, setTransactionIsolation, setUsername, setValidationTimeout, validate
public HikariDataSource()
HikariDataSource(HikariConfig)
will
result in getConnection()
performance that is slightly lower
due to lazy initialization checks.public HikariDataSource(HikariConfig configuration)
configuration
- a HikariConfig instancepublic Connection getConnection() throws SQLException
getConnection
in interface DataSource
SQLException
public Connection getConnection(String username, String password) throws SQLException
getConnection
in interface DataSource
SQLException
public PrintWriter getLogWriter() throws SQLException
getLogWriter
in interface CommonDataSource
SQLException
public void setLogWriter(PrintWriter out) throws SQLException
setLogWriter
in interface CommonDataSource
SQLException
public void setLoginTimeout(int seconds) throws SQLException
setLoginTimeout
in interface CommonDataSource
SQLException
public int getLoginTimeout() throws SQLException
getLoginTimeout
in interface CommonDataSource
SQLException
public Logger getParentLogger() throws SQLFeatureNotSupportedException
getParentLogger
in interface CommonDataSource
SQLFeatureNotSupportedException
public <T> T unwrap(Class<T> iface) throws SQLException
unwrap
in interface Wrapper
SQLException
public boolean isWrapperFor(Class<?> iface) throws SQLException
isWrapperFor
in interface Wrapper
SQLException
public void setMetricRegistry(Object metricRegistry)
setMetricRegistry
in class HikariConfig
metricRegistry
- the Codahale MetricRegistry to setpublic void setMetricsTrackerFactory(MetricsTrackerFactory metricsTrackerFactory)
setMetricsTrackerFactory
in class HikariConfig
public void setHealthCheckRegistry(Object healthCheckRegistry)
setHealthCheckRegistry
in class HikariConfig
healthCheckRegistry
- the Codahale HealthCheckRegistry to setpublic HikariPoolMXBean getHikariPoolMXBean()
HikariPoolMXBean
for this HikariDataSource instance. If this method is called on
a HikariDataSource
that has been constructed without a HikariConfig
instance,
and before an initial call to #getConnection()
, the return value will be null
.HikariPoolMXBean
instance, or null
.public HikariConfigMXBean getHikariConfigMXBean()
HikariConfigMXBean
for this HikariDataSource instance.HikariConfigMXBean
instance.public void evictConnection(Connection connection)
connection
- the connection to evict from the pool@Deprecated public void suspendPool()
HikariPoolMXBean#suspendPool()
method on the HikariPoolMXBean
obtained by #getHikariPoolMXBean()
or JMX lookup.getConnection()
will block indefinitely until resumePool()
is called.@Deprecated public void resumePool()
HikariPoolMXBean#resumePool()
method on the HikariPoolMXBean
obtained by #getHikariPoolMXBean()
or JMX lookup.public void close()
close
in interface Closeable
close
in interface AutoCloseable
public boolean isClosed()
@Deprecated public void shutdown()
close()
insteadCopyright © 2017 Zaxxer.com. All Rights Reserved.