io.asyncer.r2dbc.mysql

Class MySqlConnectionConfiguration.Builder

java.lang.Object

io.asyncer.r2dbc.mysql.MySqlConnectionConfiguration.Builder

Enclosing class:

MySqlConnectionConfiguration

public static final class MySqlConnectionConfiguration.Builder
extends Object

A builder for MySqlConnectionConfiguration creation.

Method Summary

Modifier and Type	Method and Description
MySqlConnectionConfiguration.Builder	autodetectExtensions(boolean enabled) Configures whether to use ServiceLoader to discover and register extensions.
MySqlConnectionConfiguration	build() Builds an immutable MySqlConnectionConfiguration with current options.
MySqlConnectionConfiguration.Builder	connectTimeout(@Nullable Duration connectTimeout) Configure the connection timeout.
MySqlConnectionConfiguration.Builder	database(@Nullable String database) Configure the database.
MySqlConnectionConfiguration.Builder	extendWith(Extension extension) Registers a Extension to extend driver functionality and manually.
MySqlConnectionConfiguration.Builder	host(String host) Configure the host.
MySqlConnectionConfiguration.Builder	password(@Nullable CharSequence password) Configure the password, MySQL allows to login without password.
MySqlConnectionConfiguration.Builder	passwordPublisher(Publisher<String> passwordPublisher) Registers a password publisher function.
MySqlConnectionConfiguration.Builder	port(int port) Configure the port.
MySqlConnectionConfiguration.Builder	prepareCacheSize(int prepareCacheSize) Configures the maximum size of the server-preparing cache.
MySqlConnectionConfiguration.Builder	queryCacheSize(int queryCacheSize) Configures the maximum size of the Query parsing cache.
MySqlConnectionConfiguration.Builder	serverZoneId(@Nullable ZoneId serverZoneId) Enforce the time zone of server.
MySqlConnectionConfiguration.Builder	socketTimeout(@Nullable Duration socketTimeout) Deprecated. This option has been deprecated as of version 1.0.1, because it has no effect and serves no purpose.
MySqlConnectionConfiguration.Builder	sslCa(@Nullable String sslCa) Configure SSL root certification for server certificate validation.
MySqlConnectionConfiguration.Builder	sslCert(@Nullable String sslCert) Configure client SSL certificate for client authentication.
MySqlConnectionConfiguration.Builder	sslContextBuilderCustomizer(Function<io.netty.handler.ssl.SslContextBuilder,io.netty.handler.ssl.SslContextBuilder> customizer) Configure a SslContextBuilder customizer.
MySqlConnectionConfiguration.Builder	sslHostnameVerifier(HostnameVerifier sslHostnameVerifier) Configure SSL HostnameVerifier, it is available only set sslMode(SslMode) as SslMode.VERIFY_IDENTITY.
MySqlConnectionConfiguration.Builder	sslKey(@Nullable String sslKey) Configure client SSL key for client authentication.
MySqlConnectionConfiguration.Builder	sslKeyPassword(@Nullable CharSequence sslKeyPassword) Configure the password of SSL key file for client certificate authentication.
MySqlConnectionConfiguration.Builder	sslMode(SslMode sslMode) Configure ssl mode.
MySqlConnectionConfiguration.Builder	tcpKeepAlive(boolean enabled) Configure TCP KeepAlive.
MySqlConnectionConfiguration.Builder	tcpNoDelay(boolean enabled) Configure TCP NoDelay.
MySqlConnectionConfiguration.Builder	tlsVersion(String... tlsVersion) Configure TLS versions, see TlsVersions.
MySqlConnectionConfiguration.Builder	unixSocket(String unixSocket) Configure the Unix Domain Socket to connect to.
MySqlConnectionConfiguration.Builder	useClientPrepareStatement() Configure the protocol of parametrized statements to the text protocol.
MySqlConnectionConfiguration.Builder	user(String user) Set the user for login the database.
MySqlConnectionConfiguration.Builder	username(String user) An alias of user(String).
MySqlConnectionConfiguration.Builder	useServerPrepareStatement() Configure the protocol of parametrized statements to the binary protocol.
MySqlConnectionConfiguration.Builder	useServerPrepareStatement(Predicate<String> preferPrepareStatement) Configure the protocol of parametrized statements and prepare-preferred simple statements to the binary protocol.
MySqlConnectionConfiguration.Builder	zeroDateOption(ZeroDateOption zeroDate) Configure the ZeroDateOption.

