com.ibm.etcd.client

Class EtcdClient.Builder

java.lang.Object

com.ibm.etcd.client.EtcdClient.Builder

Enclosing class:

EtcdClient

public static class EtcdClient.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
EtcdClient	build()
EtcdClient.Builder	overrideAuthority(String authority) Override the authority used for TLS hostname verification.
EtcdClient.Builder	sendViaEventLoop(boolean sendViaEventLoop) Control whether all RPC requests are sent via the underlying IO event loop.
EtcdClient.Builder	withCaCert(com.google.common.io.ByteSource certSource) Provide CA certificate to use for TLS connection
EtcdClient.Builder	withCredentials(com.google.protobuf.ByteString name, com.google.protobuf.ByteString password) Set etcd credentials to use from ByteStrings
EtcdClient.Builder	withCredentials(String name, String password) Set etcd credentials to use from Strings as UTF-8.
EtcdClient.Builder	withDefaultTimeout(long value, TimeUnit unit) Provide a default timeout to use for requests made by this client.
EtcdClient.Builder	withImmediateAuth() Attempt authentication immediately rather than if/when required.
EtcdClient.Builder	withMaxInboundMessageSize(int sizeInBytes) Set the maximum inbound message size in bytes
EtcdClient.Builder	withPlainText() Disable TLS - to connect to insecure servers in development contexts
EtcdClient.Builder	withSessionTimeoutSecs(int timeoutSecs) Set the session timeout in seconds - this corresponds to the TTL of the session lease, see EtcdClient.getSessionLease().
EtcdClient.Builder	withThreadCount(int threads) subject to change - threads to use for internal executor
EtcdClient.Builder	withTlsConfig(Consumer<io.netty.handler.ssl.SslContextBuilder> contextBuilder) Configure the netty SslContext to be used by this client.
EtcdClient.Builder	withTrustManager(TrustManagerFactory tmf) Provide custom TrustManagerFactory to use for this client's TLS connection.
EtcdClient.Builder	withUserExecutor(Executor executor) Provide executor to use for user call-backs.

Methods inherited from class java.lang.Object

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

Method Detail

withCredentials

public EtcdClient.Builder withCredentials(com.google.protobuf.ByteString name,
                                          com.google.protobuf.ByteString password)

Set etcd credentials to use from ByteStrings

Parameters:

name -

password -

withCredentials

public EtcdClient.Builder withCredentials(String name,
                                          String password)

Set etcd credentials to use from Strings as UTF-8.

Parameters:

name -

password -

withImmediateAuth

public EtcdClient.Builder withImmediateAuth()

Attempt authentication immediately rather than if/when required. Applies only if etcd credentials have been provided.

withThreadCount

public EtcdClient.Builder withThreadCount(int threads)

subject to change - threads to use for internal executor

sendViaEventLoop

public EtcdClient.Builder sendViaEventLoop(boolean sendViaEventLoop)

Control whether all RPC requests are sent via the underlying IO event loop. This helps to limit overall memory use due to internal thread-local buffer pooling.

Default is true

Parameters:

sendViaEventLoop -

withUserExecutor

public EtcdClient.Builder withUserExecutor(Executor executor)

Provide executor to use for user call-backs. A default client-scoped executor will be used if not set.

Parameters:

executor -

withDefaultTimeout

public EtcdClient.Builder withDefaultTimeout(long value,
                                             TimeUnit unit)

Provide a default timeout to use for requests made by this client. This timeout value is used per-attempt, unlike Deadlines used per-call which also cover any/all retry attempts. The default for this default is 10 seconds

Parameters:

value -

unit -

withPlainText

public EtcdClient.Builder withPlainText()

Disable TLS - to connect to insecure servers in development contexts

overrideAuthority

public EtcdClient.Builder overrideAuthority(String authority)

Override the authority used for TLS hostname verification. Applies to all endpoints and does not otherwise affect DNS name resolution.

withCaCert

public EtcdClient.Builder withCaCert(com.google.common.io.ByteSource certSource)
                              throws IOException,
                                     SSLException

Provide CA certificate to use for TLS connection

Parameters:

certSource -

Throws:

IOException - if there is an error reading from the provided ByteSource

SSLException

withTrustManager

public EtcdClient.Builder withTrustManager(TrustManagerFactory tmf)
                                    throws SSLException

Provide custom TrustManagerFactory to use for this client's TLS connection.

Parameters:

tmf -

Throws:

SSLException

withTlsConfig

public EtcdClient.Builder withTlsConfig(Consumer<io.netty.handler.ssl.SslContextBuilder> contextBuilder)
                                 throws SSLException

Configure the netty SslContext to be used by this client. The provided Consumer should make updates to the passed SslContextBuilder as needed, but should not call build().

Parameters:

contextBuilder -

Throws:

SSLException

withSessionTimeoutSecs

public EtcdClient.Builder withSessionTimeoutSecs(int timeoutSecs)

Set the session timeout in seconds - this corresponds to the TTL of the session lease, see EtcdClient.getSessionLease().

Parameters:

timeoutSecs -

withMaxInboundMessageSize

public EtcdClient.Builder withMaxInboundMessageSize(int sizeInBytes)

Set the maximum inbound message size in bytes

Parameters:

sizeInBytes -

build

public EtcdClient build()

Returns:

the built EtcdClient instance