Module io.helidon.integrations.datasource.cdi

Package io.helidon.integrations.datasource.cdi

Class AbstractDataSourceExtension

java.lang.Object

io.helidon.integrations.cdi.configurable.AbstractConfigurableExtension<DataSource>

io.helidon.integrations.datasource.cdi.AbstractDataSourceExtension

All Implemented Interfaces:

Extension

Direct Known Subclasses:

HikariCPBackedDataSourceExtension, UCPBackedDataSourceExtension

public abstract class AbstractDataSourceExtension
extends AbstractConfigurableExtension<DataSource>

An AbstractConfigurableExtension 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 final Config	getConfig()	Deprecated. This method exists for backwards compatibility only and has no replacement.
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 final Set<String>	getDataSourceNames()	Deprecated. This method exists for backwards compatibility only.
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 final Set<String>	getPropertyNames()	Deprecated. This method exists for backwards compatibility only.
protected final void	initializeMasterProperties()	Deprecated. This method exists for backwards compatibility only.
protected final Matcher	matcher(String configPropertyName)	Returns a Matcher given a configuration property name that can logically identify and provide access to at least its three component names.
protected final String	name(Matcher propertyPatternMatcher)	Given a Matcher that has been produced by the AbstractConfigurableExtension.matcher(String) method, returns the relevant name.
protected final String	propertyName(Matcher propertyPatternMatcher)	Given a Matcher that has been produced by the AbstractConfigurableExtension.matcher(String) method, returns the relevant property name, or null if there is no such property name.
protected final Properties	putDataSourceProperties(String dataSourceName, Properties properties)	Deprecated. This method exists for backwards compatibility only.

Methods inherited from class io.helidon.integrations.cdi.configurable.AbstractConfigurableExtension

addBean, configPropertyNames, configPropertyValue, initializeNamedProperties, names, put

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractDataSourceExtension

protected AbstractDataSourceExtension()

Creates a new AbstractDataSourceExtension.

Method Details

getConfig

@Deprecated
protected final Config getConfig()

Deprecated.

This method exists for backwards compatibility only and has no replacement.

Returns the Config instance used to acquire configuration property values.

This method never returns null.

This method exists for backwards compatibility only and its usage is discouraged.

Returns:

a non-null Config instance

getPropertyNames

@Deprecated
protected final Set<String> getPropertyNames()

Deprecated.

This method exists for backwards compatibility only. Please use the AbstractConfigurableExtension.configPropertyNames() method instead.

Calls the AbstractConfigurableExtension.configPropertyNames() method and returns its return value.

This method never returns null.

This method exists for backwards compatibility only and the AbstractConfigurableExtension.configPropertyNames() method is preferred.

Returns:

the return value of an invocation of the AbstractConfigurableExtension.configPropertyNames() method

See Also:

• AbstractConfigurableExtension.configPropertyNames()

matcher

protected final Matcher matcher(String configPropertyName)

Description copied from class: AbstractConfigurableExtension

Returns a Matcher given a configuration property name that can logically identify and provide access to at least its three component names.

Implementations of this method must not return null.

Given a String that is a configuration property name, like com.foo.Bar.name.propertyName, any implementation of this method must return a non-null Matcher that is capable of being supplied to the AbstractConfigurableExtension.name(Matcher) and AbstractConfigurableExtension.propertyName(Matcher) methods.

Specified by:

matcher in class AbstractConfigurableExtension<DataSource>

Parameters:

configPropertyName - a configuration property name that logically contains a type name, a name and a property name; must not be null

Returns:

a non-null Matcher

See Also:

• AbstractConfigurableExtension.name(Matcher)
• AbstractConfigurableExtension.propertyName(Matcher)

getDataSourcePropertyPatternMatcher

protected abstract Matcher getDataSourcePropertyPatternMatcher(String configPropertyName)

Returns a Matcher for a property name.

Implementations of this method must not return null.

Implementations of this method must not invoke the matcher(String) method or an infinite loop may result.

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)

name

protected final String name(Matcher propertyPatternMatcher)

Description copied from class: AbstractConfigurableExtension

Given a Matcher that has been produced by the AbstractConfigurableExtension.matcher(String) method, returns the relevant name.

Implementations of this method may return null.

Specified by:

name in class AbstractConfigurableExtension<DataSource>

Parameters:

propertyPatternMatcher - a Matcher produced by the AbstractConfigurableExtension.matcher(String) method; must not be null

Returns:

a name, or null

See Also:

• AbstractConfigurableExtension.matcher(String)

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.

Implementations of this method must not invoke the name(Matcher) method or an infinite loop may result.

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)

propertyName

protected final String propertyName(Matcher propertyPatternMatcher)

Description copied from class: AbstractConfigurableExtension

Given a Matcher that has been produced by the AbstractConfigurableExtension.matcher(String) method, returns the relevant property name, or null if there is no such property name.

Most implementations of this method will use the Matcher.group(int) method to produce the required property name.

Implementations of this method may return null.

Specified by:

propertyName in class AbstractConfigurableExtension<DataSource>

Parameters:

propertyPatternMatcher - a Matcher produced by the AbstractConfigurableExtension.matcher(String) method; must not be null

Returns:

a property name, or null

See Also:

• AbstractConfigurableExtension.matcher(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.

Implementations of this method must not invoke the propertyName(Matcher) method or an infinite loop may result.

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)

getDataSourceNames

@Deprecated
protected final Set<String> getDataSourceNames()

Deprecated.

This method exists for backwards compatibility only. Please use the AbstractConfigurableExtension.names() method instead.

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

@Deprecated
protected final Properties putDataSourceProperties(String dataSourceName,
 Properties properties)

Deprecated.

This method exists for backwards compatibility only. Please use the AbstractConfigurableExtension.put(String, Properties) method instead.

Adds additional synthesized properties to an internal map of data source properties whose contents will be processed eventually by the AbstractConfigurableExtension.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; must not be null

Returns:

the prior Properties indexed under the supplied dataSourceName, or null

Throws:

NullPointerException - if properties is null

initializeMasterProperties

@Deprecated
protected final void initializeMasterProperties()

Deprecated.

This method exists for backwards compatibility only. Please use the AbstractConfigurableExtension.initializeNamedProperties() method instead.

Calls the AbstractConfigurableExtension.initializeNamedProperties() method.