Package org.hibernate.agroal.internal

Class AgroalConnectionProvider

java.lang.Object

org.hibernate.agroal.internal.AgroalConnectionProvider

All Implemented Interfaces:

Serializable, ConnectionProvider, Service, Configurable, Stoppable, Wrapped

public class AgroalConnectionProvider
extends Object
implements ConnectionProvider, Configurable, Stoppable

ConnectionProvider based on Agroal connection pool To use this ConnectionProvider set:

 hibernate.connection.provider_class AgroalConnectionProvider 

Usual hibernate properties are supported:

     hibernate.connection.driver_class
     hibernate.connection.url
     hibernate.connection.username
     hibernate.connection.password
     hibernate.connection.autocommit
     hibernate.connection.isolation
 

Other configuration options are available, using the

hibernate.agroal

prefix ( @see AgroalPropertiesReader )

See Also:

AvailableSettings.CONNECTION_PROVIDER, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_PREFIX

Constructor Summary

Constructors

Constructor	Description
AgroalConnectionProvider()

Method Summary

Modifier and Type	Method	Description
void	closeConnection(Connection conn)	Release a connection from Hibernate use.
void	configure(Map<String,Object> 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 later re-acquisition of those connections if needed?
<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

Field Detail

CONFIG_PREFIX

public static final String CONFIG_PREFIX

See Also:

Constant Field Values

Constructor Detail

AgroalConnectionProvider

public AgroalConnectionProvider()

Method Detail

configure

public void configure(Map<String,Object> 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 later re-acquisition of those connections if needed?

This is used in conjunction with ConnectionReleaseMode.AFTER_STATEMENT 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