io.picodata.driver.api

Class TarantoolClientConfig.Builder

java.lang.Object

io.picodata.driver.api.TarantoolClientConfig.Builder

Enclosing class:

TarantoolClientConfig

public static final class TarantoolClientConfig.Builder
extends Object

A builder for TarantoolClientConfig

Constructor Summary

Constructors

Constructor and Description
Builder() Basic constructor.
Builder(TarantoolClientConfig config) Basic constructor.

Method Summary

Modifier and Type	Method and Description
TarantoolClientConfig	build() Build a TarantoolClientConfig instance
TarantoolClientConfig.Builder	clear() Prepare the builder for new configuration process
TarantoolClientConfig.Builder	withAuthMechanism(AuthMechanism authMechanism) Specify auth mechanism
TarantoolClientConfig.Builder	withConnections(int connections) Specify the number of connections used for sending requests to the server.
TarantoolClientConfig.Builder	withConnectionSelectionStrategyFactory(ConnectionSelectionStrategyFactory factory) Set the implementation of a factory which instantiates a strategy instance providing the algorithm of selecting the next connection from a connection pool for performing the next request
TarantoolClientConfig.Builder	withConnectTimeout(int connectTimeout) Specify connection timeout.
TarantoolClientConfig.Builder	withCredentials(TarantoolCredentials credentials) Specify user credentials
TarantoolClientConfig.Builder	withEventLoopThreadsNumber(int eventLoopThreadsNumber) Specify netty threads number.
TarantoolClientConfig.Builder	withMessagePackMapper(MessagePackMapper mapper) Specify mapper between Java objects and MessagePack entities
TarantoolClientConfig.Builder	withReadTimeout(int readTimeout) Specify response reading timeout.
TarantoolClientConfig.Builder	withRequestTimeout(int requestTimeout) Specify request timeout.
TarantoolClientConfig.Builder	withSecure(boolean isSecure) Turn on secure connection or turn off secure connection Works only for new connections
TarantoolClientConfig.Builder	withSslContext(io.netty.handler.ssl.SslContext sslContext) Specify SslContext with settings for establishing SSL/TLS connection between Tarantool
TarantoolClientConfig.Builder	withWriteBatchSize(int writeBatchSize) Specify request batch size.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Basic constructor.

Builder

public Builder(TarantoolClientConfig config)

Basic constructor.

Parameters:

config - client configuration

Method Detail

withCredentials

public TarantoolClientConfig.Builder withCredentials(TarantoolCredentials credentials)

Specify user credentials

Parameters:

credentials - the Tarantool user credentials

Returns:

builder

See Also:

TarantoolClientConfig.setCredentials(TarantoolCredentials)

withAuthMechanism

public TarantoolClientConfig.Builder withAuthMechanism(AuthMechanism authMechanism)

Specify auth mechanism

Parameters:

authMechanism - the server auth mechanism

Returns:

builder

See Also:

TarantoolClientConfig.setAuthMechanism(AuthMechanism)

withReadTimeout

public TarantoolClientConfig.Builder withReadTimeout(int readTimeout)

Specify response reading timeout. Default is 1000 milliseconds

Parameters:

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

Returns:

builder

See Also:

TarantoolClientConfig.setReadTimeout(int)

withConnectTimeout

public TarantoolClientConfig.Builder withConnectTimeout(int connectTimeout)

Specify connection timeout. Default is 1000 milliseconds

Parameters:

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

Returns:

builder

See Also:

TarantoolClientConfig.setConnectTimeout(int)

withRequestTimeout

public TarantoolClientConfig.Builder withRequestTimeout(int requestTimeout)

Specify request timeout. Default is 2000 milliseconds

Parameters:

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

Returns:

builder

See Also:

TarantoolClientConfig.setRequestTimeout(int)

withMessagePackMapper

public TarantoolClientConfig.Builder withMessagePackMapper(MessagePackMapper mapper)

Specify mapper between Java objects and MessagePack entities

Parameters:

mapper - configured MessagePackMapper instance

Returns:

builder

See Also:

TarantoolClientConfig.setMessagePackMapper(MessagePackMapper)

withConnections

public TarantoolClientConfig.Builder withConnections(int connections)

Specify the number of connections used for sending requests to the 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.

Parameters:

connections - the number of connections

Returns:

builder

withSslContext

public TarantoolClientConfig.Builder withSslContext(io.netty.handler.ssl.SslContext sslContext)

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

Parameters:

sslContext - SslContext instance

Returns:

builder

withSecure

public TarantoolClientConfig.Builder withSecure(boolean isSecure)

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

Parameters:

isSecure - boolean flag

Returns:

builder

withConnectionSelectionStrategyFactory

public TarantoolClientConfig.Builder withConnectionSelectionStrategyFactory(ConnectionSelectionStrategyFactory factory)

Set the implementation of a factory which instantiates a strategy instance providing the algorithm of selecting the next connection from a connection pool for performing the next request

Parameters:

factory - connection selection strategy factory instance

Returns:

builder

withEventLoopThreadsNumber

public TarantoolClientConfig.Builder withEventLoopThreadsNumber(int eventLoopThreadsNumber)

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

Parameters:

eventLoopThreadsNumber - number of threads

Returns:

builder

withWriteBatchSize

public TarantoolClientConfig.Builder withWriteBatchSize(int writeBatchSize)

Specify request batch size. Increase this number if this client instance does much more writes than reads, but the bigger is this number, the more memory will be used by the client and the bigger will be the amount of outbound bytes sent at once. Default is 128

Parameters:

writeBatchSize - maximum number of requests in batch

Returns:

builder

build

public TarantoolClientConfig build()

Build a TarantoolClientConfig instance

Returns:

configured instance

clear

public TarantoolClientConfig.Builder clear()

Prepare the builder for new configuration process

Returns:

the empty builder