A B C D E G H I K L M N O P R S T U V W

A

addConfigListener(ConfigListener) - Method in class me.magnet.consultant.Consultant

addSettingListener(String, SettingListener) - Method in class me.magnet.consultant.Consultant

Agent() - Constructor for class me.magnet.consultant.Consultant.Builder.Agent

appliesTo(ServiceIdentifier) - Method in class me.magnet.consultant.ServiceIdentifier

B

build() - Method in class me.magnet.consultant.Consultant.Builder

Builds a new instance of the Consultant class using the specified arguments.

builder() - Static method in class me.magnet.consultant.Consultant

C

Check - Class in me.magnet.consultant

Config() - Constructor for class me.magnet.consultant.Consultant.Builder.Config

ConfigListener - Interface in me.magnet.consultant

This interface allows you to handle updates to the Properties object containing your service's configuration.

ConfigValidator - Interface in me.magnet.consultant

This interface allows you to validate the new config for your service, before it's actually exposed to your service.

ConsulException - Exception in me.magnet.consultant

ConsulException(int, String) - Constructor for exception me.magnet.consultant.ConsulException

Consultant - Class in me.magnet.consultant

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.

Consultant.Builder - Class in me.magnet.consultant

Allows you to build a custom Consultant object.

Consultant.Builder.Agent - Class in me.magnet.consultant

Consultant.Builder.Config - Class in me.magnet.consultant

ConsultantException - Exception in me.magnet.consultant

ConsultantException(String) - Constructor for exception me.magnet.consultant.ConsultantException

ConsultantException(String, Throwable) - Constructor for exception me.magnet.consultant.ConsultantException

ConsultantException(Throwable) - Constructor for exception me.magnet.consultant.ConsultantException

D

deregisterService() - Method in class me.magnet.consultant.Consultant

E

equals(Object) - Method in class me.magnet.consultant.ServiceIdentifier

G

getAddress() - Method in class me.magnet.consultant.Node

getAddress() - Method in class me.magnet.consultant.Service

getConfig() - Method in class me.magnet.consultant.Consultant.Builder.Agent

getConsulHost() - Method in class me.magnet.consultant.Consultant

getDatacenter() - Method in class me.magnet.consultant.Consultant.Builder.Config

getDatacenter() - Method in class me.magnet.consultant.ServiceIdentifier

getDatacenter() - Method in class me.magnet.consultant.ServiceInstanceBackend

getHostName() - Method in class me.magnet.consultant.ServiceIdentifier

getId() - Method in class me.magnet.consultant.Service

getInstance() - Method in class me.magnet.consultant.ServiceIdentifier

getKey() - Method in class me.magnet.consultant.KeyValueEntry

getNode() - Method in class me.magnet.consultant.Node

getNode() - Method in class me.magnet.consultant.ServiceInstance

getNodeName() - Method in class me.magnet.consultant.Consultant.Builder.Config

getPort() - Method in class me.magnet.consultant.Service

getProperties() - Method in class me.magnet.consultant.Consultant

getService() - Method in class me.magnet.consultant.Service

getService() - Method in class me.magnet.consultant.ServiceInstance

getServiceIdentifier() - Method in class me.magnet.consultant.Consultant

getServiceName() - Method in class me.magnet.consultant.ServiceIdentifier

getStatus() - Method in exception me.magnet.consultant.ConsulException

getTags() - Method in class me.magnet.consultant.Service

getValue() - Method in class me.magnet.consultant.KeyValueEntry

H

hashCode() - Method in class me.magnet.consultant.ServiceIdentifier

I

identifyAs(String) - Method in class me.magnet.consultant.Consultant.Builder

States the identify of this application.

identifyAs(String, String) - Method in class me.magnet.consultant.Consultant.Builder

States the identify of this application.

identifyAs(String, String, String) - Method in class me.magnet.consultant.Consultant.Builder

States the identify of this application.

identifyAs(String, String, String, String) - Method in class me.magnet.consultant.Consultant.Builder

States the identify of this application.

K

KeyValueEntry - Class in me.magnet.consultant

KeyValueEntry() - Constructor for class me.magnet.consultant.KeyValueEntry

L

list(String) - Method in class me.magnet.consultant.Consultant

Deprecated.

listDatacenters() - Method in class me.magnet.consultant.ServiceInstanceBackend

listInstances(String) - Method in class me.magnet.consultant.ServiceInstanceBackend

Retrieves a list of service instances from Consul ordered by network distance (nearest to farthest) in the local datacenter.

listInstances(String, String) - Method in class me.magnet.consultant.ServiceInstanceBackend

Retrieves a list of service instances from Consul ordered by network distance (nearest to farthest) in the specified datacenter.

locate(String) - Method in class me.magnet.consultant.Consultant

Deprecated.

locateAll(String) - Method in class me.magnet.consultant.Consultant

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

locateAll(String, RoutingStrategy) - Method in class me.magnet.consultant.Consultant

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

locateInstances(ServiceInstanceBackend, String) - Method in interface me.magnet.consultant.RoutingStrategy

Creates a new ServiceLocator object which can be used to locate one or more instances according to implementation of this interface.

M

me.magnet.consultant - package me.magnet.consultant

