Index (Agroal API 1.15 API)

A B C D E F G H I J L M N O P R S T U V W
All Classes All Packages

A

Acquirable - Interface in io.agroal.api.cache: Contract for objects that can be acquired.
acquire() - Method in interface io.agroal.api.cache.Acquirable: Attempts to acquire this object.
acquireCount() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Number of times an acquire operation succeeded.
ACQUISITION_TIMEOUT - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
ACQUISITION_TIMEOUT_M - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
ACQUISITION_TIMEOUT_MS - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
ACQUISITION_TIMEOUT_S - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
acquisitionTimeout() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: The maximum amount of time a thread may be blocked waiting for a connection.
acquisitionTimeout(Duration) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the duration of the acquisition timeout.
activeCount() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Number active of connections.
addResourceRecoveryFactory(TransactionIntegration.ResourceRecoveryFactory) - Method in interface io.agroal.api.transaction.TransactionIntegration: Agroal calls this method on init to register itself as a XA module capable of recovery.
addSecurityProvider(AgroalSecurityProvider) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Allows setting additional AgroalSecurityProvider to deal with custom principal/credential types.
AGROAL - io.agroal.api.configuration.AgroalDataSourceConfiguration.DataSourceImplementation: Agroal - the natural database connection pool!
AGROAL_POOLLESS - io.agroal.api.configuration.AgroalDataSourceConfiguration.DataSourceImplementation: Specialization of the Agroal pool for the flush-on-close use case.
AgroalConnectionFactoryConfiguration - Interface in io.agroal.api.configuration: The configuration of the connection factory.
AgroalConnectionFactoryConfiguration.IsolationLevel - Interface in io.agroal.api.configuration: Interface to define the transaction isolation level.
AgroalConnectionFactoryConfiguration.TransactionIsolation - Enum in io.agroal.api.configuration: The default transaction isolation levels, defined in Connection.
AgroalConnectionFactoryConfigurationSupplier - Class in io.agroal.api.configuration.supplier: Builder of AgroalConnectionFactoryConfiguration.
AgroalConnectionFactoryConfigurationSupplier() - Constructor for class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier
AgroalConnectionFactoryConfigurationSupplier(AgroalConnectionFactoryConfiguration) - Constructor for class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier
AgroalConnectionPoolConfiguration - Interface in io.agroal.api.configuration: The configuration of the connection pool.
AgroalConnectionPoolConfiguration.ConnectionValidator - Interface in io.agroal.api.configuration: Interface for custom connection validation strategies.
AgroalConnectionPoolConfiguration.ExceptionSorter - Interface in io.agroal.api.configuration: Interface for custom exception sorter strategies.
AgroalConnectionPoolConfiguration.MultipleAcquisitionAction - Enum in io.agroal.api.configuration: Action to perform on acquisition of multiple connections by the same thread.
AgroalConnectionPoolConfiguration.TransactionRequirement - Enum in io.agroal.api.configuration: Modes available for transaction requirement.
AgroalConnectionPoolConfigurationSupplier - Class in io.agroal.api.configuration.supplier: Builder of AgroalConnectionPoolConfiguration.
AgroalConnectionPoolConfigurationSupplier() - Constructor for class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier
AgroalConnectionPoolConfigurationSupplier(AgroalConnectionPoolConfiguration) - Constructor for class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier
AgroalDataSource - Interface in io.agroal.api: Extension of the DataSource interface that exposes some of its internals.
AgroalDataSource.FlushMode - Enum in io.agroal.api: Modes supported on the flush operation.
AgroalDataSourceConfiguration - Interface in io.agroal.api.configuration: Configuration of an AgroalDataSource.
AgroalDataSourceConfiguration.DataSourceImplementation - Enum in io.agroal.api.configuration: Available implementations of AgroalDataSource.
AgroalDataSourceConfiguration.MetricsEnabledListener - Interface in io.agroal.api.configuration
AgroalDataSourceConfigurationSupplier - Class in io.agroal.api.configuration.supplier: Builder of AgroalDataSourceConfiguration.
AgroalDataSourceConfigurationSupplier() - Constructor for class io.agroal.api.configuration.supplier.AgroalDataSourceConfigurationSupplier
AgroalDataSourceListener - Interface in io.agroal.api: This interface defines a set of callback methods that are invoked on events considered important for the state of the pool.
AgroalDataSourceMetrics - Interface in io.agroal.api: Several metrics provided by the pool.
AgroalDataSourceProvider - Interface in io.agroal.api: An interface for providers of AgroalDataSource.
AgroalDefaultSecurityProvider - Class in io.agroal.api.security: Handles objects of type NamePrincipal, SimplePassword and Principal
AgroalDefaultSecurityProvider() - Constructor for class io.agroal.api.security.AgroalDefaultSecurityProvider
AgroalKerberosSecurityProvider - Class in io.agroal.api.security: Handle objects of type GSSCredential and KerberosTicket
AgroalKerberosSecurityProvider() - Constructor for class io.agroal.api.security.AgroalKerberosSecurityProvider
AgroalPoolInterceptor - Interface in io.agroal.api: Callback interface for pool actions.
AgroalPropertiesReader - Class in io.agroal.api.configuration.supplier: Convenient way to build an Agroal configuration.
AgroalPropertiesReader() - Constructor for class io.agroal.api.configuration.supplier.AgroalPropertiesReader
AgroalPropertiesReader(String) - Constructor for class io.agroal.api.configuration.supplier.AgroalPropertiesReader
AgroalSecurityProvider - Interface in io.agroal.api.security: Interface to be implemented in order to extend Agroal with custom types of authentication.
ALL - io.agroal.api.AgroalDataSource.FlushMode: All connections are flushed right away.
asProperties() - Method in class io.agroal.api.security.NamePrincipal
asProperties() - Method in class io.agroal.api.security.SimplePassword
associate(TransactionAware, XAResource) - Method in interface io.agroal.api.transaction.TransactionIntegration: Agroal notifies the transaction layer a Tx aware resource (a connection) and it's corresponding XA resource were acquired.
AUTO_COMMIT - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
autoCommit() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration: If connections should have the auto-commit mode on by default.
autoCommit(boolean) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Sets the value of auto-commit for connections on the pool.
availableCount() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Number of idle connections in the pool, available to be acquired.
awaitingCount() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Approximate number of threads blocked, waiting to acquire a connection.

