com.coreos.jetcd

Class ClientBuilder

java.lang.Object

com.coreos.jetcd.ClientBuilder

All Implemented Interfaces:

Cloneable

public final class ClientBuilder
extends Object
implements Cloneable

ClientBuilder knows how to create an Client instance.

Method Summary

Modifier and Type	Method and Description
String	authority()
ClientBuilder	authority(String authority) The authority used to authenticate connections to servers.
Client	build() build a new Client.
ClientBuilder	copy()
Collection<String>	endpoints() gets the endpoints for the builder.
ClientBuilder	endpoints(Collection<String> endpoints) configure etcd server endpoints.
ClientBuilder	endpoints(String... endpoints) configure etcd server endpoints.
boolean	lazyInitialization()
ClientBuilder	lazyInitialization(boolean lazyInitialization) Define if the client has to initialize connectivity and authentication on client constructor or delay it to the first call to a client.
io.grpc.LoadBalancer.Factory	loadBalancerFactory() get LoadBalancer.Factory for etcd client.
ClientBuilder	loadBalancerFactory(io.grpc.LoadBalancer.Factory loadBalancerFactory) config LoadBalancer factory.
ByteSequence	password()
ClientBuilder	password(ByteSequence password) config etcd auth password.
io.netty.handler.ssl.SslContext	sslContext()
ClientBuilder	sslContext(io.netty.handler.ssl.SslContext sslContext) SSL/TLS context to use instead of the system default.
com.coreos.jetcd.resolver.URIResolverLoader	uriResolverLoader()
ClientBuilder	uriResolverLoader(com.coreos.jetcd.resolver.URIResolverLoader loader)
ByteSequence	user()
ClientBuilder	user(ByteSequence user) config etcd auth user.

Methods inherited from class java.lang.Object

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

Method Detail

endpoints

public Collection<String> endpoints()

gets the endpoints for the builder.

Returns:

the list of endpoints configured for the builder

endpoints

public ClientBuilder endpoints(Collection<String> endpoints)

configure etcd server endpoints.

Parameters:

endpoints - etcd server endpoints, at least one

Returns:

this builder to train

Throws:

NullPointerException - if endpoints is null or one of endpoint is null

IllegalArgumentException - if some endpoint is invalid

endpoints

public ClientBuilder endpoints(String... endpoints)

configure etcd server endpoints.

Parameters:

endpoints - etcd server endpoints, at least one

Returns:

this builder to train

Throws:

NullPointerException - if endpoints is null or one of endpoint is null

IllegalArgumentException - if some endpoint is invalid

user

public ByteSequence user()

user

public ClientBuilder user(ByteSequence user)

config etcd auth user.

Parameters:

user - etcd auth user

Returns:

this builder

Throws:

NullPointerException - if user is null

password

public ByteSequence password()

password

public ClientBuilder password(ByteSequence password)

config etcd auth password.

Parameters:

password - etcd auth password

Returns:

this builder

Throws:

NullPointerException - if password is null

loadBalancerFactory

public ClientBuilder loadBalancerFactory(io.grpc.LoadBalancer.Factory loadBalancerFactory)

config LoadBalancer factory.

Parameters:

loadBalancerFactory - etcd LoadBalancer.Factory

Returns:

this builder

Throws:

NullPointerException - if loadBalancerFactory is null

loadBalancerFactory

public io.grpc.LoadBalancer.Factory loadBalancerFactory()

get LoadBalancer.Factory for etcd client.

Returns:

loadBalancerFactory

lazyInitialization

public boolean lazyInitialization()

lazyInitialization

public ClientBuilder lazyInitialization(boolean lazyInitialization)

Define if the client has to initialize connectivity and authentication on client constructor or delay it to the first call to a client. Default is false.

Parameters:

lazyInitialization - true if the client has to lazily perform connectivity/authentication.

Returns:

this builder

sslContext

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

sslContext

public ClientBuilder sslContext(io.netty.handler.ssl.SslContext sslContext)

SSL/TLS context to use instead of the system default. It must have been configured with GrpcSslContexts, but options could have been overridden.

Parameters:

sslContext - the ssl context

Returns:

this builder

authority

public String authority()

authority

public ClientBuilder authority(String authority)

The authority used to authenticate connections to servers.

uriResolverLoader

public com.coreos.jetcd.resolver.URIResolverLoader uriResolverLoader()

uriResolverLoader

public ClientBuilder uriResolverLoader(com.coreos.jetcd.resolver.URIResolverLoader loader)

build

public Client build()

build a new Client.

Returns:

Client instance.

Throws:

com.coreos.jetcd.common.exception.EtcdException - if client experiences build error.

copy

public ClientBuilder copy()