io.picodata.driver.core

Class TarantoolClientBuilderImpl

java.lang.Object

io.picodata.driver.core.TarantoolClientConfiguratorImpl<TarantoolClientBuilder>

io.picodata.driver.core.TarantoolClientBuilderImpl

All Implemented Interfaces:

TarantoolClientBuilder, TarantoolClientConfigurator<TarantoolClientBuilder>

public class TarantoolClientBuilderImpl
extends TarantoolClientConfiguratorImpl<TarantoolClientBuilder>
implements TarantoolClientBuilder

Tarantool client builder implementation.

Field Summary

Fields inherited from class io.picodata.driver.core.TarantoolClientConfiguratorImpl

executor, mappingConfig, retryPolicyFactory

Constructor Summary

Constructors

Constructor and Description
TarantoolClientBuilderImpl()

Method Summary

Modifier and Type	Method and Description
TarantoolClient<TarantoolTuple,TarantoolResult<TarantoolTuple>>	build() Build the configured Tarantool client instance.
TarantoolClientBuilder	withAddress(InetSocketAddress socketAddress) Specify a Tarantool server address.
TarantoolClientBuilder	withAddress(String host) Specify a single host of a Tarantool server.
TarantoolClientBuilder	withAddress(String host, int port) Specify a single host and a port of a Tarantool server.
TarantoolClientBuilder	withAddresses(List<TarantoolServerAddress> addressList) Specify a list of Tarantool server addresses.
TarantoolClientBuilder	withAddresses(TarantoolServerAddress... address) Specify one or more Tarantool server addresses.
TarantoolClientBuilder	withAddressProvider(TarantoolClusterAddressProvider addressProvider) Specify a provider for Tarantool server addresses.
TarantoolClientBuilder	withAuthMechanism(AuthMechanism authMechanism) Specify authentication mechanism configured on the server.
TarantoolClientBuilder	withConnections(int numberOfConnections) Specify the number of connections per one Tarantool server.
TarantoolClientBuilder	withConnectionSelectionStrategy(ConnectionSelectionStrategyFactory connectionSelectionStrategy) Specify a custom connection selection strategy factory.
TarantoolClientBuilder	withConnectionSelectionStrategy(TarantoolConnectionSelectionStrategyType connectionSelectionStrategyType) Select a built-in connection selection strategy factory.
TarantoolClientBuilder	withConnectTimeout(int connectTimeout) Specify a connection timeout.
TarantoolClientBuilder	withCredentials(String user, String password) Specify user credentials for password-based authentication in a Tarantool server.
TarantoolClientBuilder	withCredentials(TarantoolCredentials credentials) Specify user credentials for authentication in a Tarantool server.
TarantoolClientBuilder	withDefaultMessagePackMapperConfiguration(UnaryOperator<MessagePackMapperBuilder> mapperBuilder) Specify a configuration for mapping between Java objects and MessagePack entities.
TarantoolClientBuilder	withEventLoopThreadsNumber(int eventLoopThreadsNumber) Specify netty threads number.
TarantoolClientBuilder	withMessagePackMapper(MessagePackMapper mapper) Specify a mapper between Java objects and MessagePack entities.
TarantoolClientBuilder	withReadTimeout(int readTimeout) Specify a response reading timeout.
TarantoolClientBuilder	withRequestTimeout(int requestTimeout) Specify a request timeout.
TarantoolClientBuilder	withSecure(boolean isSecure) Turn on secure connection or turn off secure connection.
TarantoolClientBuilder	withSslContext(io.netty.handler.ssl.SslContext sslContext) Specify SslContext with settings for establishing SSL/TLS connection between Tarantool
TarantoolClientBuilder	withTarantoolClientConfig(TarantoolClientConfig config) Specify a tarantool client config It overrides previous settings for config

Methods inherited from class io.picodata.driver.core.TarantoolClientConfiguratorImpl

