Module io.helidon.data.sql.datasource.ucp

Package io.helidon.data.sql.datasource.ucp

Class UcpDataSourceConfig.BuilderBase.UcpDataSourceConfigImpl

java.lang.Object

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

io.helidon.data.sql.datasource.ucp.UcpDataSourceConfig.BuilderBase.UcpDataSourceConfigImpl

All Implemented Interfaces:

Prototype.Api, NamedService, ConnectionConfig, ProviderConfig, UcpDataSourceConfig

Enclosing class:

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

protected static class UcpDataSourceConfig.BuilderBase.UcpDataSourceConfigImpl
extends ConnectionConfig.BuilderBase.ConnectionConfigImpl
implements UcpDataSourceConfig

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.ucp.UcpDataSourceConfig

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Optional<Integer>	abandonedConnectionTimeout()	Sets the abandoned connection timeout.
Optional<Boolean>	commitOnConnectionReturn()	Sets the boolean value for the property that controls the behavior of UCP when a connection is released back to the pool with pending uncommitted changes in an active transaction.
Optional<String>	connectionFactoryClassName()	Sets the connection factory class name.
Optional<Map<String,String>>	connectionFactoryProperties()	Sets the connection factory properties on the connection factory.
Optional<Integer>	connectionHarvestMaxCount()	Sets the maximum number of connections that may be harvested when the connection harvesting occurs.
Optional<Integer>	connectionHarvestTriggerCount()	Sets the number of available connections below which the connection pool's connection harvesting will occur.
Optional<Integer>	connectionLabelingHighCost()	Sets the cost value which identifies a connection as "high-cost" for connection labeling.
Optional<String>	connectionPoolName()	Sets the connection pool name.
Optional<Map<String,String>>	connectionProperties()	Sets the connection properties on the connection factory.
Optional<Integer>	connectionRepurposeThreshold()	Sets the connection repurpose threshold for the pool.
Optional<Integer>	connectionValidationTimeout()	Sets the connection validation timeout in seconds.
Optional<Duration>	connectionWaitDuration()	Configures how much time a connection request call may wait before it either successfully returns a connection or throws an exception.
Optional<Boolean>	createConnectionInBorrowThread()	Set this flag to true to make UCP use the borrowing thread to create new connections.
Optional<String>	databaseName()	Sets the database name.
Optional<String>	dataSourceName()	Sets the data source name.
Optional<String>	description()	Sets the data source description.
boolean	equals(Object o)
Optional<Boolean>	fastConnectionFailoverEnabled()	Enables Fast Connection Failover (FCF) for the connection pool accessed using this pool-enabled data source.
int	hashCode()
Optional<Integer>	highCostConnectionReuseThreshold()	Sets the high-cost connection reuse threshold for connection labeling.
Optional<Integer>	inactiveConnectionTimeout()	Sets the inactive connection timeout.
Optional<Integer>	initialPoolSize()	Sets the initial pool size.
Optional<Integer>	maxConnectionReuseCount()	Sets the maximum connection reuse count.
Optional<Long>	maxConnectionReuseTime()	Sets the maximum connection reuse time in seconds.
Optional<Integer>	maxConnectionsPerShard()	Sets the max number of connections that can be created per shard from this connection pool.
Optional<Integer>	maxIdleTime()	Sets the maximum idle time for available connections in the pool in seconds.
Optional<Integer>	maxPoolSize()	Sets the maximum number of connections.
Optional<Integer>	maxStatements()	Sets the maximum number of statements that may be pooled or cached on a connection.
Optional<Integer>	minIdle()	Sets the minimum number of idle connections.
Optional<Integer>	minPoolSize()	Sets the minimum number of connections.
String	name()	Name of this provider.
Optional<String>	networkProtocol()	Sets the data source network protocol.
Optional<String>	onsConfiguration()	Sets the configuration string used for remote ONS subscription.
Optional<Integer>	portNumber()	Sets the database port number.
Optional<Integer>	propertyCycle()	Sets the property cycle in seconds.
Optional<Integer>	queryTimeout()	Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds.
Optional<Boolean>	readOnlyInstanceAllowed()	Sets the read-only instance allowed value on the datasource.
Optional<String>	roleName()	Sets the data source role name.
Optional<Integer>	secondsToTrustIdleConnection()	Sets the time to trust an idle connection to skip a validation test in seconds.
Optional<String>	serverName()	Sets the database server name.
Optional<Boolean>	shardingMode()	Change the mode of UCP when UCP is using a Sharded Database.
Optional<String>	sqlForValidateConnection()	Sets the SQL statement to validate the database connection.
Optional<Integer>	timeoutCheckInterval()	Sets the timeout check interval in seconds.
Optional<Integer>	timeToLiveConnectionTimeout()	Sets the maximum time a connection may remain in-use in seconds.
String	toString()
default String	type()	Type of this provider.
Optional<Boolean>	validateConnectionOnBorrow()	Makes the pool validate the connection before returning it to the user by calling the JDBC API isValid.
Optional<Boolean>	xaDataSource()	Support for distributed transactions.

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

UcpDataSourceConfigImpl

protected UcpDataSourceConfigImpl(UcpDataSourceConfig.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: UcpDataSourceConfig

Name of this provider.

Specified by:

name in interface NamedService

Specified by:

name in interface UcpDataSourceConfig

Returns:

the provider name

xaDataSource

public Optional<Boolean> xaDataSource()

Description copied from interface: UcpDataSourceConfig

Support for distributed transactions. PoolXADataSource instance is returned when true, PoolDataSource instance is returned when false. Default value is false.

Specified by:

xaDataSource in interface UcpDataSourceConfig

Returns:

whether distributed transactions are supported.

abandonedConnectionTimeout

public Optional<Integer> abandonedConnectionTimeout()

Description copied from interface: UcpDataSourceConfig

Sets the abandoned connection timeout. See PoolDataSource.setAbandonedConnectionTimeout(int) for details.

Specified by:

abandonedConnectionTimeout in interface UcpDataSourceConfig

Returns:

the abandoned connection timeout.

commitOnConnectionReturn

public Optional<Boolean> commitOnConnectionReturn()

Description copied from interface: UcpDataSourceConfig

Sets the boolean value for the property that controls the behavior of UCP when a connection is released back to the pool with pending uncommitted changes in an active transaction. See PoolDataSource.setCommitOnConnectionReturn(boolean) for details.

Specified by:

commitOnConnectionReturn in interface UcpDataSourceConfig

Returns:

true to commit, false to rollback, default value is true.

connectionFactoryClassName

public Optional<String> connectionFactoryClassName()

Description copied from interface: UcpDataSourceConfig

Sets the connection factory class name. See PoolDataSource.setConnectionFactoryClassName(String) for details.

Specified by:

connectionFactoryClassName in interface UcpDataSourceConfig

Returns:

the connection factory class name

connectionFactoryProperties

public Optional<Map<String,String>> connectionFactoryProperties()

Description copied from interface: UcpDataSourceConfig

Sets the connection factory properties on the connection factory. See PoolDataSource.setConnectionFactoryProperties(java.util.Properties) for details.

Specified by:

connectionFactoryProperties in interface UcpDataSourceConfig

Returns:

the connection factory properties

connectionHarvestMaxCount

public Optional<Integer> connectionHarvestMaxCount()

Description copied from interface: UcpDataSourceConfig

Sets the maximum number of connections that may be harvested when the connection harvesting occurs. See PoolDataSource.setConnectionHarvestMaxCount(int) for details.

Specified by:

connectionHarvestMaxCount in interface UcpDataSourceConfig

Returns:

the maximum number of connections that may be harvested

connectionHarvestTriggerCount

public Optional<Integer> connectionHarvestTriggerCount()

Description copied from interface: UcpDataSourceConfig

Sets the number of available connections below which the connection pool's connection harvesting will occur. See PoolDataSource.setConnectionHarvestTriggerCount(int) for details.

Specified by:

connectionHarvestTriggerCount in interface UcpDataSourceConfig

Returns:

the number of available connections below which the connection harvesting will occur

connectionLabelingHighCost

public Optional<Integer> connectionLabelingHighCost()

Description copied from interface: UcpDataSourceConfig

Sets the cost value which identifies a connection as "high-cost" for connection labeling. See PoolDataSource.setConnectionLabelingHighCost(int) for details.

Specified by:

connectionLabelingHighCost in interface UcpDataSourceConfig

Returns:

the cost value

connectionPoolName

public Optional<String> connectionPoolName()

Description copied from interface: UcpDataSourceConfig

Sets the connection pool name. See PoolDataSource.setConnectionPoolName(String) for details.

Specified by:

connectionPoolName in interface UcpDataSourceConfig

Returns:

the connection pool name

connectionProperties

public Optional<Map<String,String>> connectionProperties()

Description copied from interface: UcpDataSourceConfig

Sets the connection properties on the connection factory. See PoolDataSource.setConnectionProperties(java.util.Properties) for details.

Specified by:

connectionProperties in interface UcpDataSourceConfig

Returns:

the connection properties

connectionRepurposeThreshold

public Optional<Integer> connectionRepurposeThreshold()

Description copied from interface: UcpDataSourceConfig

Sets the connection repurpose threshold for the pool. See PoolDataSource.setConnectionRepurposeThreshold(int) for details.

Specified by:

connectionRepurposeThreshold in interface UcpDataSourceConfig

Returns:

the connection repurpose threshold

connectionValidationTimeout

public Optional<Integer> connectionValidationTimeout()

Description copied from interface: UcpDataSourceConfig

Sets the connection validation timeout in seconds. See PoolDataSource.setConnectionValidationTimeout(int) for details.

Specified by:

connectionValidationTimeout in interface UcpDataSourceConfig

Returns:

the connection validation timeout

connectionWaitDuration

public Optional<Duration> connectionWaitDuration()

Description copied from interface: UcpDataSourceConfig

Configures how much time a connection request call may wait before it either successfully returns a connection or throws an exception. See PoolDataSource.setConnectionWaitDuration(java.time.Duration) for details.

Specified by:

connectionWaitDuration in interface UcpDataSourceConfig

Returns:

the connection wait duration

createConnectionInBorrowThread

public Optional<Boolean> createConnectionInBorrowThread()

Description copied from interface: UcpDataSourceConfig

Set this flag to true to make UCP use the borrowing thread to create new connections. See PoolDataSource.setCreateConnectionInBorrowThread(boolean) for details.

Specified by:

createConnectionInBorrowThread in interface UcpDataSourceConfig

Returns:

whether to use the borrowing thread to create new connections

databaseName

public Optional<String> databaseName()

Description copied from interface: UcpDataSourceConfig

Sets the database name. See PoolDataSource.setDatabaseName(String) for details.

Specified by:

databaseName in interface UcpDataSourceConfig

Returns:

the database name

dataSourceName

public Optional<String> dataSourceName()

Description copied from interface: UcpDataSourceConfig

Sets the data source name. See PoolDataSource.setDataSourceName(String) for details.

Specified by:

dataSourceName in interface UcpDataSourceConfig

Returns:

the data source name

description

public Optional<String> description()

Description copied from interface: UcpDataSourceConfig

Sets the data source description. See PoolDataSource.setDescription(String) for details.

Specified by:

description in interface UcpDataSourceConfig

Returns:

the data source description

fastConnectionFailoverEnabled

public Optional<Boolean> fastConnectionFailoverEnabled()

Description copied from interface: UcpDataSourceConfig

Enables Fast Connection Failover (FCF) for the connection pool accessed using this pool-enabled data source. See PoolDataSource.setFastConnectionFailoverEnabled(boolean) for details.

Specified by:

fastConnectionFailoverEnabled in interface UcpDataSourceConfig

Returns:

whether the Fast Connection Failover (FCF) is enabled

highCostConnectionReuseThreshold

public Optional<Integer> highCostConnectionReuseThreshold()

Description copied from interface: UcpDataSourceConfig

Sets the high-cost connection reuse threshold for connection labeling. See PoolDataSource.setHighCostConnectionReuseThreshold(int) for details.

Specified by:

highCostConnectionReuseThreshold in interface UcpDataSourceConfig

Returns:

the high-cost connection reuse threshold

inactiveConnectionTimeout

public Optional<Integer> inactiveConnectionTimeout()

Description copied from interface: UcpDataSourceConfig

Sets the inactive connection timeout. See PoolDataSource.setInactiveConnectionTimeout(int) for details.

Specified by:

inactiveConnectionTimeout in interface UcpDataSourceConfig

Returns:

the inactive connection timeout

initialPoolSize

public Optional<Integer> initialPoolSize()

Description copied from interface: UcpDataSourceConfig

Sets the initial pool size. See PoolDataSource.setInitialPoolSize(int) for details.

Specified by:

initialPoolSize in interface UcpDataSourceConfig

Returns:

the initial pool size

maxConnectionReuseCount

public Optional<Integer> maxConnectionReuseCount()

Description copied from interface: UcpDataSourceConfig

Sets the maximum connection reuse count. See PoolDataSource.setMaxConnectionReuseCount(int) for details.

Specified by:

maxConnectionReuseCount in interface UcpDataSourceConfig

Returns:

the maximum connection reuse count

maxConnectionReuseTime

public Optional<Long> maxConnectionReuseTime()

Description copied from interface: UcpDataSourceConfig

Sets the maximum connection reuse time in seconds. See PoolDataSource.setMaxConnectionReuseTime(long) for details.

Specified by:

maxConnectionReuseTime in interface UcpDataSourceConfig

Returns:

the maximum connection reuse time

maxConnectionsPerShard

public Optional<Integer> maxConnectionsPerShard()

Description copied from interface: UcpDataSourceConfig

Sets the max number of connections that can be created per shard from this connection pool. See PoolDataSource.setMaxConnectionsPerShard(int) for details.

Specified by:

maxConnectionsPerShard in interface UcpDataSourceConfig

Returns:

the max number of connections to be created

maxIdleTime

public Optional<Integer> maxIdleTime()

Description copied from interface: UcpDataSourceConfig

Sets the maximum idle time for available connections in the pool in seconds. See PoolDataSource.setMaxIdleTime(int) for details.

Specified by:

maxIdleTime in interface UcpDataSourceConfig

Returns:

the maximum idle time

maxPoolSize

public Optional<Integer> maxPoolSize()

Description copied from interface: UcpDataSourceConfig

Sets the maximum number of connections. See PoolDataSource.setMaxPoolSize(int) for details.

Specified by:

maxPoolSize in interface UcpDataSourceConfig

Returns:

the maximum number of connections

minPoolSize

public Optional<Integer> minPoolSize()

Description copied from interface: UcpDataSourceConfig

Sets the minimum number of connections. See PoolDataSource.setMinPoolSize(int) for details.

Specified by:

minPoolSize in interface UcpDataSourceConfig

Returns:

the minimum number of connections

maxStatements

public Optional<Integer> maxStatements()

Description copied from interface: UcpDataSourceConfig

Sets the maximum number of statements that may be pooled or cached on a connection. See PoolDataSource.setMaxStatements(int) for details.

Specified by:

maxStatements in interface UcpDataSourceConfig

Returns:

the maximum number of statements

minIdle

public Optional<Integer> minIdle()

Description copied from interface: UcpDataSourceConfig

Sets the minimum number of idle connections. See PoolDataSource.setMinIdle(int) for details.

Specified by:

minIdle in interface UcpDataSourceConfig

Returns:

the minimum number of idle connections

networkProtocol

public Optional<String> networkProtocol()

Description copied from interface: UcpDataSourceConfig

Sets the data source network protocol. See PoolDataSource.setNetworkProtocol(String) for details.

Specified by:

networkProtocol in interface UcpDataSourceConfig

Returns:

the data source network protocol

onsConfiguration

public Optional<String> onsConfiguration()

Description copied from interface: UcpDataSourceConfig

Sets the configuration string used for remote ONS subscription. See PoolDataSource.setONSConfiguration(String) for details.

Specified by:

onsConfiguration in interface UcpDataSourceConfig

Returns:

the configuration string

portNumber

public Optional<Integer> portNumber()

Description copied from interface: UcpDataSourceConfig

Sets the database port number. See PoolDataSource.setPortNumber(int) for details.

Specified by:

portNumber in interface UcpDataSourceConfig

Returns:

the database port number

propertyCycle

public Optional<Integer> propertyCycle()

Description copied from interface: UcpDataSourceConfig

Sets the property cycle in seconds. See PoolDataSource.setPropertyCycle(int) for details.

Specified by:

propertyCycle in interface UcpDataSourceConfig

Returns:

the property cycle

queryTimeout

public Optional<Integer> queryTimeout()

Description copied from interface: UcpDataSourceConfig

Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds. See PoolDataSource.setQueryTimeout(int) for details.

Specified by:

queryTimeout in interface UcpDataSourceConfig

Returns:

the query timeout

readOnlyInstanceAllowed

public Optional<Boolean> readOnlyInstanceAllowed()

Description copied from interface: UcpDataSourceConfig

Sets the read-only instance allowed value on the datasource. See PoolDataSource.setReadOnlyInstanceAllowed(boolean) for details.

Specified by:

readOnlyInstanceAllowed in interface UcpDataSourceConfig

Returns:

the read-only instance allowed value

roleName

public Optional<String> roleName()

Description copied from interface: UcpDataSourceConfig

Sets the data source role name. See PoolDataSource.setRoleName(String) for details.

Specified by:

roleName in interface UcpDataSourceConfig

Returns:

the data source role name

secondsToTrustIdleConnection

public Optional<Integer> secondsToTrustIdleConnection()

Description copied from interface: UcpDataSourceConfig

Sets the time to trust an idle connection to skip a validation test in seconds. See PoolDataSource.setSecondsToTrustIdleConnection(int) for details.

Specified by:

secondsToTrustIdleConnection in interface UcpDataSourceConfig

Returns:

the time in seconds

serverName

public Optional<String> serverName()

Description copied from interface: UcpDataSourceConfig

Sets the database server name. See PoolDataSource.setServerName(String) for details.

Specified by:

serverName in interface UcpDataSourceConfig

Returns:

the database server name

shardingMode

public Optional<Boolean> shardingMode()

Description copied from interface: UcpDataSourceConfig

Change the mode of UCP when UCP is using a Sharded Database. See PoolDataSource.setShardingMode(boolean) for details.

Specified by:

shardingMode in interface UcpDataSourceConfig

Returns:

change the sharding mode

sqlForValidateConnection

public Optional<String> sqlForValidateConnection()

Description copied from interface: UcpDataSourceConfig

Sets the SQL statement to validate the database connection. See PoolDataSource.setSQLForValidateConnection(String) for details.

Specified by:

sqlForValidateConnection in interface UcpDataSourceConfig

Returns:

the SQL statement

timeoutCheckInterval

public Optional<Integer> timeoutCheckInterval()

Description copied from interface: UcpDataSourceConfig

Sets the timeout check interval in seconds. See PoolDataSource.setTimeoutCheckInterval(int) for details.

Specified by:

timeoutCheckInterval in interface UcpDataSourceConfig

Returns:

the timeout check interval

timeToLiveConnectionTimeout

public Optional<Integer> timeToLiveConnectionTimeout()

Description copied from interface: UcpDataSourceConfig

Sets the maximum time a connection may remain in-use in seconds. See PoolDataSource.setTimeToLiveConnectionTimeout(int) for details.

Specified by:

timeToLiveConnectionTimeout in interface UcpDataSourceConfig

Returns:

the maximum time a connection may remain in-use

validateConnectionOnBorrow

public Optional<Boolean> validateConnectionOnBorrow()

Description copied from interface: UcpDataSourceConfig

Makes the pool validate the connection before returning it to the user by calling the JDBC API isValid. See PoolDataSource.setValidateConnectionOnBorrow(boolean) for details.

Specified by:

validateConnectionOnBorrow in interface UcpDataSourceConfig

Returns:

whether to validate the connection before returning it to the user

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:

provider type - "ucp"