Methods inherited from class java.lang.Object

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

Method Detail

build

public MySqlConnectionConfiguration build()

Builds an immutable MySqlConnectionConfiguration with current options.

Returns:

the MySqlConnectionConfiguration.

database

public MySqlConnectionConfiguration.Builder database(@Nullable
                                                     @Nullable String database)

Configure the database. Default no database.

Parameters:

database - the database, or null if no database want to be login.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.1

unixSocket

public MySqlConnectionConfiguration.Builder unixSocket(String unixSocket)

Configure the Unix Domain Socket to connect to.

Parameters:

unixSocket - the socket file path.

Returns:

this MySqlConnectionConfiguration.Builder.

Throws:

IllegalArgumentException - if unixSocket is null.

Since:

0.8.1

host

public MySqlConnectionConfiguration.Builder host(String host)

Configure the host.

Parameters:

host - the host.

Returns:

this MySqlConnectionConfiguration.Builder.

Throws:

IllegalArgumentException - if host is null.

Since:

0.8.1

password

public MySqlConnectionConfiguration.Builder password(@Nullable
                                                     @Nullable CharSequence password)

Configure the password, MySQL allows to login without password.

Note: for memory security, should not use intern String for password.

Parameters:

password - the password, or null when user has no password.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.1

port

public MySqlConnectionConfiguration.Builder port(int port)

Configure the port. Defaults to 3306.

Parameters:

port - the port.

Returns:

this MySqlConnectionConfiguration.Builder.

Throws:

IllegalArgumentException - if the port is negative or bigger than 65535.

Since:

0.8.1

connectTimeout

public MySqlConnectionConfiguration.Builder connectTimeout(@Nullable
                                                           @Nullable Duration connectTimeout)

Configure the connection timeout. Default no timeout.

Parameters:

connectTimeout - the connection timeout, or null if has no timeout.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.1

socketTimeout

public MySqlConnectionConfiguration.Builder socketTimeout(@Nullable
                                                          @Nullable Duration socketTimeout)

Deprecated. This option has been deprecated as of version 1.0.1, because it has no effect and serves no purpose.

Configure the socket timeout, only for compatibility with socketTimeout property in the JDBC driver. In fact, SO_TIMEOUT has effect only for OIO socket transport. Default no timeout.

Parameters:

socketTimeout - the socket timeout, or null if has no timeout.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.6

user

public MySqlConnectionConfiguration.Builder user(String user)

Set the user for login the database.

Parameters:

user - the user.

Returns:

this MySqlConnectionConfiguration.Builder.

Throws:

IllegalArgumentException - if user is null.

Since:

0.8.2

username

public MySqlConnectionConfiguration.Builder username(String user)

An alias of user(String).

Parameters:

user - the user.

Returns:

this MySqlConnectionConfiguration.Builder.

Throws:

IllegalArgumentException - if user is null.

Since:

0.8.1

serverZoneId

public MySqlConnectionConfiguration.Builder serverZoneId(@Nullable
                                                         @Nullable ZoneId serverZoneId)

Enforce the time zone of server. Default to query server time zone in initialization (no enforce).

Parameters:

serverZoneId - the ZoneId, or null if query in initialization.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.2

zeroDateOption

public MySqlConnectionConfiguration.Builder zeroDateOption(ZeroDateOption zeroDate)

Configure the ZeroDateOption. It is a behavior option when this driver receives a value of zero-date.

Parameters:

zeroDate - the ZeroDateOption.

Returns:

this MySqlConnectionConfiguration.Builder.

Throws:

IllegalArgumentException - if zeroDate is null.

Since:

0.8.1

sslMode

public MySqlConnectionConfiguration.Builder sslMode(SslMode sslMode)

Configure ssl mode. See also SslMode.

Parameters:

sslMode - the SSL mode to use.

Returns:

this MySqlConnectionConfiguration.Builder.

Throws:

IllegalArgumentException - if sslMode is null.

Since:

0.8.1

tlsVersion

public MySqlConnectionConfiguration.Builder tlsVersion(String... tlsVersion)

Configure TLS versions, see TlsVersions.

Parameters:

tlsVersion - TLS versions.

Returns:

this MySqlConnectionConfiguration.Builder.

Throws:

IllegalArgumentException - if the array tlsVersion is null.

Since:

0.8.1

sslHostnameVerifier

public MySqlConnectionConfiguration.Builder sslHostnameVerifier(HostnameVerifier sslHostnameVerifier)

Configure SSL HostnameVerifier, it is available only set sslMode(SslMode) as SslMode.VERIFY_IDENTITY. It is useful when server was using special Certificates or need special verification.

Default is builtin HostnameVerifier which use RFC standards.

Parameters:

sslHostnameVerifier - the custom HostnameVerifier.

Returns:

this MySqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if sslHostnameVerifier is null

Since:

0.8.2

sslCa

public MySqlConnectionConfiguration.Builder sslCa(@Nullable
                                                  @Nullable String sslCa)

Configure SSL root certification for server certificate validation. It is only available if the sslMode(SslMode) is configured for verify server certification.

Default is null, which means that the default algorithm is used for the trust manager.

Parameters:

sslCa - an X.509 certificate chain file in PEM format.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.1

sslCert

public MySqlConnectionConfiguration.Builder sslCert(@Nullable
                                                    @Nullable String sslCert)

Configure client SSL certificate for client authentication.

The sslCert and sslKey must be both non-null or both null.

Parameters:

sslCert - an X.509 certificate chain file in PEM format, or null if no SSL cert.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.2

sslKey

public MySqlConnectionConfiguration.Builder sslKey(@Nullable
                                                   @Nullable String sslKey)

Configure client SSL key for client authentication.

The sslCert and sslKey must be both non-null or both null.

Parameters:

sslKey - a PKCS#8 private key file in PEM format, or null if no SSL key.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.2

sslKeyPassword

public MySqlConnectionConfiguration.Builder sslKeyPassword(@Nullable
                                                           @Nullable CharSequence sslKeyPassword)

Configure the password of SSL key file for client certificate authentication.

It will be used only if sslKey and sslCert non-null.

Parameters:

sslKeyPassword - the password of the sslKey, or null if it's not password-protected.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.2

sslContextBuilderCustomizer

public MySqlConnectionConfiguration.Builder sslContextBuilderCustomizer(Function<io.netty.handler.ssl.SslContextBuilder,io.netty.handler.ssl.SslContextBuilder> customizer)

Configure a SslContextBuilder customizer. The customizer gets applied on each SSL connection attempt to allow for just-in-time configuration updates. The Function gets called with the prepared SslContextBuilder that has all configuration options applied. The customizer may return the same builder or return a new builder instance to be used to build the SSL context.

Parameters:

customizer - customizer function

Returns:

this MySqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if customizer is null

Since:

0.8.1

tcpKeepAlive

public MySqlConnectionConfiguration.Builder tcpKeepAlive(boolean enabled)

Configure TCP KeepAlive.

Parameters:

enabled - whether to enable TCP KeepAlive

Returns:

this MySqlConnectionConfiguration.Builder

Since:

0.8.2

See Also:

Socket.setKeepAlive(boolean)

tcpNoDelay

public MySqlConnectionConfiguration.Builder tcpNoDelay(boolean enabled)

Configure TCP NoDelay.

