Package org.apache.curator.x.discovery

Class ServiceDiscoveryBuilder<T>

java.lang.Object

org.apache.curator.x.discovery.ServiceDiscoveryBuilder<T>

public class ServiceDiscoveryBuilder<T>
extends Object

Method Summary

Modifier and Type	Method	Description
ServiceDiscoveryBuilder<T>	basePath(String basePath)	Required - set the base path to store in ZK, see pathConstructor(DiscoveryPathConstructor) for alternative
ServiceDiscovery<T>	build()	Build a new service discovery with the currently set values.
static <T> ServiceDiscoveryBuilder<T>	builder(Class<T> payloadClass)	Return a new builder.
ServiceDiscoveryBuilder<T>	client(CuratorFramework client)	Required - set the client to use
ServiceDiscoveryBuilder<T>	pathConstructor(DiscoveryPathConstructor pathConstructor)	Required - shape the service tree in ZK, see basePath(String) for alternative
ServiceDiscoveryBuilder<T>	serializer(InstanceSerializer<T> serializer)	optional - change the serializer used (the default is JsonInstanceSerializer
ServiceDiscoveryBuilder<T>	thisInstance(ServiceInstance<T> thisInstance)	Optional - instance that represents the service that is running.
ServiceDiscoveryBuilder<T>	watchInstances(boolean watchInstances)	Optional - if true, watches for changes to locally registered instances (via thisInstance(ServiceInstance) or ServiceDiscovery.registerService(ServiceInstance)).

Methods inherited from class java.lang.Object

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

Method Details

builder

public static <T> ServiceDiscoveryBuilder<T> builder(Class<T> payloadClass)

Return a new builder.

Parameters:

payloadClass - the class of the payload of your service instance (you can use Void if your instances don't need a payload)

Returns:

new builder

build

public ServiceDiscovery<T> build()

Build a new service discovery with the currently set values. If not set, the builder will be defaulted with a JsonInstanceSerializer.

Returns:

new service discovery

client

public ServiceDiscoveryBuilder<T> client(CuratorFramework client)

Required - set the client to use

Parameters:

client - client

Returns:

this

basePath

public ServiceDiscoveryBuilder<T> basePath(String basePath)

Required - set the base path to store in ZK, see pathConstructor(DiscoveryPathConstructor) for alternative

Parameters:

basePath - base path

Returns:

this

pathConstructor

public ServiceDiscoveryBuilder<T> pathConstructor(DiscoveryPathConstructor pathConstructor)

Required - shape the service tree in ZK, see basePath(String) for alternative

Parameters:

pathConstructor - custom service tree

Returns:

this

serializer

public ServiceDiscoveryBuilder<T> serializer(InstanceSerializer<T> serializer)

optional - change the serializer used (the default is JsonInstanceSerializer

Parameters:

serializer - the serializer

Returns:

this

thisInstance

public ServiceDiscoveryBuilder<T> thisInstance(ServiceInstance<T> thisInstance)

Optional - instance that represents the service that is running. The instance will get auto-registered

Parameters:

thisInstance - initial instance

Returns:

this

watchInstances

public ServiceDiscoveryBuilder<T> watchInstances(boolean watchInstances)

Optional - if true, watches for changes to locally registered instances (via thisInstance(ServiceInstance) or ServiceDiscovery.registerService(ServiceInstance)). If the data for instances changes, they are reloaded.

Parameters:

watchInstances - true to watch instances

Returns:

this