B

beforeConnectionAcquire() - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked whenever an application tries to obtain a connection.
beforeConnectionCreation() - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked whenever a new connection is about to be created.
beforeConnectionDestroy(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked whenever a connection is about to be destroyed.
beforeConnectionFlush(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked when a connection is about to be flush.
beforeConnectionLeak(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked before checking the leak timeout of a connection.
beforeConnectionReap(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked before checking the idle timeout of a connection.
beforeConnectionReturn(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked before a connection is returned to the pool.
beforeConnectionValidation(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked when a connection is about to be checked.
blockingTimeAverage() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Average time an application waited to acquire a connection.
blockingTimeMax() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Maximum time an application waited to acquire a connection.
blockingTimeTotal() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Total time applications waited to acquire a connection.

C

call() - Method in interface io.agroal.api.transaction.TransactionAware.SQLCallable: Execute an action that may result in an SQLException
className() - Method in enum io.agroal.api.configuration.AgroalDataSourceConfiguration.DataSourceImplementation
close() - Method in interface io.agroal.api.AgroalDataSource
connectionCache() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Customizable strategy for connection caching.
connectionCache(ConnectionCache) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the connection cache implementation.
ConnectionCache - Interface in io.agroal.api.cache: Interface for a cache of connections.
connectionFactoryConfiguration() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Configuration for the connection factory.
connectionFactoryConfiguration() - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Allows access to the configuration builder for the connection pool.
connectionFactoryConfiguration(Function<? super AgroalConnectionFactoryConfigurationSupplier, ? extends AgroalConnectionFactoryConfigurationSupplier>) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Modifies the configuration of the connection pool.
connectionFactoryConfiguration(Supplier<? extends AgroalConnectionFactoryConfiguration>) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the configuration for the connection factory.
connectionPoolConfiguration() - Method in interface io.agroal.api.configuration.AgroalDataSourceConfiguration: Configuration of the pool of this DataSource
connectionPoolConfiguration() - Method in class io.agroal.api.configuration.supplier.AgroalDataSourceConfigurationSupplier: Allows access to the configuration builder for the connection pool.
connectionPoolConfiguration(AgroalConnectionPoolConfiguration) - Method in class io.agroal.api.configuration.supplier.AgroalDataSourceConfigurationSupplier: Sets the configuration of the connection pool.
connectionPoolConfiguration(Function<? super AgroalConnectionPoolConfigurationSupplier, ? extends AgroalConnectionPoolConfigurationSupplier>) - Method in class io.agroal.api.configuration.supplier.AgroalDataSourceConfigurationSupplier: Modifies the configuration of the connection pool.
connectionPoolConfiguration(Supplier<? extends AgroalConnectionPoolConfiguration>) - Method in class io.agroal.api.configuration.supplier.AgroalDataSourceConfigurationSupplier: Sets the configuration of the connection pool.
connectionProviderClass() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration: JDBC driver class to use as a supplier of connections.
connectionProviderClass(Class<?>) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Sets a class from the JDBC driver to be used as a supplier of connections.
connectionProviderClassName(String) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Attempts to load a JDBC driver class using its fully qualified name.
connectionValidator() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: The connection validation method.
connectionValidator(AgroalConnectionPoolConfiguration.ConnectionValidator) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the connection validation method.
creationCount() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Number of created connections.
creationTimeAverage() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Average time for a connection to be created.
creationTimeMax() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Maximum time for a connection to be created.
creationTimeTotal() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Total time waiting for a connections to be created.
credential(Object) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Sets credentials to use in order to authenticate to the database.
CREDENTIAL - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
credentials() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration: Collection of evidence used for authentication.

D

dataSourceImplementation() - Method in interface io.agroal.api.configuration.AgroalDataSourceConfiguration: Actual AgroalDataSource implementation.
dataSourceImplementation(AgroalDataSourceConfiguration.DataSourceImplementation) - Method in class io.agroal.api.configuration.supplier.AgroalDataSourceConfigurationSupplier: Selects the AgroalDataSource implementation.
DB2ExceptionSorter - Class in io.agroal.api.exceptionsorter: Exception sorter for DB2 databases.
DB2ExceptionSorter() - Constructor for class io.agroal.api.exceptionsorter.DB2ExceptionSorter
DEFAULT_COMPARATOR - Static variable in interface io.agroal.api.AgroalPoolInterceptor: Uses interceptor priority, followed by Class.getName() to ensure a consistent ordering.
defaultExceptionSorter() - Static method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration.ExceptionSorter: Default exception sorter.
defaultValidator() - Static method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration.ConnectionValidator: The default validation strategy Connection.isValid(int)
defaultValidatorWithTimeout(int) - Static method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration.ConnectionValidator: The default validation strategy with a timeout (in seconds).
destroyCount() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Number of destroyed connections.
disassociate(TransactionAware) - Method in interface io.agroal.api.transaction.TransactionIntegration: Agroal notifies the transaction layer that a Tx aware resource (a connection) is about to be returned to the pool.

E

emptyExceptionSorter() - Static method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration.ExceptionSorter: Never treat an exception as fatal.
emptyValidator() - Static method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration.ConnectionValidator: A validator that never invalidates connections.
ENHANCED_LEAK_REPORT - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
enhancedLeakReport() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Provides detailed insights of the connection status when it's reported as a leak (as INFO messages on AgroalDataSourceListener).
enhancedLeakReport() - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Enables enhanced leak report.
enhancedLeakReport(boolean) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Enables or disables enhanced leak report.
equals(Object) - Method in class io.agroal.api.security.NamePrincipal
equals(Object) - Method in class io.agroal.api.security.SimplePassword
exceptionSorter() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Allows a custom exception sorter.
exceptionSorter(AgroalConnectionPoolConfiguration.ExceptionSorter) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the exception sorter.

F

fatalExceptionSorter() - Static method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration.ExceptionSorter: Treats every exception as fatal.
FILL - io.agroal.api.AgroalDataSource.FlushMode: Creates connections to met the minimum size of the pool.
fixed(int) - Static method in interface io.agroal.api.cache.LocalConnectionCache: A local cache that stores up to a number of connections.
flush(AgroalDataSource.FlushMode) - Method in interface io.agroal.api.AgroalDataSource: Performs a flush action on the connections of the pool.
FLUSH_ON_CLOSE - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
flushCount() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Number of connections removed from the pool, not counting invalid / idle.
flushOnClose() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: If connections should be flushed when returning to the pool.
flushOnClose() - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Enables flushing of connections on close.
flushOnClose(boolean) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Enables or disables flushing of connections on close.
from(AgroalDataSourceConfiguration, AgroalDataSourceListener...) - Static method in interface io.agroal.api.AgroalDataSource: Create an AgroalDataSource from configuration.
from(Supplier<AgroalDataSourceConfiguration>, AgroalDataSourceListener...) - Static method in interface io.agroal.api.AgroalDataSource: Create an AgroalDataSource from a supplier of the configuration.
fromLevel(int) - Static method in enum io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation
full() - Static method in interface io.agroal.api.cache.LocalConnectionCache: A local cache that stores all connections

G

get() - Method in interface io.agroal.api.cache.ConnectionCache: Get a acquirable object from cache.
get() - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier
get() - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier
get() - Method in class io.agroal.api.configuration.supplier.AgroalDataSourceConfigurationSupplier
get() - Method in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
getConfiguration() - Method in interface io.agroal.api.AgroalDataSource: Allows inspection of the configuration.
getConnection() - Method in interface io.agroal.api.transaction.TransactionAware: Gets access to the raw Connection held by the resource.
getDataSource(AgroalDataSourceConfiguration, AgroalDataSourceListener...) - Method in interface io.agroal.api.AgroalDataSourceProvider: Factory method for AgroalDataSource.
getMetrics() - Method in interface io.agroal.api.AgroalDataSource: Allows access to metrics.
getName() - Method in class io.agroal.api.security.NamePrincipal
getPoolInterceptors() - Method in interface io.agroal.api.AgroalDataSource: Get the list of pool interceptors.
getPriority() - Method in interface io.agroal.api.AgroalPoolInterceptor: Allows a ordering between multiple interceptors.
getRecoveryConnection() - Method in interface io.agroal.api.transaction.TransactionIntegration.ResourceRecoveryFactory: The transaction layer can call this method to obtain one connection used for recovery of incomplete transactions.
getSecurityProperties(Object) - Method in class io.agroal.api.security.AgroalDefaultSecurityProvider
getSecurityProperties(Object) - Method in class io.agroal.api.security.AgroalKerberosSecurityProvider
getSecurityProperties(Object) - Method in interface io.agroal.api.security.AgroalSecurityProvider: Converts a custom principal / credential objects to properties to be passed to the JDBC driver.
getTransactionAware() - Method in interface io.agroal.api.transaction.TransactionIntegration: Agroal inquires the transaction layer for a Tx aware resource (a connection) that can be acquired.
getWord() - Method in class io.agroal.api.security.SimplePassword
GRACEFUL - io.agroal.api.AgroalDataSource.FlushMode: Active connections are flushed on return.

H

hashCode() - Method in class io.agroal.api.security.NamePrincipal
hashCode() - Method in class io.agroal.api.security.SimplePassword
HIKARI - io.agroal.api.configuration.AgroalDataSourceConfiguration.DataSourceImplementation: The popular Hikari connection pool.

I

IDLE - io.agroal.api.AgroalDataSource.FlushMode: Idle connections are flushed.
idleValidationTimeout() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Connections idle for longer than this time period are validated before being acquired (foreground validation).
idleValidationTimeout(Duration) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the duration of idle time for foreground validation to be executed.
IMPLEMENTATION - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
INITIAL_SIZE - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
INITIAL_SQL - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
initialSize() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: The number of connections to be created when the pool starts.
initialSize(int) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the number of connections when the pool starts.
initialSql() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration: A SQL command to be executed when a connection is created.
initialSql(String) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Sets the SQL command to be executed when a connection is created.
INVALID - io.agroal.api.AgroalDataSource.FlushMode: Performs on-demand validation of idle connections.
invalidCount() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Number of connections removed from the pool for being invalid.
io.agroal.api - package io.agroal.api
io.agroal.api.cache - package io.agroal.api.cache
io.agroal.api.configuration - package io.agroal.api.configuration
io.agroal.api.configuration.supplier - package io.agroal.api.configuration.supplier
io.agroal.api.exceptionsorter - package io.agroal.api.exceptionsorter
io.agroal.api.security - package io.agroal.api.security
io.agroal.api.transaction - package io.agroal.api.transaction
isAcquirable() - Method in interface io.agroal.api.cache.Acquirable: This method signals if the object can't be acquired in future calls to acquire().
isDefined() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.IsolationLevel: If a level is not defined it will not be set by the pool (it will use the JDBC driver default).
isDefined() - Method in enum io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation
isFatal(SQLException) - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration.ExceptionSorter
isFatal(SQLException) - Method in class io.agroal.api.exceptionsorter.DB2ExceptionSorter
isFatal(SQLException) - Method in class io.agroal.api.exceptionsorter.MSSQLExceptionSorter
isFatal(SQLException) - Method in class io.agroal.api.exceptionsorter.MySQLExceptionSorter
isFatal(SQLException) - Method in class io.agroal.api.exceptionsorter.OracleExceptionSorter
isFatal(SQLException) - Method in class io.agroal.api.exceptionsorter.PostgreSQLExceptionSorter
isFatal(SQLException) - Method in class io.agroal.api.exceptionsorter.SybaseExceptionSorter
isHealthy(boolean) - Method in interface io.agroal.api.AgroalDataSource: Performs a health check.
isValid(Connection) - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration.ConnectionValidator

J

JDBC_PROPERTIES - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
JDBC_URL - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
jdbcProperties() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration: Other unspecified properties to be passed into the JDBC driver when creating new connections.
jdbcProperty(String, String) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Allows setting other, unspecified, properties to be passed to the JDBC driver when creating new connections.
jdbcTransactionIsolation() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration: The isolation level between database transactions.
jdbcTransactionIsolation(int) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Allows setting a custom transaction isolation level.
jdbcTransactionIsolation(AgroalConnectionFactoryConfiguration.TransactionIsolation) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Sets the transaction isolation level.
jdbcUrl() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration: The database URL to connect to.
jdbcUrl(String) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Sets the database URL to connect to.

L

LEAK - io.agroal.api.AgroalDataSource.FlushMode: Flushes connections that have been in use for longer than the specified leak timeout.
LEAK_TIMEOUT - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
LEAK_TIMEOUT_M - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
LEAK_TIMEOUT_MS - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
LEAK_TIMEOUT_S - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
leakDetectionCount() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Number of times a leak was detected.
leakTimeout() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Connections acquired for longer than this time period may be reported as leaking.
leakTimeout(Duration) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the duration of the leak timeout detection.
level() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.IsolationLevel: The value for transaction isolation level.
level() - Method in enum io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation
LocalConnectionCache - Interface in io.agroal.api.cache: Implementations of ConnectionCache that rely on ThreadLocal.

M

MAX_LIFETIME - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
MAX_LIFETIME_M - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
MAX_LIFETIME_MS - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
MAX_LIFETIME_S - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
MAX_SIZE - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
maxLifetime() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Connections that are older than this time period are flushed from the pool.
maxLifetime(Duration) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the duration for the lifetime of connections.
maxSize() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: The maximum number of connections on the pool.
maxSize(int) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the maximum number of connections on the pool.
maxUsedCount() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Maximum number of connections active simultaneously.
METRICS_ENABLED - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
metricsEnabled() - Method in interface io.agroal.api.configuration.AgroalDataSourceConfiguration: If this AgroalDataSource collects metrics.
metricsEnabled() - Method in class io.agroal.api.configuration.supplier.AgroalDataSourceConfigurationSupplier: Enables the collection of metrics.
metricsEnabled(boolean) - Method in class io.agroal.api.configuration.supplier.AgroalDataSourceConfigurationSupplier: Enables or disables the collection of metrics.
MIN_SIZE - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
minSize() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: The minimum number of connections on the pool.
minSize(int) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the minimum number of connections on the pool.
modify() - Method in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
MSSQLExceptionSorter - Class in io.agroal.api.exceptionsorter: Exception sorter for MSSQL databases.
MSSQLExceptionSorter() - Constructor for class io.agroal.api.exceptionsorter.MSSQLExceptionSorter
MULTIPLE_ACQUISITION - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
multipleAcquisition() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Behaviour when a thread tries to acquire multiple connections.
multipleAcquisition(AgroalConnectionPoolConfiguration.MultipleAcquisitionAction) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the behaviour of the pool when a thread tries to acquire multiple connections.
MySQLExceptionSorter - Class in io.agroal.api.exceptionsorter: Exception sorter for MySQL / MariaDB databases.
MySQLExceptionSorter() - Constructor for class io.agroal.api.exceptionsorter.MySQLExceptionSorter

N

NamePrincipal - Class in io.agroal.api.security: A string that identifies an user account.
NamePrincipal(char[]) - Constructor for class io.agroal.api.security.NamePrincipal
NamePrincipal(String) - Constructor for class io.agroal.api.security.NamePrincipal
none() - Static method in interface io.agroal.api.cache.ConnectionCache: An implementation that does not cache.
none() - Static method in interface io.agroal.api.transaction.TransactionIntegration: The default implementation of the transaction layer, that performs no actions.
NONE - io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation

O

OFF - io.agroal.api.configuration.AgroalConnectionPoolConfiguration.MultipleAcquisitionAction: No restriction.
OFF - io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement: Enlistment not required.
onConnectionAcquire(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked when a connection is successfully acquired.
onConnectionAcquire(Connection) - Method in interface io.agroal.api.AgroalPoolInterceptor: This callback is invoked when a connection is successfully acquired.
onConnectionCreation(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked for every new connection.
onConnectionDestroy(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked after a connection is closed.
onConnectionFlush(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked when after a connection is removed from the pool.
onConnectionInvalid(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked when a connection was checked and is invalid.
onConnectionLeak(Connection, Thread) - Method in interface io.agroal.api.AgroalDataSourceListener: This connection is invoked when a connection is held for longer than the leak timeout and reports what thread acquired it.
onConnectionPooled(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked right after a connection is added to the pool.
onConnectionReap(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked if a connection is idle in the pool.
onConnectionReturn(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked right after a connection is returned to the pool.
onConnectionReturn(Connection) - Method in interface io.agroal.api.AgroalPoolInterceptor: This callback is invoked before a connection is returned to the pool.
onConnectionValid(Connection) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked when a connection was checked and is valid.
onInfo(String) - Method in interface io.agroal.api.AgroalDataSourceListener: Callback to allow reporting information of interest, for which a warning might be considered excessive.
onMetricsEnabled(boolean) - Method in interface io.agroal.api.configuration.AgroalDataSourceConfiguration.MetricsEnabledListener
onWarning(String) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked to report anomalous circumstances that do not prevent the pool from functioning.
onWarning(Throwable) - Method in interface io.agroal.api.AgroalDataSourceListener: This callback is invoked to report anomalous circumstances that do not prevent the pool from functioning.
OracleExceptionSorter - Class in io.agroal.api.exceptionsorter: Exception sorter for Oracle databases.
OracleExceptionSorter() - Constructor for class io.agroal.api.exceptionsorter.OracleExceptionSorter

P

PostgreSQLExceptionSorter - Class in io.agroal.api.exceptionsorter: Exception sorter for PostgreSQL databases.
PostgreSQLExceptionSorter() - Constructor for class io.agroal.api.exceptionsorter.PostgreSQLExceptionSorter
principal() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration: Entity to be authenticated in the database.
principal(Principal) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Sets the principal to be authenticated in the database.
PRINCIPAL - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
PROVIDER_CLASS_NAME - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
put(Acquirable) - Method in interface io.agroal.api.cache.ConnectionCache: Cache an acquirable object on this cache.

R

READ_COMMITTED - io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation
READ_UNCOMMITTED - io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation
readProperties(File) - Method in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
readProperties(String) - Method in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
readProperties(Path) - Method in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
readProperties(Map<String, String>) - Method in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
readProperties(Properties) - Method in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
REAP_TIMEOUT - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
REAP_TIMEOUT_M - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
REAP_TIMEOUT_MS - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
REAP_TIMEOUT_S - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
reapCount() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Number of connections removed from the pool for being idle.
reapTimeout() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Connections idle for longer than this time period are flushed from the pool.
reapTimeout(Duration) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the duration for eviction of idle connections.
RECOVERY_CREDENTIAL - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
RECOVERY_PRINCIPAL - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
recoveryCredential(Object) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Allows providing a different set of credentials for recovery connections.
recoveryCredentials() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration: Collection of evidence used for authentication for recovery connections.
recoveryPrincipal() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration: Entity to be authenticated in the database for recovery connections.
recoveryPrincipal(Principal) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Allows setting a different principal for recovery connections.
registerMetricsEnabledListener(AgroalDataSourceConfiguration.MetricsEnabledListener) - Method in interface io.agroal.api.configuration.AgroalDataSourceConfiguration: Allows registration of a callback to be invoked each time there is a change on the status of metrics collection.
removeResourceRecoveryFactory(TransactionIntegration.ResourceRecoveryFactory) - Method in interface io.agroal.api.transaction.TransactionIntegration: Agroal calls this method on shutdown to de-register itself as a XA module capable of recovery.
REPEATABLE_READ - io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation
reset() - Method in interface io.agroal.api.AgroalDataSourceMetrics: Reset the metrics.
reset() - Method in interface io.agroal.api.cache.ConnectionCache: Reset the cache.

S

securityProviders() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration: A collection of providers that are capable of handling principal / credential objects
SERIALIZABLE - io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation
setAcquisitionTimeout(Duration) - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Sets a new amount of time a thread may be blocked.
setFlushOnly() - Method in interface io.agroal.api.transaction.TransactionAware: The resource is no longer valid and should not be returned to the pool.
setMaxSize(int) - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Sets a new maximum number of connections on the pool.
setMetricsEnabled(boolean) - Method in interface io.agroal.api.configuration.AgroalDataSourceConfiguration: Enables or disables the collection of metrics.
setMinSize(int) - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Sets a new minimum number of connections on the pool.
setPoolInterceptors(Collection<? extends AgroalPoolInterceptor>) - Method in interface io.agroal.api.AgroalDataSource: Sets pool interceptors.
SimplePassword - Class in io.agroal.api.security: Credential that holds a secret string of characters to be used for authentication.
SimplePassword(char[]) - Constructor for class io.agroal.api.security.SimplePassword
SimplePassword(String) - Constructor for class io.agroal.api.security.SimplePassword
single() - Static method in interface io.agroal.api.cache.LocalConnectionCache: A local cache that stores at most a single connection.
STRICT - io.agroal.api.configuration.AgroalConnectionPoolConfiguration.MultipleAcquisitionAction: Enforces single connection by throwing exception.
STRICT - io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement: Throw exception if not enlisted.
SybaseExceptionSorter - Class in io.agroal.api.exceptionsorter: Exception sorter for Sybase databases.
SybaseExceptionSorter() - Constructor for class io.agroal.api.exceptionsorter.SybaseExceptionSorter

T

toString() - Method in class io.agroal.api.security.NamePrincipal
toString() - Method in class io.agroal.api.security.SimplePassword
TRACK_JDBC_RESOURCES - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
trackJdbcResources() - Method in interface io.agroal.api.configuration.AgroalConnectionFactoryConfiguration: If JDBC resources (Statement and ResultSet) should be tracked to be closed if leaked.
trackJdbcResources(boolean) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionFactoryConfigurationSupplier: Sets if JDBC resources are tracked to be closed if leaked.
TRANSACTION_ISOLATION - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
TRANSACTION_REQUIREMENT - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
TransactionAware - Interface in io.agroal.api.transaction: Interface to be implemented by a resource (a connection) that the transaction integration layer will manipulate.
TransactionAware.SQLCallable<T> - Interface in io.agroal.api.transaction: A callable that can throw SQLException
transactionBeforeCompletion(boolean) - Method in interface io.agroal.api.transaction.TransactionAware: The transaction is about to complete.
transactionCheckCallback(TransactionAware.SQLCallable<Boolean>) - Method in interface io.agroal.api.transaction.TransactionAware: Set a callback trap to prevent lazy / deferred enlistment.
transactionCommit() - Method in interface io.agroal.api.transaction.TransactionAware: The resource must commit.
transactionEnd() - Method in interface io.agroal.api.transaction.TransactionAware: The transaction ended and the resource is no longer enlisted.
transactionIntegration() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: The transaction layer integration to use.
transactionIntegration(TransactionIntegration) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the transaction integration instance to use.
TransactionIntegration - Interface in io.agroal.api.transaction: Agroal provides an integration point for transaction systems to modify the behaviour of the pool.
TransactionIntegration.ResourceRecoveryFactory - Interface in io.agroal.api.transaction: This interface is implemented by the connection factory so that it can provide recovery resources to the transaction layer.
transactionRequirement() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Requires connections to be enlisted into a transaction.
transactionRequirement(AgroalConnectionPoolConfiguration.TransactionRequirement) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the transaction requirements for the pool.
transactionRollback() - Method in interface io.agroal.api.transaction.TransactionAware: The resource must rollback.
transactionStart() - Method in interface io.agroal.api.transaction.TransactionAware: The resource it's now enlisted with a transaction.

U

UNDEFINED - io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation

V

VALIDATION_TIMEOUT - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
VALIDATION_TIMEOUT_M - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
VALIDATION_TIMEOUT_MS - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
VALIDATION_TIMEOUT_S - Static variable in class io.agroal.api.configuration.supplier.AgroalPropertiesReader
validationTimeout() - Method in interface io.agroal.api.configuration.AgroalConnectionPoolConfiguration: Connections idle for longer than this time period are validated (background validation).
validationTimeout(Duration) - Method in class io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier: Sets the duration of background validation interval.
valueOf(String) - Static method in enum io.agroal.api.AgroalDataSource.FlushMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agroal.api.configuration.AgroalConnectionPoolConfiguration.MultipleAcquisitionAction: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agroal.api.configuration.AgroalDataSourceConfiguration.DataSourceImplementation: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.agroal.api.AgroalDataSource.FlushMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agroal.api.configuration.AgroalConnectionPoolConfiguration.MultipleAcquisitionAction: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agroal.api.configuration.AgroalDataSourceConfiguration.DataSourceImplementation: Returns an array containing the constants of this enum type, in the order they are declared.

W

WARN - io.agroal.api.configuration.AgroalConnectionPoolConfiguration.MultipleAcquisitionAction: Warn if thread already holds a connection.
WARN - io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement: Warn if not enlisted.

A B C D E F G H I J L M N O P R S T U V W
All Classes All Packages