Parameters:

enabled - whether to enable TCP NoDelay

Returns:

this MySqlConnectionConfiguration.Builder

Since:

0.8.2

See Also:

Socket.setTcpNoDelay(boolean)

useClientPrepareStatement

public MySqlConnectionConfiguration.Builder useClientPrepareStatement()

Configure the protocol of parametrized statements to the text protocol.

The text protocol is default protocol that's using client-preparing. See also MySQL documentations.

Returns:

this MySqlConnectionConfiguration.Builder

Since:

0.8.1

useServerPrepareStatement

public MySqlConnectionConfiguration.Builder useServerPrepareStatement()

Configure the protocol of parametrized statements to the binary protocol.

The binary protocol is compact protocol that's using server-preparing. See also MySQL documentations.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.1

useServerPrepareStatement

public MySqlConnectionConfiguration.Builder useServerPrepareStatement(Predicate<String> preferPrepareStatement)

Configure the protocol of parametrized statements and prepare-preferred simple statements to the binary protocol.

The preferPrepareStatement configures whether to prefer prepare execution on a statement-by-statement basis (simple statements). The Predicate accepts the simple SQL query string and returns a boolean flag indicating preference. true prepare-preferred, false prefers direct execution (text protocol). Defaults to direct execution.

The binary protocol is compact protocol that's using server-preparing. See also MySQL documentations.

Parameters:

preferPrepareStatement - the above Predicate.

Returns:

this MySqlConnectionConfiguration.Builder.

Throws:

IllegalArgumentException - if preferPrepareStatement is null.

Since:

0.8.1

queryCacheSize

public MySqlConnectionConfiguration.Builder queryCacheSize(int queryCacheSize)

Configures the maximum size of the Query parsing cache. Usually it should be power of two. Default to 0. Driver will use unbounded cache if size is less than 0.

Notice: the cache is using EL model (the PACELC theorem) which provider better performance. That means it is an elastic cache. So this size is not a hard-limit. It should be over 16 in average.

Parameters:

queryCacheSize - the above size, 0 means no cache, -1 means unbounded cache.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.3

prepareCacheSize

public MySqlConnectionConfiguration.Builder prepareCacheSize(int prepareCacheSize)

Configures the maximum size of the server-preparing cache. Usually it should be power of two. Default to 256. Driver will use unbounded cache if size is less than 0. It is used only if using server-preparing parametrized statements, i.e. the useServerPrepareStatement() is set.

Notice: the cache is using EC model (the PACELC theorem) for ensure consistency. Consistency is very important because MySQL contains a hard limit of all server-prepared statements which has been opened, see also max_prepared_stmt_count. And, the cache is one-to-one connection, which means it will not work on thread-concurrency.

Parameters:

prepareCacheSize - the above size, 0 means no cache, -1 means unbounded cache.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.3

autodetectExtensions

public MySqlConnectionConfiguration.Builder autodetectExtensions(boolean enabled)

Configures whether to use ServiceLoader to discover and register extensions. Defaults to true.

Parameters:

enabled - to discover and register extensions.

Returns:

this MySqlConnectionConfiguration.Builder.

Since:

0.8.2

extendWith

public MySqlConnectionConfiguration.Builder extendWith(Extension extension)

Registers a Extension to extend driver functionality and manually.

Notice: the driver will not deduplicate Extensions of autodetect discovered and manually extended. So if a Extension is registered by this function and autodetect discovered, it will get two Extension as same.

Parameters:

extension - extension to extend driver functionality.

Returns:

this MySqlConnectionConfiguration.Builder.

Throws:

IllegalArgumentException - if extension is null.

Since:

0.8.2

passwordPublisher

public MySqlConnectionConfiguration.Builder passwordPublisher(Publisher<String> passwordPublisher)

Registers a password publisher function.

Parameters:

passwordPublisher - function to retrieve password before making connection.

Returns:

this MySqlConnectionConfiguration.Builder.