Module io.helidon.integrations.datasource.cdi

Package io.helidon.integrations.datasource.cdi

Class AbstractDataSourceExtension

java.lang.Object

io.helidon.integrations.datasource.cdi.AbstractDataSourceExtension

All Implemented Interfaces:

Extension

Direct Known Subclasses:

HikariCPBackedDataSourceExtension, UCPBackedDataSourceExtension

public abstract class AbstractDataSourceExtension
extends Object
implements Extension

An abstract Extension whose subclasses arrange for DataSource instances to be added as CDI beans.

Thread Safety

As with all CDI portable extensions, this class' instances are not safe for concurrent use by multiple threads.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDataSourceExtension()	Creates a new AbstractDataSourceExtension.

Method Summary

Modifier and Type	Method	Description
protected abstract void	addBean(BeanConfigurator<DataSource> beanConfigurator, Named name, Properties properties)	Called to permit subclasses to add a DataSource-typed bean using the supplied BeanConfigurator.
protected Config	getConfig()	Returns the Config instance used to acquire configuration property values.
protected abstract String	getDataSourceName(Matcher dataSourcePropertyPatternMatcher)	Given a Matcher that has been produced by the getDataSourcePropertyPatternMatcher(String) method, returns the relevant data source name.
protected Set<String>	getDataSourceNames()	Returns a Set of data source names known to this AbstractDataSourceExtension implementation.
protected abstract String	getDataSourcePropertyName(Matcher dataSourcePropertyPatternMatcher)	Given a Matcher that has been produced by the getDataSourcePropertyPatternMatcher(String) method, returns the relevant data source property name.
protected abstract Matcher	getDataSourcePropertyPatternMatcher(String configPropertyName)	Returns a Matcher for a property name.
protected Set<String>	getPropertyNames()	Returns a Set of all known configuration property names.
protected void	initializeMasterProperties()	Clears and then builds or rebuilds an internal map of data source properties whose contents will be processed eventually by the addBean(BeanConfigurator, Named, Properties) method.
protected Properties	putDataSourceProperties(String dataSourceName, Properties properties)	Adds additional synthesized properties to an internal map of data source properties whose contents will be processed eventually by the addBean(BeanConfigurator, Named, Properties) method.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDataSourceExtension

protected AbstractDataSourceExtension()

Creates a new AbstractDataSourceExtension.

Method Detail

getDataSourcePropertyPatternMatcher

protected abstract Matcher getDataSourcePropertyPatternMatcher(String configPropertyName)

Returns a Matcher for a property name.

Implementations of this method must not return null.

Given a String like javax.sql.DataSource.dataSourceName.dataSourcePropertyName, any implementation of this method should return a non- null Matcher that is capable of being supplied to the getDataSourceName(Matcher) and getDataSourcePropertyName(Matcher) methods.

Parameters:

configPropertyName - the name of a configuration property that logically contains a data source name and a data source property name; must not be null

Returns:

a non-null Matcher

See Also:

getDataSourceName(Matcher), getDataSourcePropertyName(Matcher)

getDataSourceName

protected abstract String getDataSourceName(Matcher dataSourcePropertyPatternMatcher)

Given a Matcher that has been produced by the getDataSourcePropertyPatternMatcher(String) method, returns the relevant data source name.

Implementations of this method may return null.

Parameters:

dataSourcePropertyPatternMatcher - a Matcher produced by the getDataSourcePropertyPatternMatcher(String) method; must not be null

Returns:

a data source name, or null

See Also:

getDataSourcePropertyPatternMatcher(String)

getDataSourcePropertyName

protected abstract String getDataSourcePropertyName(Matcher dataSourcePropertyPatternMatcher)

Given a Matcher that has been produced by the getDataSourcePropertyPatternMatcher(String) method, returns the relevant data source property name.

Implementations of this method may return null.

Parameters:

dataSourcePropertyPatternMatcher - a Matcher produced by the getDataSourcePropertyPatternMatcher(String) method; must not be null

Returns:

a data source property name, or null

See Also:

getDataSourcePropertyPatternMatcher(String)

addBean

protected abstract void addBean(BeanConfigurator<DataSource> beanConfigurator,
                                Named name,
                                Properties properties)

Called to permit subclasses to add a DataSource-typed bean using the supplied BeanConfigurator.

Implementations of this method will be called from an observer method that is observing the AfterBeanDiscovery container lifecycle event.

Parameters:

beanConfigurator - the BeanConfigurator to use to actually add a new bean; must not be null

name - a Named instance qualifying the DataSource-typed bean to be added; may be null

properties - a Properties instance containing properties relevant to the data source; must not be null

getConfig

protected final Config getConfig()

Returns the Config instance used to acquire configuration property values.

This method never returns null.

Returns:

a non-null Config instance

See Also:

Config

getDataSourceNames

protected final Set<String> getDataSourceNames()

Returns a Set of data source names known to this AbstractDataSourceExtension implementation.

This method never returns null.

The Set returned by this method is unmodifiable.

Returns:

a non-null, unmodifiable Set of known data source names

putDataSourceProperties

protected final Properties putDataSourceProperties(String dataSourceName,
                                                   Properties properties)

Adds additional synthesized properties to an internal map of data source properties whose contents will be processed eventually by the addBean(BeanConfigurator, Named, Properties) method.

This method may return null.

Parameters:

dataSourceName - the name of the data source under which the supplied Properties will be indexed; may be null

properties - the Properties to put; may be null

Returns:

the prior Properties indexed under the supplied dataSourceName, or null

initializeMasterProperties

protected final void initializeMasterProperties()

Clears and then builds or rebuilds an internal map of data source properties whose contents will be processed eventually by the addBean(BeanConfigurator, Named, Properties) method.

If no subclass explicitly calls this method, it will be called by the addBean(BeanConfigurator, Named, Properties) method just prior to its other activities.

Once the addBean(BeanConfigurator, Named, Properties) method has run to completion, while this method may be called freely its use is discouraged and its effects will no longer be used.

See Also:

addBean(BeanConfigurator, Named, Properties)

getPropertyNames

protected final Set<String> getPropertyNames()

Returns a Set of all known configuration property names.

This method never returns null.

The Set returned by this method is unmodifiable.

The Set returned by this method is not safe for concurrent use by multiple threads.

Any other semantics of the Set returned by this method are governed by the MicroProfile Config specification.

Returns:

a non-null, unmodifiable Set of all known configuration property names

See Also:

Config.getConfigSources(), ConfigSource.getPropertyNames()