Package io.quarkus.agroal.runtime

Class DataSources

java.lang.Object

io.quarkus.agroal.runtime.DataSources

@Singleton
public class DataSources
extends Object

This class is sort of a producer for AgroalDataSource.

It isn't a CDI producer in the literal sense, but it created a synthetic bean from AgroalProcessor The createDataSource method is called at runtime (see AgroalRecorder.agroalDataSourceSupplier(String, DataSourcesRuntimeConfig)) in order to produce the actual AgroalDataSource objects.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TRACING_DRIVER_CLASSNAME

Constructor Summary

Constructors

Constructor

Description

DataSources(DataSourcesBuildTimeConfig dataSourcesBuildTimeConfig, DataSourcesRuntimeConfig dataSourcesRuntimeConfig, DataSourcesJdbcBuildTimeConfig dataSourcesJdbcBuildTimeConfig, DataSourcesJdbcRuntimeConfig dataSourcesJdbcRuntimeConfig, TransactionManagerConfiguration transactionRuntimeConfig, jakarta.transaction.TransactionManager transactionManager, org.jboss.tm.XAResourceRecoveryRegistry xaResourceRecoveryRegistry, jakarta.transaction.TransactionSynchronizationRegistry transactionSynchronizationRegistry, DataSourceSupport dataSourceSupport, AgroalDataSourceSupport agroalDataSourceSupport, jakarta.enterprise.inject.Instance<io.agroal.api.AgroalPoolInterceptor> agroalPoolInterceptors, jakarta.enterprise.inject.Instance<AgroalOpenTelemetryWrapper> agroalOpenTelemetryWrapper)

Method Summary

Modifier and Type	Method	Description
io.agroal.api.AgroalDataSource	doCreateDataSource(String dataSourceName, boolean failIfInactive)
static io.agroal.api.AgroalDataSource	fromName(String dataSourceName)	Deprecated. This method should not be used as it can very easily lead to timing issues during bean creation
Set<String>	getActiveDataSourceNames()
io.agroal.api.AgroalDataSource	getDataSource(String dataSourceName)
boolean	isDataSourceCreated(String dataSourceName)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Details

TRACING_DRIVER_CLASSNAME

public static final String TRACING_DRIVER_CLASSNAME

See Also:

• Constant Field Values

Constructor Details

DataSources

public DataSources(DataSourcesBuildTimeConfig dataSourcesBuildTimeConfig,
 DataSourcesRuntimeConfig dataSourcesRuntimeConfig,
 DataSourcesJdbcBuildTimeConfig dataSourcesJdbcBuildTimeConfig,
 DataSourcesJdbcRuntimeConfig dataSourcesJdbcRuntimeConfig,
 TransactionManagerConfiguration transactionRuntimeConfig,
 jakarta.transaction.TransactionManager transactionManager,
 org.jboss.tm.XAResourceRecoveryRegistry xaResourceRecoveryRegistry,
 jakarta.transaction.TransactionSynchronizationRegistry transactionSynchronizationRegistry,
 DataSourceSupport dataSourceSupport,
 AgroalDataSourceSupport agroalDataSourceSupport,
 @Any
 jakarta.enterprise.inject.Instance<io.agroal.api.AgroalPoolInterceptor> agroalPoolInterceptors,
 jakarta.enterprise.inject.Instance<AgroalOpenTelemetryWrapper> agroalOpenTelemetryWrapper)

Method Details

fromName

@Deprecated
public static io.agroal.api.AgroalDataSource fromName(String dataSourceName)

Deprecated.

This method should not be used as it can very easily lead to timing issues during bean creation

Meant to be used from recorders that create synthetic beans that need access to Datasource. In such using Arc.container.instance(DataSource.class) is not possible because Datasource is itself a synthetic bean.

This method relies on the fact that DataSources should - given the same input - always return the same AgroalDataSource no matter how many times it is invoked (which makes sense because DataSource is a Singleton bean).

This method is thread-safe

isDataSourceCreated

public boolean isDataSourceCreated(String dataSourceName)

getActiveDataSourceNames

public Set<String> getActiveDataSourceNames()

getDataSource

public io.agroal.api.AgroalDataSource getDataSource(String dataSourceName)

start

@PostConstruct
public void start()

doCreateDataSource

public io.agroal.api.AgroalDataSource doCreateDataSource(String dataSourceName,
 boolean failIfInactive)

stop

@PreDestroy
public void stop()