Interface ConnectionConfig

All Superinterfaces:

Prototype.Api

All Known Subinterfaces:

HikariDataSourceConfig, io.helidon.data.sql.datasource.hikari.HikariDataSourceConfigBlueprint, JdbcDataSourceConfig, io.helidon.data.sql.datasource.jdbc.JdbcDataSourceConfigBlueprint, UcpDataSourceConfig, io.helidon.data.sql.datasource.ucp.UcpDataSourceConfigBlueprint

All Known Implementing Classes:

ConnectionConfig.BuilderBase.ConnectionConfigImpl, HikariDataSourceConfig.BuilderBase.HikariDataSourceConfigImpl, JdbcDataSourceConfig.BuilderBase.JdbcDataSourceConfigImpl, UcpDataSourceConfig.BuilderBase.UcpDataSourceConfigImpl

public interface ConnectionConfig
extends Prototype.Api

Configuration of a JDBC connection to a database.

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ConnectionConfig.Builder	Fluent API builder for ConnectionConfig.
static class	ConnectionConfig.BuilderBase<BUILDER extends ConnectionConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends ConnectionConfig>	Fluent API builder base for ConnectionConfig.

Method Summary

Modifier and Type	Method	Description
static ConnectionConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static ConnectionConfig.Builder	builder(ConnectionConfig instance)	Create a new fluent API builder from an existing instance.
static ConnectionConfig	create()	Create a new instance with default values.
static ConnectionConfig	create(Config config)	Create a new instance from configuration.
Optional<String>	jdbcDriverClassName()	Fully qualified name of the JDBC driver class.
Optional<char[]>	password()	Password for the database connection.
String	url()	JDBC connection URL.
Optional<String>	username()	Username for the database connection.

Method Details

builder

static ConnectionConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ConnectionConfig.Builder builder(ConnectionConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static ConnectionConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static ConnectionConfig create()

Create a new instance with default values.

Returns:

a new instance

url

String url()

JDBC connection URL.

This value is required and must not be empty.

Returns:

JDBC connection URL

username

Optional<String> username()

Username for the database connection.

Returns:

the username

password

Optional<char[]> password()

Password for the database connection.

Returns:

the password

jdbcDriverClassName

Optional<String> jdbcDriverClassName()

Fully qualified name of the JDBC driver class.

Returns:

configured JDBC driver class name