Class JdbcClientConfig.BuilderBase<BUILDER extends JdbcClientConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JdbcClientConfig>

java.lang.Object

io.helidon.data.sql.common.SqlConfig.BuilderBase<BUILDER, PROTOTYPE>

io.helidon.data.jdbc.JdbcClientConfig.BuilderBase<BUILDER, PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER, PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>

Direct Known Subclasses:

JdbcClientConfig.Builder

Enclosing interface:

JdbcClientConfig

public abstract static class JdbcClientConfig.BuilderBase<BUILDER extends JdbcClientConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JdbcClientConfig>
extends SqlConfig.BuilderBase<BUILDER, PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>

Fluent API builder base for JdbcClientConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	JdbcClientConfig.BuilderBase.JdbcClientConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class SqlConfig.BuilderBase

SqlConfig.BuilderBase.SqlConfigImpl

Modifier and Type	Class	Description
protected static class	SqlConfig.BuilderBase.SqlConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(JdbcClientConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(JdbcClientConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
String	name()	Logical name of this client.
BUILDER	name(String name)	Logical name of this client.
int	parameterCountCacheCapacity()	The maximum number of SQL marker counts retained by this client must be between zero and 4096 inclusive, where zero disables retention while marker validation continues.
BUILDER	parameterCountCacheCapacity(int parameterCountCacheCapacity)	The maximum number of SQL marker counts retained by this client must be between zero and 4096 inclusive, where zero disables retention while marker validation continues.
int	parameterCountCacheMaxSqlLength()	The maximum SQL string length admitted to the parameter count cache must be a positive number of UTF-16 code units and its product with the cache capacity must not exceed 16,777,216 code units, but SQL longer than this value remains executable and is scanned without being retained.
BUILDER	parameterCountCacheMaxSqlLength(int parameterCountCacheMaxSqlLength)	The maximum SQL string length admitted to the parameter count cache must be a positive number of UTF-16 code units and its product with the cache capacity must not exceed 16,777,216 code units, but SQL longer than this value remains executable and is scanned without being retained.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class SqlConfig.BuilderBase

clearConnection, clearDataSource, clearDataSourceName, config, connection, connection, connection, connection, dataSource, dataSource, dataSource, dataSourceName, dataSourceName, from, from

Modifier and Type	Method	Description
BUILDER	clearConnection()	Clear existing value of connection.
BUILDER	clearDataSource()	Clear existing value of dataSource.
BUILDER	clearDataSourceName()	Clear existing value of dataSourceName.
protected Optional<Config>	config()	Configuration used to configure this instance.
Optional<ConnectionConfig>	connection()	Direct JDBC connection properties.
BUILDER	connection(ConnectionConfig connection)	Direct JDBC connection properties.
BUILDER	connection(Consumer<ConnectionConfig.Builder> consumer)	Direct JDBC connection properties.
BUILDER	connection(Supplier<? extends ConnectionConfig> supplier)	Direct JDBC connection properties.
Optional<DataSource>	dataSource()	Existing DataSource owned by the application.
BUILDER	dataSource(String dataSourceName)	Uses a registered data source as the connection source.
BUILDER	dataSource(DataSource dataSource)	Existing DataSource owned by the application.
Optional<String>	dataSourceName()	Name of the registered DataSource to use.
BUILDER	dataSourceName(String dataSourceName)	Name of the registered DataSource to use.
BUILDER	from(SqlConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(SqlConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.

Methods inherited from class Object

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

Methods inherited from interface Prototype.Builder

buildPrototype, self

Modifier and Type	Method	Description
PROTOTYPE	buildPrototype()	Create an instance of the Prototype.
default BUILDER	self()	Instance of this builder as the correct type.

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(JdbcClientConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(JdbcClientConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends JdbcClientConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JdbcClientConfig>

Overrides:

config in class SqlConfig.BuilderBase<BUILDER extends JdbcClientConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JdbcClientConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

name

public BUILDER name(String name)

Logical name of this client.

Parameters:

name - client name

Returns:

updated builder instance

See Also:

• name()

parameterCountCacheCapacity

public BUILDER parameterCountCacheCapacity(int parameterCountCacheCapacity)

The maximum number of SQL marker counts retained by this client must be between zero and 4096 inclusive, where zero disables retention while marker validation continues. This value is owned by Helidon Data JDBC and is not passed to JDBC.

Parameters:

parameterCountCacheCapacity - parameter count cache capacity

Returns:

updated builder instance

See Also:

• parameterCountCacheCapacity()

parameterCountCacheMaxSqlLength

public BUILDER parameterCountCacheMaxSqlLength(int parameterCountCacheMaxSqlLength)

The maximum SQL string length admitted to the parameter count cache must be a positive number of UTF-16 code units and its product with the cache capacity must not exceed 16,777,216 code units, but SQL longer than this value remains executable and is scanned without being retained. This value is owned by Helidon Data JDBC and is not passed to JDBC.

Parameters:

parameterCountCacheMaxSqlLength - maximum cacheable SQL length

Returns:

updated builder instance

See Also:

• parameterCountCacheMaxSqlLength()

name

public String name()

Logical name of this client.

Returns:

client name

parameterCountCacheCapacity

public int parameterCountCacheCapacity()

The maximum number of SQL marker counts retained by this client must be between zero and 4096 inclusive, where zero disables retention while marker validation continues. This value is owned by Helidon Data JDBC and is not passed to JDBC.

Returns:

parameter count cache capacity

parameterCountCacheMaxSqlLength

public int parameterCountCacheMaxSqlLength()

The maximum SQL string length admitted to the parameter count cache must be a positive number of UTF-16 code units and its product with the cache capacity must not exceed 16,777,216 code units, but SQL longer than this value remains executable and is scanned without being retained. This value is owned by Helidon Data JDBC and is not passed to JDBC.

Returns:

maximum cacheable SQL length

toString

public String toString()

Overrides:

toString in class SqlConfig.BuilderBase<BUILDER extends JdbcClientConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JdbcClientConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class SqlConfig.BuilderBase<BUILDER extends JdbcClientConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JdbcClientConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class SqlConfig.BuilderBase<BUILDER extends JdbcClientConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JdbcClientConfig>