Package io.helidon.service.configuration.hikaricp.accs

Class HikariCPServiceConfigurationACCSProvider

java.lang.Object

io.helidon.service.configuration.api.ServiceConfigurationProvider

io.helidon.service.configuration.hikaricp.HikariCPServiceConfigurationProvider

io.helidon.service.configuration.hikaricp.accs.HikariCPServiceConfigurationACCSProvider

public class HikariCPServiceConfigurationACCSProvider
extends HikariCPServiceConfigurationProvider

A HikariCPServiceConfigurationProvider that provides HikariCPServiceConfiguration instances when running on the Oracle Application Container Cloud Service system.

Author:

Laird Nelson

See Also:

HikariCPServiceConfiguration, HikariCPServiceConfigurationProvider

Constructor Summary

Constructors

Constructor and Description
HikariCPServiceConfigurationACCSProvider() Creates a new HikariCPServiceConfigurationACCSProvider.

Method Summary

Modifier and Type	Method and Description
protected boolean	appliesTo(java.util.Properties properties, io.helidon.service.configuration.api.System system, java.util.Properties coordinates) Overrides the HikariCPServiceConfigurationProvider.appliesTo(Properties, System, Properties) method to return true if the supplied System is enabled and has a name equal to accs, and if its environment contains at least one key starting with either MYSQLCS_ or DBAAS_, and if the HikariCPServiceConfigurationProvider.appliesTo(Properties, System, Properties) method also returns true.
protected java.lang.String	getDataSourceClassName(java.lang.String jdbcUrl) Returns the name of a Java class that implements the DataSource interface that is appropriate for the supplied JDBC URL.
protected void	installDataSourceProperties(java.util.Properties target, io.helidon.service.configuration.api.System system, java.util.Properties coordinates, java.lang.String dataSourceName) Overrides the HikariCPServiceConfigurationProvider.installDataSourceProperties(Properties, System, Properties, String) to install data source-related properties discovered in the Oracle Application Container Cloud Service environment.

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

buildFor, create, 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

HikariCPServiceConfigurationACCSProvider

public HikariCPServiceConfigurationACCSProvider()

Creates a new HikariCPServiceConfigurationACCSProvider.

Method Detail

appliesTo

protected boolean appliesTo(java.util.Properties properties,
                            io.helidon.service.configuration.api.System system,
                            java.util.Properties coordinates)

Overrides the HikariCPServiceConfigurationProvider.appliesTo(Properties, System, Properties) method to return true if the supplied System is enabled and has a name equal to accs, and if its environment contains at least one key starting with either MYSQLCS_ or DBAAS_, and if the HikariCPServiceConfigurationProvider.appliesTo(Properties, System, Properties) method also returns true.

Overrides:

appliesTo in class HikariCPServiceConfigurationProvider

Parameters:

properties - a Properties instance that will be used as the basis of the HikariCPServiceConfiguration implementation that will be returned by the HikariCPServiceConfigurationProvider.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 HikariCPServiceConfigurationACCSProvider applies to the configuration space implied by the supplied parameters; false otherwise

Throws:

java.lang.NullPointerException - if properties is null

installDataSourceProperties

protected void installDataSourceProperties(java.util.Properties target,
                                           io.helidon.service.configuration.api.System system,
                                           java.util.Properties coordinates,
                                           java.lang.String dataSourceName)

Overrides the HikariCPServiceConfigurationProvider.installDataSourceProperties(Properties, System, Properties, String) to install data source-related properties discovered in the Oracle Application Container Cloud Service environment.

While reading the documentation for this method, note that the Oracle Application Container Cloud Service sets up automatic service bindings for only Oracle or MySQL databases.

This method:

1. Calls the HikariCPServiceConfigurationProvider.installDataSourceProperties(Properties, System, Properties, String) method.
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, and only if dataSourceName is null, then it sets certain properties on target.
4. Specifically, if there is a MySQL service binding and not an Oracle database service binding, the following properties will be set:
   1. javax.sql.DataSource.dataSourceClassName = com.mysql.cj.jdbc.MysqlDataSource
   2. javax.sql.DataSource.dataSource.url = jdbc:mysql://${MYSQLCS_CONNECT_STRING}
   3. javax.sql.DataSource.dataSource.description = Autodiscovered
   4. javax.sql.DataSource.dataSource.user = ${MYSQLCS_USER_NAME}
   5. javax.sql.DataSource.dataSource.password = ${MYSQLCS_PASSWORD}
5. If instead there is an Oracle database service binding, but not also a MySQL service binding, the following properties will be set:
   1. javax.sql.DataSource.dataSourceClassName = oracle.jdbc.pool.OracleDataSource
   2. javax.sql.DataSource.dataSource.url = jdbc:oracle:thin:@//${DBAAS_DEFAULT_CONNECT_DESCRIPTOR}
   3. javax.sql.DataSource.dataSource.description = Autodiscovered
   4. javax.sql.DataSource.dataSource.user = ${DBAAS_USER}
   5. javax.sql.DataSource.dataSource.password = ${DBAAS_PASSWORD}

Overrides:

installDataSourceProperties in class HikariCPServiceConfigurationProvider

Parameters:

target - a Properties instance that will be used as the basis of the HikariCPServiceConfiguration implementation that will be returned by the HikariCPServiceConfigurationProvider.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:

java.lang.NullPointerException - if target is null

See Also:

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

getDataSourceClassName

protected java.lang.String getDataSourceClassName(java.lang.String jdbcUrl)

Returns the name of a Java class that implements the DataSource interface that is appropriate for the supplied JDBC URL.

This method may return null.

Overrides of this method may return null.

Overrides of this method must return the same value for the same input.

This implementation returns com.mysql.cj.jdbc.MysqlDataSource if the supplied jdbcUrl starts with jdbc:mysql:, and returns oracle.jdbc.pool.OracleDataSource if the supplied jdbcUrl starts with jdbc:oracle:, and null in all other cases.

Parameters:

jdbcUrl - a JDBC URL in String form; must not be null

Returns:

a DataSource implementation class name, or null

Throws:

java.lang.NullPointerException - if jdbcUrl is null