Package me.magnet.consultant

Class Consultant

java.lang.Object

me.magnet.consultant.Consultant

public class Consultant
extends Object

The Consultant class allows you to retrieve the configuration for your application from Consul, and at the same time subscribe to changes to that configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Consultant.Builder	Allows you to build a custom Consultant object.

Method Summary

Modifier and Type	Method	Description
void	addConfigListener(ConfigListener listener)
void	addSettingListener(String key, SettingListener listener)
static Consultant.Builder	builder()
void	deregisterService()
String	getConsulHost()
Properties	getProperties()
ServiceIdentifier	getServiceIdentifier()
List<ServiceInstance>	list(String serviceName)	Deprecated.
Optional<InetSocketAddress>	locate(String serviceName)	Deprecated.
ServiceLocator	locateAll(String serviceName)	Returns a ServiceLocator with which services matching the specified service name can be found.
ServiceLocator	locateAll(String serviceName, RoutingStrategy routingStrategy)	Returns a ServiceLocator with which services matching the specified service name can be found.
void	registerService(int port)
boolean	removeConfigListener(ConfigListener listener)
boolean	removeSettingListener(String key, SettingListener listener)
boolean	setConfig(String key, String value)	Updates a config in Consul's KV store.
boolean	setConfig(ServiceIdentifier identifier, String key, String value)	Updates a config in Consul's KV store.
void	shutdown()	Tears any outstanding resources down.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static Consultant.Builder builder()

Returns:

A Builder for the Consultant class.

registerService

public void registerService(int port)

deregisterService

public void deregisterService()

list

@Deprecated
public List<ServiceInstance> list(String serviceName)

Deprecated.

Lists all service instances of a particular service known to Consul ordered by network distance. This method is scheduled for removal in the next major release. Avoid this method if possible due to possible performance issues when having a multi datacenter Consul cluster. Use the locateAll() method instead.

Parameters:

serviceName - The name of the service to locate instances of.

Returns:

A List of ServiceInstance objects.

locateAll

public ServiceLocator locateAll(String serviceName)

Returns a ServiceLocator with which services matching the specified service name can be found. By default uses the "Randomized Weighted Distance" RoutingStrategy.

Parameters:

serviceName - The name of the service to locate instances of.

Returns:

The constructed ServiceLocator.

locateAll

public ServiceLocator locateAll(String serviceName,
                                RoutingStrategy routingStrategy)

Returns a ServiceLocator with which services matching the specified service name can be found.

Parameters:

serviceName - The name of the service to locate instances of.

routingStrategy - The RoutingStrategy to use to locate instances.

Returns:

The constructed ServiceLocator.

locate

@Deprecated
public Optional<InetSocketAddress> locate(String serviceName)

Deprecated.

Returns the closest service instance's InetSocketAddress.

Parameters:

serviceName - The name of the service to locate.

Returns:

An Optional containing the closest service instance's InetSocketAddress, or an empty Optional otherwise.

addConfigListener

public void addConfigListener(ConfigListener listener)

removeConfigListener

public boolean removeConfigListener(ConfigListener listener)

addSettingListener

public void addSettingListener(String key,
                               SettingListener listener)

removeSettingListener

public boolean removeSettingListener(String key,
                                     SettingListener listener)

setConfig

public boolean setConfig(String key,
                         String value)

Updates a config in Consul's KV store.

Parameters:

key - The key to set/update/delete.

value - The new value for the key. Specifying a NULL will delete it.

Returns:

True if the change was successful.

setConfig

public boolean setConfig(ServiceIdentifier identifier,
                         String key,
                         String value)

Updates a config in Consul's KV store.

Parameters:

identifier - A qualifier for which this update should apply. Use this if you wish to limit the config update to a specific datacenter, host, or instance.

key - The key to set/update/delete.

value - The new value for the key. Specifying a NULL will delete it.

Returns:

True if the change was successful.

shutdown

public void shutdown()
              throws InterruptedException

Tears any outstanding resources down.

Throws:

InterruptedException - If it got interrupted while waiting for any open tasks

getConsulHost

public String getConsulHost()

Returns:

The host on which the Consul agent can be found. Will typically return "http://localhost:8500" unless otherwise specified in the Builder or environment variables.

getServiceIdentifier

public ServiceIdentifier getServiceIdentifier()

Returns:

The identity of this service or application.

getProperties

public Properties getProperties()

Returns:

The current valid configuration.