Module io.helidon.data.sql.datasource.hikari

Package io.helidon.data.sql.datasource.hikari

Class HikariDataSourceConfig.BuilderBase.HikariDataSourceConfigImpl

java.lang.Object

io.helidon.data.sql.common.ConnectionConfig.BuilderBase.ConnectionConfigImpl

io.helidon.data.sql.datasource.hikari.HikariDataSourceConfig.BuilderBase.HikariDataSourceConfigImpl

All Implemented Interfaces:

Prototype.Api, NamedService, ConnectionConfig, HikariDataSourceConfig, ProviderConfig

Enclosing class:

HikariDataSourceConfig.BuilderBase<BUILDER extends HikariDataSourceConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HikariDataSourceConfig>

protected static class HikariDataSourceConfig.BuilderBase.HikariDataSourceConfigImpl
extends ConnectionConfig.BuilderBase.ConnectionConfigImpl
implements HikariDataSourceConfig

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.data.sql.common.ConnectionConfig

ConnectionConfig.Builder, ConnectionConfig.BuilderBase<BUILDER extends ConnectionConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConnectionConfig>

Nested classes/interfaces inherited from interface io.helidon.data.sql.datasource.hikari.HikariDataSourceConfig

HikariDataSourceConfig.Builder, HikariDataSourceConfig.BuilderBase<BUILDER extends HikariDataSourceConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HikariDataSourceConfig>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HikariDataSourceConfigImpl(HikariDataSourceConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	allowPoolSuspension()	Set whether pool suspension is allowed.
Optional<Boolean>	autoCommit()	Set the default auto-commit behavior of connections in the pool.
Optional<String>	catalog()	Set the default catalog name to be set on connections.
Optional<String>	connectionInitSql()	Set the SQL string that will be executed on all new connections when they are created, before they are added to the pool.
Optional<String>	connectionTestQuery()	Set the SQL query to be executed to test the validity of connections.
Optional<Long>	connectionTimeout()	Set the maximum number of milliseconds that a client will wait for a connection from the pool.
boolean	equals(Object o)
int	hashCode()
Map<String,String>	healthCheckProperties()	Add properties (name/value pair) that will be used to configure the connection pool health check.
Optional<Long>	idleTimeout()	This property controls the maximum amount of time that a connection is allowed to sit idle in the pool.
Optional<Long>	initializationFailTimeout()	Set the pool initialization failure timeout.
Optional<Boolean>	isolateInternalQueries()	Configure whether internal pool queries, principally aliveness checks, will be isolated in their own transaction via Connection.rollback().
Optional<Long>	keepaliveTime()	This property controls the keepalive interval for a connection in the pool.
Optional<Long>	leakDetectionThreshold()	This property controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
Optional<Integer>	maximumPoolSize()	The property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections.
Optional<Long>	maxLifetime()	This property controls the maximum lifetime of a connection in the pool.
Optional<Integer>	minimumIdle()	The property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, including both idle and in-use connections.
String	name()	Name of this provider.
Optional<String>	poolName()	Set the name of the connection pool.
Map<String,String>	properties()	Add properties (name/value pair) that will be used to configure the DataSource/Driver.
Optional<Boolean>	readOnly()	Configures the Connections to be added to the pool as read-only Connections.
Optional<Boolean>	registerMbeans()	Configures whether HikariCP self-registers the HikariConfigMXBean and HikariPoolMXBean in JMX.
Optional<String>	schema()	Set the default schema name to be set on connections.
String	toString()
Optional<TransactionIsolation>	transactionIsolation()	Set the default transaction isolation level.
default String	type()	Type of this provider.
Optional<Long>	validationTimeout()	Sets the maximum number of milliseconds that the pool will wait for a connection to be validated as alive.

Methods inherited from class io.helidon.data.sql.common.ConnectionConfig.BuilderBase.ConnectionConfigImpl

jdbcDriverClassName, password, url, username

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.helidon.data.sql.common.ConnectionConfig

jdbcDriverClassName, password, url, username

Constructor Details

HikariDataSourceConfigImpl

protected HikariDataSourceConfigImpl(HikariDataSourceConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

name

public String name()

Description copied from interface: HikariDataSourceConfig

Name of this provider.

Specified by:

name in interface HikariDataSourceConfig

Specified by:

name in interface NamedService

Returns:

the provider name

allowPoolSuspension

public Optional<Boolean> allowPoolSuspension()

Description copied from interface: HikariDataSourceConfig

Set whether pool suspension is allowed. See HikariConfig.setAllowPoolSuspension(boolean) for details.

Specified by:

allowPoolSuspension in interface HikariDataSourceConfig

Returns:

the desired pool suspension allowance

autoCommit

public Optional<Boolean> autoCommit()

Description copied from interface: HikariDataSourceConfig

Set the default auto-commit behavior of connections in the pool. See HikariConfig.setAutoCommit(boolean) for details.

Specified by:

autoCommit in interface HikariDataSourceConfig

Returns:

the desired auto-commit default for connections

catalog

public Optional<String> catalog()

Description copied from interface: HikariDataSourceConfig

Set the default catalog name to be set on connections. See HikariConfig.setCatalog(String) for details.

Specified by:

catalog in interface HikariDataSourceConfig

Returns:

the default catalog name

connectionInitSql

public Optional<String> connectionInitSql()

Description copied from interface: HikariDataSourceConfig

Set the SQL string that will be executed on all new connections when they are created, before they are added to the pool. See HikariConfig.setConnectionInitSql(String) for details.

Specified by:

connectionInitSql in interface HikariDataSourceConfig

Returns:

the SQL to execute on new connections

connectionTestQuery

public Optional<String> connectionTestQuery()

Description copied from interface: HikariDataSourceConfig

Set the SQL query to be executed to test the validity of connections. See HikariConfig.setConnectionTestQuery(String) for details.

Specified by:

connectionTestQuery in interface HikariDataSourceConfig

Returns:

a SQL query string

connectionTimeout

public Optional<Long> connectionTimeout()

Description copied from interface: HikariDataSourceConfig

Set the maximum number of milliseconds that a client will wait for a connection from the pool. See HikariConfig.setConnectionTimeout(long) for details.

Specified by:

connectionTimeout in interface HikariDataSourceConfig

Returns:

the connection timeout in milliseconds

healthCheckProperties

public Map<String,String> healthCheckProperties()

Description copied from interface: HikariDataSourceConfig

Add properties (name/value pair) that will be used to configure the connection pool health check. See HikariConfig.addHealthCheckProperty(String, String) for details.

Specified by:

healthCheckProperties in interface HikariDataSourceConfig

Returns:

the health check properties

idleTimeout

public Optional<Long> idleTimeout()

Description copied from interface: HikariDataSourceConfig

This property controls the maximum amount of time that a connection is allowed to sit idle in the pool. See HikariConfig.setIdleTimeout(long) for details.

Specified by:

idleTimeout in interface HikariDataSourceConfig

Returns:

the idle timeout in milliseconds

initializationFailTimeout

public Optional<Long> initializationFailTimeout()

Description copied from interface: HikariDataSourceConfig

Set the pool initialization failure timeout. See HikariConfig.setInitializationFailTimeout(long) for details.

Specified by:

initializationFailTimeout in interface HikariDataSourceConfig

Returns:

the number of milliseconds before the pool initialization fails, or 0 to validate connection setup but continue with pool start, or less than zero to skip all initialization checks and start the pool without delay

isolateInternalQueries

public Optional<Boolean> isolateInternalQueries()

Description copied from interface: HikariDataSourceConfig

Configure whether internal pool queries, principally aliveness checks, will be isolated in their own transaction via Connection.rollback(). See HikariConfig.setIsolateInternalQueries(boolean) for details.

Specified by:

isolateInternalQueries in interface HikariDataSourceConfig

Returns:

true if internal pool queries should be isolated, false if not

keepaliveTime

public Optional<Long> keepaliveTime()

Description copied from interface: HikariDataSourceConfig

This property controls the keepalive interval for a connection in the pool. See HikariConfig.setKeepaliveTime(long) for details.

Specified by:

keepaliveTime in interface HikariDataSourceConfig

Returns:

the interval in which connections will be tested for aliveness, thus keeping them alive by the act of checking. Value is in milliseconds.

leakDetectionThreshold

public Optional<Long> leakDetectionThreshold()

Description copied from interface: HikariDataSourceConfig

This property controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak. See HikariConfig.setLeakDetectionThreshold(long) for details.

Specified by:

leakDetectionThreshold in interface HikariDataSourceConfig

Returns:

the connection leak detection threshold in milliseconds

maximumPoolSize

public Optional<Integer> maximumPoolSize()

Description copied from interface: HikariDataSourceConfig

The property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections. See HikariConfig.setMaximumPoolSize(int) for details.

Specified by:

maximumPoolSize in interface HikariDataSourceConfig

Returns:

the maximum number of connections in the pool

maxLifetime

public Optional<Long> maxLifetime()

Description copied from interface: HikariDataSourceConfig

This property controls the maximum lifetime of a connection in the pool. See HikariConfig.setMaxLifetime(long) for details.

Specified by:

maxLifetime in interface HikariDataSourceConfig

Returns:

the maximum connection lifetime in milliseconds

minimumIdle

public Optional<Integer> minimumIdle()

Description copied from interface: HikariDataSourceConfig

The property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, including both idle and in-use connections. See HikariConfig.setMinimumIdle(int) for details.

Specified by:

minimumIdle in interface HikariDataSourceConfig

Returns:

the minimum number of idle connections in the pool to maintain

poolName

public Optional<String> poolName()

Description copied from interface: HikariDataSourceConfig

Set the name of the connection pool. See HikariConfig.setPoolName(String) for details.

Specified by:

poolName in interface HikariDataSourceConfig

Returns:

the name of the connection pool

readOnly

public Optional<Boolean> readOnly()

Description copied from interface: HikariDataSourceConfig

Configures the Connections to be added to the pool as read-only Connections. See HikariConfig.setReadOnly(boolean) for details.

Specified by:

readOnly in interface HikariDataSourceConfig

Returns:

true if the Connections in the pool are read-only, false if not

registerMbeans

public Optional<Boolean> registerMbeans()

Description copied from interface: HikariDataSourceConfig

Configures whether HikariCP self-registers the HikariConfigMXBean and HikariPoolMXBean in JMX. See HikariConfig.setRegisterMbeans(boolean) for details.

Specified by:

registerMbeans in interface HikariDataSourceConfig

Returns:

true if HikariCP should register MXBeans, false if it should not

schema

public Optional<String> schema()

Description copied from interface: HikariDataSourceConfig

Set the default schema name to be set on connections. See HikariConfig.setSchema(String) for details.

Specified by:

schema in interface HikariDataSourceConfig

Returns:

the name of the default schema

transactionIsolation

public Optional<TransactionIsolation> transactionIsolation()

Description copied from interface: HikariDataSourceConfig

Set the default transaction isolation level. See HikariConfig.setTransactionIsolation(String) for details.

Specified by:

transactionIsolation in interface HikariDataSourceConfig

Returns:

the isolation level

validationTimeout

public Optional<Long> validationTimeout()

Description copied from interface: HikariDataSourceConfig

Sets the maximum number of milliseconds that the pool will wait for a connection to be validated as alive. See HikariConfig.setValidationTimeout(long) for details.

Specified by:

validationTimeout in interface HikariDataSourceConfig

Returns:

the validation timeout in milliseconds

properties

public Map<String,String> properties()

Description copied from interface: HikariDataSourceConfig

Add properties (name/value pair) that will be used to configure the DataSource/Driver. Property values are limited to String values. See HikariConfig.addDataSourceProperty(String, Object) for details.

Specified by:

properties in interface HikariDataSourceConfig

Returns:

the properties

toString

public String toString()

Overrides:

toString in class ConnectionConfig.BuilderBase.ConnectionConfigImpl

equals

public boolean equals(Object o)

Overrides:

equals in class ConnectionConfig.BuilderBase.ConnectionConfigImpl

hashCode

public int hashCode()

Overrides:

hashCode in class ConnectionConfig.BuilderBase.ConnectionConfigImpl

type

default String type()

Type of this provider.

Specified by:

type in interface NamedService

Returns:

the provider type - "hikari"