org.hibernate.hikaricp.internal

Class HikariCPConnectionProvider

java.lang.Object

org.hibernate.hikaricp.internal.HikariCPConnectionProvider

All Implemented Interfaces:

Serializable, ConnectionProvider, Service, Configurable, Stoppable, Wrapped

public class HikariCPConnectionProvider
extends Object
implements ConnectionProvider, Configurable, Stoppable

HikariCP Connection provider for Hibernate.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HikariCPConnectionProvider()

Method Summary

Modifier and Type	Method and Description
void	closeConnection(Connection conn) Release a connection from Hibernate use.
void	configure(Map props) Configure the service.
Connection	getConnection() Obtains a connection for Hibernate use according to the underlying strategy of this provider.
boolean	isUnwrappableAs(Class unwrapType) Can this wrapped service be unwrapped as the indicated type?
void	stop() Stop phase notification
boolean	supportsAggressiveRelease() Does this connection provider support aggressive release of JDBC connections and re-acquisition of those connections (if need be) later? This is used in conjunction with AvailableSettings.RELEASE_CONNECTIONS to aggressively release JDBC connections.
<T> T	unwrap(Class<T> unwrapType) Unproxy the service proxy

Methods inherited from class java.lang.Object

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

Constructor Detail

HikariCPConnectionProvider

public HikariCPConnectionProvider()

Method Detail

configure

public void configure(Map props)
               throws HibernateException

Description copied from interface: Configurable

Configure the service.

Specified by:

configure in interface Configurable

Parameters:

props - The configuration properties.

Throws:

HibernateException

getConnection

public Connection getConnection()
                         throws SQLException

Description copied from interface: ConnectionProvider

Obtains a connection for Hibernate use according to the underlying strategy of this provider.

Specified by:

getConnection in interface ConnectionProvider

Returns:

The obtained JDBC connection

Throws:

SQLException - Indicates a problem opening a connection

closeConnection

public void closeConnection(Connection conn)
                     throws SQLException

Description copied from interface: ConnectionProvider

Release a connection from Hibernate use.

Specified by:

closeConnection in interface ConnectionProvider

Parameters:

conn - The JDBC connection to release

Throws:

SQLException - Indicates a problem closing the connection

supportsAggressiveRelease

public boolean supportsAggressiveRelease()

Description copied from interface: ConnectionProvider

Does this connection provider support aggressive release of JDBC connections and re-acquisition of those connections (if need be) later?

This is used in conjunction with AvailableSettings.RELEASE_CONNECTIONS to aggressively release JDBC connections. However, the configured ConnectionProvider must support re-acquisition of the same underlying connection for that semantic to work.

Typically, this is only true in managed environments where a container tracks connections by transaction or thread. Note that JTA semantic depends on the fact that the underlying connection provider does support aggressive release.

Specified by:

supportsAggressiveRelease in interface ConnectionProvider

Returns:

true if aggressive releasing is supported; false otherwise.

isUnwrappableAs

public boolean isUnwrappableAs(Class unwrapType)

Description copied from interface: Wrapped

Can this wrapped service be unwrapped as the indicated type?

Specified by:

isUnwrappableAs in interface Wrapped

Parameters:

unwrapType - The type to check.

Returns:

True/false.

unwrap

public <T> T unwrap(Class<T> unwrapType)

Description copied from interface: Wrapped

Unproxy the service proxy

Specified by:

unwrap in interface Wrapped

Parameters:

unwrapType - The java type as which to unwrap this instance.

Returns:

The unwrapped reference

stop

public void stop()

Description copied from interface: Stoppable

Stop phase notification

Specified by:

stop in interface Stoppable