Package me.magnet.consultant

Class Consultant.Builder

java.lang.Object

me.magnet.consultant.Consultant.Builder

Enclosing class:

Consultant

public static class Consultant.Builder
extends Object

Allows you to build a custom Consultant object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Consultant.Builder.Agent
static class	Consultant.Builder.Config

Method Summary

Modifier and Type	Method	Description
Consultant	build()	Builds a new instance of the Consultant class using the specified arguments.
Consultant.Builder	identifyAs(String serviceName)	States the identify of this application.
Consultant.Builder	identifyAs(String serviceName, String datacenter)	States the identify of this application.
Consultant.Builder	identifyAs(String serviceName, String datacenter, String hostname)	States the identify of this application.
Consultant.Builder	identifyAs(String serviceName, String datacenter, String hostname, String instanceName)	States the identify of this application.
Consultant.Builder	onSettingUpdate(String key, SettingListener listener)	Specifies a callback listener which is notified of whenever the specified setting is updated.
Consultant.Builder	onValidConfig(ConfigListener listener)	Specifies a callback listener which is notified of whenever a new and valid configuration is detected in Consul.
Consultant.Builder	pullConfigFromConsul(boolean pullConfig)	Specifies that Consultant should or should not fetch configuration from Consul.
Consultant.Builder	setHealthEndpoint(String endpoint)	States the endpoint used for checking the service's health.
Consultant.Builder	startWith(Properties properties)	Ensures that Consultant starts out with a default Properties object.
Consultant.Builder	usingExecutor(ScheduledExecutorService executor)	States that Consultant should use a specific executor service for listening to configuration updates.
Consultant.Builder	usingObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)	States that Consultant should use a specific ObjectMapper for serialization and deserialization of JSON.
Consultant.Builder	validateConfigWith(ConfigValidator validator)	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.
Consultant.Builder	whenLocatingServicesCacheResultsFor(long duration, TimeUnit unit)	Specifies that the results from calls being made to Consul to locate services are being cached for at most the specified duration.
Consultant.Builder	withConsulHost(String host)	Specifies where the Consul REST API can be reached on.
Consultant.Builder	withConsulToken(String token)	Specifies that a token must be set using the X-Consul-Token header to authenticate requests directed at Consul with.
Consultant.Builder	withKvPrefix(String kvPrefix)	Allows the caller to specify the prefix when looking up the key value properties.

Methods inherited from class java.lang.Object

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

Method Detail

usingExecutor

public Consultant.Builder usingExecutor(ScheduledExecutorService executor)

States that Consultant should use a specific executor service for listening to configuration updates. If no executor service is specified, Consultant will create a private executor service. This executor service will automatically be cleaned up when the JVM terminates, or when shutdown() is called on the Consultant object.

Parameters:

executor - The ScheduledExecutorService to use to schedule jobs on.

Returns:

The Builder instance.

usingObjectMapper

public Consultant.Builder usingObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)

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

Parameters:

mapper - The ObjectMapper to use when deserializing JSON and serializing objects.

Returns:

The Builder instance.

withConsulHost

public Consultant.Builder withConsulHost(String host)

Specifies where the Consul REST API can be reached on. Alternatively you can specify this through the environment variable CONSUL_HOST=http://localhost. The default port (8500) is used.

Parameters:

host - The host where the Consul REST API can be found.

Returns:

The Builder instance.

withConsulToken

public Consultant.Builder withConsulToken(String token)

Specifies that a token must be set using the X-Consul-Token header to authenticate requests directed at Consul with.

Parameters:

token - The token to use when talking to Consul.

Returns:

The Builder instance

withKvPrefix

public Consultant.Builder withKvPrefix(String kvPrefix)

Allows the caller to specify the prefix when looking up the key value properties. This will default to config if not specified.

Parameters:

kvPrefix - the path prefix to be used when looking-up the properties.

Returns:

The Builder instance.

identifyAs

public Consultant.Builder identifyAs(String serviceName)

States the identify of this application. This is used to figure out what configuration settings apply to this application. If you don't set the identity using this method, you must define it using environment variables such as SERVICE_NAME, and optionally SERVICE_DC and SERVICE_HOST.