decorate, withProxyMethodMapping, withProxyMethodMapping, withRetrying, withRetrying, withRetryingByNumberOfAttempts, withRetryingByNumberOfAttempts, withRetryingByNumberOfAttempts, withRetryingByNumberOfAttempts, withRetryingByNumberOfAttempts, withRetryingIndefinitely, withRetryingIndefinitely, withRetryingIndefinitely, withRetryingIndefinitely

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.picodata.driver.api.TarantoolClientConfigurator

withProxyMethodMapping, withProxyMethodMapping, withRetrying, withRetrying, withRetryingByNumberOfAttempts, withRetryingByNumberOfAttempts, withRetryingByNumberOfAttempts, withRetryingByNumberOfAttempts, withRetryingByNumberOfAttempts, withRetryingIndefinitely, withRetryingIndefinitely, withRetryingIndefinitely, withRetryingIndefinitely

Constructor Detail

TarantoolClientBuilderImpl

public TarantoolClientBuilderImpl()

Method Detail

withAddress

public TarantoolClientBuilder withAddress(String host)

Description copied from interface: TarantoolClientBuilder

Specify a single host of a Tarantool server. The default port 3301 will be used.

Specified by:

withAddress in interface TarantoolClientBuilder

Parameters:

host - Tarantool server host

Returns:

this instance of builder TarantoolClientBuilder

withAddress

public TarantoolClientBuilder withAddress(String host,
                                          int port)

Description copied from interface: TarantoolClientBuilder

Specify a single host and a port of a Tarantool server.

Specified by:

withAddress in interface TarantoolClientBuilder

Parameters:

host - Tarantool server host

port - Tarantool server port

Returns:

this instance of builder TarantoolClientBuilder

withAddress

public TarantoolClientBuilder withAddress(InetSocketAddress socketAddress)

Description copied from interface: TarantoolClientBuilder

Specify a Tarantool server address.

Specified by:

withAddress in interface TarantoolClientBuilder

Parameters:

socketAddress - remote server address

Returns:

this instance of builder TarantoolClientBuilder

withAddresses

public TarantoolClientBuilder withAddresses(TarantoolServerAddress... address)

Description copied from interface: TarantoolClientBuilder

Specify one or more Tarantool server addresses.

Specified by:

withAddresses in interface TarantoolClientBuilder

Parameters:

address - list of addresses of Tarantool instances

Returns:

this instance of builder TarantoolClientBuilder

withAddresses

public TarantoolClientBuilder withAddresses(List<TarantoolServerAddress> addressList)

Description copied from interface: TarantoolClientBuilder

Specify a list of Tarantool server addresses. In a sharded cluster this is usually a list of router instances addresses.

Specified by:

withAddresses in interface TarantoolClientBuilder

Parameters:

addressList - list of Tarantool instance addresses

Returns:

this instance of builder TarantoolClientBuilder

withAddressProvider

public TarantoolClientBuilder withAddressProvider(TarantoolClusterAddressProvider addressProvider)

Description copied from interface: TarantoolClientBuilder

Specify a provider for Tarantool server addresses. The typical usage of a provider is dynamic retrieving of the addresses from some configuration or discovery manager like etcd, ZooKeeper, or a special Tarantool instance. The actual list of addresses will then be retrieved each time a new connection is being established.

Specified by:

withAddressProvider in interface TarantoolClientBuilder

Parameters:

addressProvider - TarantoolClusterAddressProvider

Returns:

this instance of builder TarantoolClientBuilder

withCredentials

public TarantoolClientBuilder withCredentials(String user,
                                              String password)

Description copied from interface: TarantoolClientBuilder

Specify user credentials for password-based authentication in a Tarantool server.

Specified by:

withCredentials in interface TarantoolClientBuilder

Parameters:

user - user to authenticate with

password - password to authenticate with

Returns:

this instance of builder TarantoolClientBuilder

See Also:

TarantoolClientBuilder.withCredentials(TarantoolCredentials tarantoolCredentials)

withCredentials

public TarantoolClientBuilder withCredentials(TarantoolCredentials credentials)

Description copied from interface: TarantoolClientBuilder