moreSpecificThan(ServiceIdentifier) - Method in class me.magnet.consultant.ServiceIdentifier

N

NETWORK_DISTANCE - Static variable in class me.magnet.consultant.RoutingStrategies

A RoutingStrategy which returns service instances in order of network distance (order from nearest to farthest).

next() - Method in class me.magnet.consultant.ServiceLocator

Node - Class in me.magnet.consultant

Node() - Constructor for class me.magnet.consultant.Node

O

onConfigUpdate(Properties) - Method in interface me.magnet.consultant.ConfigListener

This method is fired when the Properties object containing your service's configuration is modified.

onSettingUpdate(String, SettingListener) - Method in class me.magnet.consultant.Consultant.Builder

Specifies a callback listener which is notified of whenever the specified setting is updated.

onSettingUpdate(String, String, String) - Method in interface me.magnet.consultant.SettingListener

This method is fired when the a particular setting of your service's configuration is modified.

onValidConfig(ConfigListener) - Method in class me.magnet.consultant.Consultant.Builder

Specifies a callback listener which is notified of whenever a new and valid configuration is detected in Consul.

P

PropertiesUtil - Class in me.magnet.consultant

pullConfigFromConsul(boolean) - Method in class me.magnet.consultant.Consultant.Builder

Specifies that Consultant should or should not fetch configuration from Consul.

R

RANDOMIZED - Static variable in class me.magnet.consultant.RoutingStrategies

A RoutingStrategy which emits the service instances in a random order.

RANDOMIZED_WEIGHTED_DISTANCE - Static variable in class me.magnet.consultant.RoutingStrategies

A RoutingStrategy which returns service instances in a randomized order of network distance (order from nearest to farthest).

randomizedWeightedDistance(double) - Static method in class me.magnet.consultant.RoutingStrategies

Creates a new RoutingStrategy which returns service instances in a randomized order but prefers closer service instances (in terms of network distance).

registerService(int) - Method in class me.magnet.consultant.Consultant

removeConfigListener(ConfigListener) - Method in class me.magnet.consultant.Consultant

removeSettingListener(String, SettingListener) - Method in class me.magnet.consultant.Consultant

reset() - Method in interface me.magnet.consultant.RoutingStrategy

Resets any internal state of this RoutingStrategy implementation.

ROUND_ROBIN - Static variable in class me.magnet.consultant.RoutingStrategies

A RoutingStrategy which returns service instances in a round robin manner.

RoutingStrategies - Class in me.magnet.consultant

A class which has a set of RoutingStrategies which can be used for client-side load balancing.

RoutingStrategy - Interface in me.magnet.consultant

Specialized interface which can be used to locate a bunch of service instances.

S

Service - Class in me.magnet.consultant

Service() - Constructor for class me.magnet.consultant.Service

ServiceIdentifier - Class in me.magnet.consultant

ServiceInstance - Class in me.magnet.consultant

ServiceInstanceBackend - Class in me.magnet.consultant

A class which can be used to retrieve lists of instances or datacenters from Consul over its HTTP API.

ServiceLocator - Class in me.magnet.consultant

A class which implements an Iterator style pattern allowing the user of this class to fetch service instances in a particular order one-by-one.

ServiceRegistration - Class in me.magnet.consultant

setHealthEndpoint(String) - Method in class me.magnet.consultant.Consultant.Builder

States the endpoint used for checking the service's health.

SettingListener - Interface in me.magnet.consultant

This interface allows you to handle updates to a particular setting of your service's configuration.

shutdown() - Method in class me.magnet.consultant.Consultant

Tears any outstanding resources down.

startWith(Properties) - Method in class me.magnet.consultant.Consultant.Builder

Ensures that Consultant starts out with a default Properties object.

sync(Properties, Properties) - Static method in class me.magnet.consultant.PropertiesUtil

Copies all the properties from source to target.

T

toString() - Method in class me.magnet.consultant.ServiceIdentifier

toString() - Method in class me.magnet.consultant.ServiceInstance

U

usingExecutor(ScheduledExecutorService) - Method in class me.magnet.consultant.Consultant.Builder

States that Consultant should use a specific executor service for listening to configuration updates.

usingObjectMapper(ObjectMapper) - Method in class me.magnet.consultant.Consultant.Builder

States that Consultant should use a specific ObjectMapper for serialization and deserialization of JSON.

V

validateConfig(Properties) - Method in interface me.magnet.consultant.ConfigValidator

This method verifies if a new config as specified by the Properties object is valid or not.

validateConfigWith(ConfigValidator) - Method in class me.magnet.consultant.Consultant.Builder

Specifies the validator which is used to determine if a new configuration detected in Consul is valid, and may be published through the ConfigListener callback.

W

whenLocatingServicesCacheResultsFor(long, TimeUnit) - Method in class me.magnet.consultant.Consultant.Builder

Specifies that the results from calls being made to Consul to locate services are being cached for at most the specified duration.

withConsulHost(String) - Method in class me.magnet.consultant.Consultant.Builder

Specifies where the Consul REST API can be reached on.

withKvPrefix(String) - Method in class me.magnet.consultant.Consultant.Builder

Allows the caller to specify the prefix when looking up the key value properties.

A B C D E G H I K L M N O P R S T U V W