Parameters:

serviceName - The name of this service.

Returns:

The Builder instance.

identifyAs

public Consultant.Builder identifyAs(String serviceName,
                                     String datacenter)

States the identify of this application. This is used to figure out what configuration settings apply to this application. If you don't set the identity using this method, you should define it using environment variables such as SERVICE_NAME, and optionally SERVICE_DC and SERVICE_HOST. If the datacenter is not defined using environment variables either, this value will default to the corresponding value of the Consul agent.

Parameters:

serviceName - The name of this service.

datacenter - The name of the datacenter where this service is running in.

Returns:

The Builder instance.

identifyAs

public Consultant.Builder identifyAs(String serviceName,
                                     String datacenter,
                                     String hostname)

States the identify of this application. This is used to figure out what configuration settings apply to this application. If you don't set the identity using this method, you should define it using environment variables such as SERVICE_NAME, and optionally SERVICE_DC and SERVICE_HOST. If the datacenter and hostname are not defined using environment variables either, these values will default to the corresponding values of the Consul agent.

Parameters:

serviceName - The name of this service.

datacenter - The name of the datacenter where this service is running in.

hostname - The name of the host where this service is running on.

Returns:

The Builder instance.

identifyAs

public Consultant.Builder identifyAs(String serviceName,
                                     String datacenter,
                                     String hostname,
                                     String instanceName)

States the identify of this application. This is used to figure out what configuration settings apply to this application. If you don't set the identity using this method, you should define it using environment variables such as SERVICE_NAME, and optionally SERVICE_DC, SERVICE_HOST, and SERVICE_INSTANCE. If the datacenter and hostname are not defined using environment variables either, these values will default to the corresponding values of the Consul agent.

Parameters:

serviceName - The name of this service.

datacenter - The name of the datacenter where this service is running in.

hostname - The name of the host where this service is running on.

instanceName - The name/role of this service instance.

Returns:

The Builder instance.

setHealthEndpoint

public Consultant.Builder setHealthEndpoint(String endpoint)

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

Parameters:

endpoint - The endpoint to use for health checking. Defaults to "/_health".

Returns:

The Builder instance.

onValidConfig

public Consultant.Builder onValidConfig(ConfigListener listener)

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

Parameters:

listener - The listener to call when a new valid configuration is detected.

Returns:

The Builder instance.

onSettingUpdate

public Consultant.Builder onSettingUpdate(String key,
                                          SettingListener listener)

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

Parameters:

key - The key of the setting to listen for.

listener - The listener to call when the specified setting is updated.

Returns:

The Builder instance.

validateConfigWith

public Consultant.Builder validateConfigWith(ConfigValidator validator)

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.

Parameters:

validator - The validator to call when a new configuration is detected.

Returns:

The Builder instance.

pullConfigFromConsul

public Consultant.Builder pullConfigFromConsul(boolean pullConfig)

Specifies that Consultant should or should not fetch configuration from Consul. By default this is set to true, but it can be useful to set this to false for testing.

Parameters:

pullConfig - True if configuration should be retrieved from Consul, or false if it should not.

Returns:

The Builder instance.

startWith

public Consultant.Builder startWith(Properties properties)

Ensures that Consultant starts out with a default Properties object. This object will be updated if Consultant pulls configuration from Consul. By default Consultant will start out with an empty Properties object.

Parameters:

properties - The Properties object to start Consultant with.

Returns:

The Builder instance.

whenLocatingServicesCacheResultsFor

public Consultant.Builder whenLocatingServicesCacheResultsFor(long duration,
                                                              TimeUnit unit)

Specifies that the results from calls being made to Consul to locate services are being cached for at most the specified duration. This is done as to not overload Consul with requests. If you specify a duration of 0, caching will effectively be disabled. By default this is set to 1 second, which is good enough to mitigate overloading Consul for a high volume of calls, but low enough not to return instances long after they've deregistered.

Parameters:

duration - The duration of time to cache locate call results for.

unit - The unit of the specified duration.

Returns:

The Builder instance.

build

public Consultant build()

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

Returns:

The constructed Consultant object.