Specify user credentials for authentication in a Tarantool server. Important: these credentials will be used for all Tarantool server instances, which addresses are returned by a service provider or are directly specified in the client configuration, so make sure that all instances to be connected can authenticate with the specified credentials.

Specified by:

withCredentials in interface TarantoolClientBuilder

Parameters:

credentials - credentials for all Tarantool server instances

Returns:

this instance of builder TarantoolClientBuilder

withAuthMechanism

public TarantoolClientBuilder withAuthMechanism(AuthMechanism authMechanism)

Description copied from interface: TarantoolClientBuilder

Specify authentication mechanism configured on the server. The default one is CHAP-SHA1 supported by the Tarantool server.

Specified by:

withAuthMechanism in interface TarantoolClientBuilder

Parameters:

authMechanism - configured authentication mechanism

Returns:

this instance of builder TarantoolClientBuilder

withConnections

public TarantoolClientBuilder withConnections(int numberOfConnections)

Description copied from interface: TarantoolClientBuilder

Specify the number of connections per one Tarantool server. The default value is 1. More connections may help if a request can stuck on the server side or if the request payloads are big. Important: the total number of open connections will be kept close to the specified number of connections times the number of server addresses. In a normal working mode, the number of connections opened to each server will be equal to this option value, however, an actual number may differ when the connections go down or up.

Specified by:

withConnections in interface TarantoolClientBuilder

Parameters:

numberOfConnections - the number of connections per one server

Returns:

this instance of builder TarantoolClientBuilder

withDefaultMessagePackMapperConfiguration

public TarantoolClientBuilder withDefaultMessagePackMapperConfiguration(UnaryOperator<MessagePackMapperBuilder> mapperBuilder)

Description copied from interface: TarantoolClientBuilder

Specify a configuration for mapping between Java objects and MessagePack entities.

This method takes a lambda as an argument, where the mapperBuilder is DefaultMessagePackMapper.Builder.

see DefaultMessagePackMapperFactory.

Specified by:

withDefaultMessagePackMapperConfiguration in interface TarantoolClientBuilder

Parameters:

mapperBuilder - builder provider instance, e.g. a lambda function taking the builder for MessagePackMapper instance

Returns:

this instance of builder TarantoolClientBuilder

See Also:

TarantoolClientConfig.setMessagePackMapper(MessagePackMapper)

withMessagePackMapper

public TarantoolClientBuilder withMessagePackMapper(MessagePackMapper mapper)

Description copied from interface: TarantoolClientBuilder

Specify a mapper between Java objects and MessagePack entities. The mapper contains converters for simple and complex tuple field types and for the entire tuples into custom Java objects. This mapper is used by default if a custom mapper is not passed to a specific operation. You may build and pass here your custom mapper or add some converters to a default one, see DefaultMessagePackMapperFactory.

Specified by:

withMessagePackMapper in interface TarantoolClientBuilder

Parameters:

mapper - configured MessagePackMapper instance

Returns:

this instance of builder TarantoolClientBuilder

See Also:

TarantoolClientConfig.setMessagePackMapper(MessagePackMapper)

withRequestTimeout

public TarantoolClientBuilder withRequestTimeout(int requestTimeout)

Description copied from interface: TarantoolClientBuilder

Specify a request timeout. The default is 2000 milliseconds.

Specified by:

withRequestTimeout in interface TarantoolClientBuilder

Parameters:

requestTimeout - the timeout for receiving a response from the Tarantool server, in milliseconds

Returns:

this instance of builder TarantoolClientBuilder

See Also:

TarantoolClientConfig.setRequestTimeout(int)

withConnectTimeout

public TarantoolClientBuilder withConnectTimeout(int connectTimeout)

Description copied from interface: TarantoolClientBuilder

Specify a connection timeout. The default is 1000 milliseconds.

Specified by:

withConnectTimeout in interface TarantoolClientBuilder

Parameters:

connectTimeout - the timeout for connecting to the Tarantool server, in milliseconds

Returns:

this instance of builder TarantoolClientBuilder

See Also:

TarantoolClientConfig.setConnectTimeout(int)

withReadTimeout

public TarantoolClientBuilder withReadTimeout(int readTimeout)

Description copied from interface: TarantoolClientBuilder

Specify a response reading timeout. The default is 1000 milliseconds.

Specified by:

withReadTimeout in interface TarantoolClientBuilder

Parameters:

readTimeout - the timeout for reading the responses from Tarantool server, in milliseconds

Returns:

this instance of builder TarantoolClientBuilder

See Also:

TarantoolClientConfig.setReadTimeout(int)

withConnectionSelectionStrategy

public TarantoolClientBuilder withConnectionSelectionStrategy(TarantoolConnectionSelectionStrategyType connectionSelectionStrategyType)

Description copied from interface: TarantoolClientBuilder

Select a built-in connection selection strategy factory. The default strategy types include simple round-robin algorithms, good enough for balancing the requests between several connections with a single server (ROUND_ROBIN) or multiple servers (PARALLEL_ROUND_ROBIN).

Specified by:

withConnectionSelectionStrategy in interface TarantoolClientBuilder

Parameters:

connectionSelectionStrategyType - built-in connection selection strategy factory type

Returns:

this instance of builder TarantoolClientBuilder

withSslContext

public TarantoolClientBuilder withSslContext(io.netty.handler.ssl.SslContext sslContext)

Description copied from interface: TarantoolClientBuilder

Specify SslContext with settings for establishing SSL/TLS connection between Tarantool

Specified by:

withSslContext in interface TarantoolClientBuilder

Parameters:

sslContext - SslContext instance

Returns:

this instance of builder TarantoolClientBuilder

withSecure

public TarantoolClientBuilder withSecure(boolean isSecure)

Description copied from interface: TarantoolClientBuilder

Turn on secure connection or turn off secure connection. Works only for new connections.

Specified by:

withSecure in interface TarantoolClientBuilder

Parameters:

isSecure - boolean flag

Returns:

this instance of builder TarantoolClientBuilder

withConnectionSelectionStrategy

public TarantoolClientBuilder withConnectionSelectionStrategy(ConnectionSelectionStrategyFactory connectionSelectionStrategy)

Description copied from interface: TarantoolClientBuilder

Specify a custom connection selection strategy factory. A connection selection strategy encapsulates an algorithm of selecting the next connection from the pool of available ones for performing the next request.

Specified by:

withConnectionSelectionStrategy in interface TarantoolClientBuilder

Parameters:

connectionSelectionStrategy - connection selection strategy factory instance

Returns:

this instance of builder TarantoolClientBuilder

withTarantoolClientConfig

public TarantoolClientBuilder withTarantoolClientConfig(TarantoolClientConfig config)

Description copied from interface: TarantoolClientBuilder

Specify a tarantool client config

It overrides previous settings for config

Specified by:

withTarantoolClientConfig in interface TarantoolClientBuilder

Parameters:

config - tarantool client config

Returns:

this instance of builder TarantoolClientBuilder

withEventLoopThreadsNumber

public TarantoolClientBuilder withEventLoopThreadsNumber(int eventLoopThreadsNumber)

Description copied from interface: TarantoolClientBuilder

Specify netty threads number. Default is 0, real value will set in netty background

Specified by:

withEventLoopThreadsNumber in interface TarantoolClientBuilder

Parameters:

eventLoopThreadsNumber - number of threads

Returns:

builder

build

public TarantoolClient<TarantoolTuple,TarantoolResult<TarantoolTuple>> build()

Description copied from interface: TarantoolClientConfigurator

Build the configured Tarantool client instance. Call this when you have specified all necessary settings.

Specified by:

build in interface TarantoolClientBuilder

Specified by:

build in interface TarantoolClientConfigurator<TarantoolClientBuilder>

Overrides:

build in class TarantoolClientConfiguratorImpl<TarantoolClientBuilder>

Returns:

instance of tarantool tuple client TarantoolClient