Package io.helidon.service.configuration.hikaricp.localhost

Class HikariCPServiceConfigurationLocalhostProvider

java.lang.Object

io.helidon.service.configuration.api.ServiceConfigurationProvider

io.helidon.service.configuration.hikaricp.HikariCPServiceConfigurationProvider

io.helidon.service.configuration.hikaricp.localhost.HikariCPServiceConfigurationLocalhostProvider

public class HikariCPServiceConfigurationLocalhostProvider
extends HikariCPServiceConfigurationProvider

A HikariCPServiceConfigurationProvider that automatically creates in-memory H2 databases as needed.

Author:

Laird Nelson

See Also:

installDataSourceProperties(Properties, System, Properties, String), HikariCPServiceConfigurationLocalhost, HikariCPServiceConfigurationProvider

Constructor Summary

Constructors

Constructor and Description
HikariCPServiceConfigurationLocalhostProvider() Creates a new HikariCPServiceConfigurationProvider.

Method Summary

Modifier and Type	Method and Description
protected boolean	appliesTo(Properties properties, System system, Properties coordinates) Overrides the HikariCPServiceConfigurationProvider.appliesTo(Properties, System, Properties) method to return true if the supplied System is enabled and an instance of LocalhostSystem and if the HikariCPServiceConfigurationProvider.appliesTo(Properties, System, Properties) method returns true.
protected HikariCPServiceConfiguration	create(Properties properties, System system, Properties coordinates) Overrides the HikariCPServiceConfigurationProvider.create(Properties, System, Properties) method to return a new HikariCPServiceConfigurationLocalhost instance when invoked.
protected void	installDataSourceProperties(Properties target, System system, Properties coordinates, String dataSourceName) Overrides the HikariCPServiceConfigurationProvider.installDataSourceProperties(Properties, System, Properties, String) method to automatically create in-memory H2 databases as needed.

Methods inherited from class io.helidon.service.configuration.hikaricp.HikariCPServiceConfigurationProvider

buildFor, getDataSourceProperty, getPrefix

Methods inherited from class io.helidon.service.configuration.api.ServiceConfigurationProvider

getAuthoritativeSystem, getServiceIdentifier

Methods inherited from class java.lang.Object

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

Constructor Detail

HikariCPServiceConfigurationLocalhostProvider

public HikariCPServiceConfigurationLocalhostProvider()

Creates a new HikariCPServiceConfigurationProvider.

Method Detail

create

protected HikariCPServiceConfiguration create(Properties properties,
                                              System system,
                                              Properties coordinates)

Overrides the HikariCPServiceConfigurationProvider.create(Properties, System, Properties) method to return a new HikariCPServiceConfigurationLocalhost instance when invoked.

This method never returns null.

Overrides of this method must not return null.

This method returns a new HikariCPServiceConfigurationLocalhost instance with each invocation.

Overrides of this method must return a new HikariCPServiceConfiguration implementation of some kind.

Overrides:

create in class HikariCPServiceConfigurationProvider

Parameters:

properties - a Properties instance that will be used as the basis of the HikariCPServiceConfigurationLocalhost implementation that will be returned; must not be null

system - a System determined to be in effect; may, strictly speaking, be null but ordinarily is non-null and enabled

coordinates - a Properties instance representing the meta-properties in effect; may be null

Returns:

a new HikariCPServiceConfigurationLocalhost instance; never null

Throws:

NullPointerException - if properties is null

See Also:

HikariCPServiceConfiguration(Properties, System, Properties), HikariCPServiceConfigurationProvider.buildFor(Set, Properties), HikariCPServiceConfigurationProvider.appliesTo(Properties, System, Properties)

appliesTo

protected boolean appliesTo(Properties properties,
                            System system,
                            Properties coordinates)

Overrides the HikariCPServiceConfigurationProvider.appliesTo(Properties, System, Properties) method to return true if the supplied System is enabled and an instance of LocalhostSystem and if the HikariCPServiceConfigurationProvider.appliesTo(Properties, System, Properties) method returns true.

Overrides:

appliesTo in class HikariCPServiceConfigurationProvider

Parameters:

properties - a Properties instance that will be used as the basis of the HikariCPServiceConfigurationLocalhost implementation that will be returned by the create(Properties, System, Properties) method; must not be null

system - a System determined to be in effect; may, strictly speaking, be null but ordinarily is non-null and enabled

coordinates - a Properties instance representing the meta-properties in effect; may be null

Returns:

true if this HikariCPServiceConfigurationLocalhostProvider applies to the configuration space implied by the supplied parameters; false otherwise

See Also:

HikariCPServiceConfigurationProvider.appliesTo(Properties, System, Properties)

installDataSourceProperties

protected void installDataSourceProperties(Properties target,
                                           System system,
                                           Properties coordinates,
                                           String dataSourceName)

Overrides the HikariCPServiceConfigurationProvider.installDataSourceProperties(Properties, System, Properties, String) method to automatically create in-memory H2 databases as needed.

Specifically, this method:

1. Calls the HikariCPServiceConfigurationProvider.installDataSourceProperties(Properties, System, Properties, String) method with the supplied parameters.
2. Checks to see if a property named javax.sql.DataSource.dataSourceName.explicitlyConfigured has a String value equal to anything other than true, including null.
3. If so, then it sets certain properties on target as follows:
   1. javax.sql.DataSource.dataSourceName.dataSourceClassName = org.h2.jdbcx.JdbcDataSource
   2. javax.sql.DataSource.dataSourceName.dataSource.description = A local, transient, in-memory H2 database
   3. javax.sql.DataSource.dataSourceName.dataSource.user = sa
   4. javax.sql.DataSource.dataSourceName.dataSource.password =
   5. javax.sql.DataSource.dataSourceName.dataSourceUrl = jdbc:h2:mem:dataSourceName

Overrides:

installDataSourceProperties in class HikariCPServiceConfigurationProvider

Parameters:

target - a Properties instance that will be used as the basis of the HikariCPServiceConfigurationLocalhost implementation that will be returned by the create(Properties, System, Properties) method and into which properties may be installed; must not be null

system - a System determined to be in effect; may, strictly speaking, be null but ordinarily is non-null and enabled

coordinates - a Properties instance representing the meta-properties in effect; may be null

dataSourceName - the data source name in question; may be null

Throws:

NullPointerException - if target is null

See Also:

HikariCPServiceConfigurationProvider.installDataSourceProperties(Properties, System, Properties, String)