Module io.helidon.data.sql.datasource.jdbc

Package io.helidon.data.sql.datasource.jdbc

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

java.lang.Object

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

io.helidon.data.sql.datasource.jdbc.JdbcDataSourceConfig.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>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

JdbcDataSourceConfig.Builder

Enclosing interface:

JdbcDataSourceConfig

public abstract static class JdbcDataSourceConfig.BuilderBase<BUILDER extends JdbcDataSourceConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcDataSourceConfig>
extends ConnectionConfig.BuilderBase<BUILDER,PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for JdbcDataSourceConfig.

Nested Class Summary

Nested Classes

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

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

ConnectionConfig.BuilderBase.ConnectionConfigImpl

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BUILDER	addProperties(Map<String,String> properties)	Add properties (name/value pair) that will be used to configure the DataSource/Driver.
Optional<Boolean>	autoCommit()	Set the default auto-commit behavior of create connections.
BUILDER	autoCommit(boolean autoCommit)	Set the default auto-commit behavior of create connections.
Optional<String>	catalog()	Set the default catalog name to be set on connections.
BUILDER	catalog(String catalog)	Set the default catalog name to be set on connections.
BUILDER	clearAutoCommit()	Clear existing value of this property.
BUILDER	clearCatalog()	Clear existing value of this property.
BUILDER	clearReadOnly()	Clear existing value of this property.
BUILDER	clearSchema()	Clear existing value of this property.
BUILDER	clearTransactionIsolation()	Clear existing value of this property.
Optional<Config>	config()	If this instance was configured, this would be the config instance used.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(JdbcDataSourceConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(JdbcDataSourceConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
String	name()	Name of this provider.
BUILDER	name(String name)	Name of this provider.
protected void	preBuildPrototype()	Handles providers and decorators.
Map<String,String>	properties()	Add properties (name/value pair) that will be used to configure the DataSource/Driver.
BUILDER	properties(Map<String,String> properties)	Add properties (name/value pair) that will be used to configure the DataSource/Driver.
BUILDER	putProperty(String key, String property)	Add properties (name/value pair) that will be used to configure the DataSource/Driver.
Optional<Boolean>	readOnly()	Whether the connection should be read only.
BUILDER	readOnly(boolean readOnly)	Whether the connection should be read only.
Optional<String>	schema()	Set the default schema name to be set on connections.
BUILDER	schema(String schema)	Set the default schema name to be set on connections.
String	toString()
Optional<TransactionIsolation>	transactionIsolation()	Set the default transaction isolation level.
BUILDER	transactionIsolation(TransactionIsolation transactionIsolation)	Set the default transaction isolation level.
protected void	validatePrototype()	Validates required properties.

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

clearJdbcDriverClassName, clearPassword, clearUsername, from, from, jdbcDriverClassName, jdbcDriverClassName, password, password, password, url, url, username, username

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(JdbcDataSourceConfig 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(JdbcDataSourceConfig.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

@Deprecated
public BUILDER config(Config config)

Deprecated.

use config(io.helidon.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 JdbcDataSourceConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcDataSourceConfig>

Overrides:

config in class ConnectionConfig.BuilderBase<BUILDER extends JdbcDataSourceConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcDataSourceConfig>

Parameters:

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

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 JdbcDataSourceConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcDataSourceConfig>

Overrides:

config in class ConnectionConfig.BuilderBase<BUILDER extends JdbcDataSourceConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcDataSourceConfig>

Parameters:

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

Returns:

updated builder instance

name

public BUILDER name(String name)

Name of this provider.

Parameters:

name - the provider name

Returns:

updated builder instance

See Also:

• name()

clearAutoCommit

public BUILDER clearAutoCommit()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• autoCommit()

autoCommit

public BUILDER autoCommit(boolean autoCommit)

Set the default auto-commit behavior of create connections.

Parameters:

autoCommit - the desired auto-commit default for connections

Returns:

updated builder instance

See Also:

• autoCommit()

clearCatalog

public BUILDER clearCatalog()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• catalog()

catalog

public BUILDER catalog(String catalog)

Set the default catalog name to be set on connections.

Parameters:

catalog - the default catalog name

Returns:

updated builder instance

See Also:

• catalog()

clearReadOnly

public BUILDER clearReadOnly()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• readOnly()

readOnly

public BUILDER readOnly(boolean readOnly)

Whether the connection should be read only.

Parameters:

readOnly - if read only

Returns:

updated builder instance

See Also:

• readOnly()

clearSchema

public BUILDER clearSchema()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• schema()

schema

public BUILDER schema(String schema)

Set the default schema name to be set on connections.

Parameters:

schema - the name of the default schema

Returns:

updated builder instance

See Also:

• schema()

clearTransactionIsolation

public BUILDER clearTransactionIsolation()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• transactionIsolation()

transactionIsolation

public BUILDER transactionIsolation(TransactionIsolation transactionIsolation)

Set the default transaction isolation level.

Parameters:

transactionIsolation - the isolation level

Returns:

updated builder instance

See Also:

• transactionIsolation()

properties

public BUILDER properties(Map<String,String> properties)

Add properties (name/value pair) that will be used to configure the DataSource/Driver. Property values are limited to String values. This method replaces all values with the new ones.

Parameters:

properties - the properties

Returns:

updated builder instance

See Also:

• properties()

addProperties

public BUILDER addProperties(Map<String,String> properties)

Add properties (name/value pair) that will be used to configure the DataSource/Driver. Property values are limited to String values. This method keeps existing values, then puts all new values into the map.

Parameters:

properties - the properties

Returns:

updated builder instance

See Also:

• properties()

putProperty

public BUILDER putProperty(String key,
 String property)

Add properties (name/value pair) that will be used to configure the DataSource/Driver. Property values are limited to String values. This method adds a new value to the map, or replaces it if the key already exists.

Parameters:

key - key to add or replace

property - new value for the key

Returns:

updated builder instance

See Also:

• properties()

name

public String name()

Name of this provider.

Returns:

the name

autoCommit

public Optional<Boolean> autoCommit()

Set the default auto-commit behavior of create connections.

Returns:

the auto commit

catalog

public Optional<String> catalog()

Set the default catalog name to be set on connections.

Returns:

the catalog

readOnly

public Optional<Boolean> readOnly()

Whether the connection should be read only.

Returns:

the read only

schema

public Optional<String> schema()

Set the default schema name to be set on connections.

Returns:

the schema

transactionIsolation

public Optional<TransactionIsolation> transactionIsolation()

Set the default transaction isolation level.

Returns:

the transaction isolation

properties

public Map<String,String> properties()

Add properties (name/value pair) that will be used to configure the DataSource/Driver. Property values are limited to String values.

Returns:

the properties

config

public Optional<Config> config()

If this instance was configured, this would be the config instance used.

Overrides:

config in class ConnectionConfig.BuilderBase<BUILDER extends JdbcDataSourceConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcDataSourceConfig>

Returns:

config node used to configure this builder, or empty if not configured

toString

public String toString()

Overrides:

toString in class ConnectionConfig.BuilderBase<BUILDER extends JdbcDataSourceConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcDataSourceConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class ConnectionConfig.BuilderBase<BUILDER extends JdbcDataSourceConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcDataSourceConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class ConnectionConfig.BuilderBase<BUILDER extends JdbcDataSourceConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcDataSourceConfig>