org.ff4j.consul

Class ConsulConnection

java.lang.Object

org.ff4j.consul.ConsulConnection

All Implemented Interfaces:

KeyValueDriver<String,String>

public class ConsulConnection
extends Object
implements KeyValueDriver<String,String>

Wrapping connection to consul to use it in different classes. Server RPC (Default 8300). This is used by servers to handle incoming requests from other agents. TCP only. Serf LAN (Default 8301). This is used to handle gossip in the LAN. Required by all agents. TCP and UDP. Serf WAN (Default 8302). This is used by servers to gossip over the WAN to other servers. TCP and UDP. CLI RPC (Default 8400). This is used by all agents to handle RPC from the CLI, but is deprecated in Consul 0.8 and later. TCP only. In Consul 0.8 all CLI commands were changed to use the HTTP API and the RPC interface was completely removed. HTTP API (Default 8500). This is used by clients to talk to the HTTP API. TCP only. DNS Interface (Default 8600). Used to resolve DNS queries. TCP and UDP.

Author:

Cedrick LUNVEN (@clunven)

Constructor Summary

Constructors

Constructor and Description
ConsulConnection() Default.
ConsulConnection(com.orbitz.consul.Consul definedConsul) Constructor with existing configuration.
ConsulConnection(com.orbitz.consul.Consul definedConsul, ConsulKeyBuilder keyBuilder) Constructor with existing configuration and keyBuilder.

Method Summary

Modifier and Type	Method and Description
void	deleteKey(String key)
boolean	existKey(String key)
com.orbitz.consul.AgentClient	getAgentClient() Getter accessor for attribute 'agentClient'.
String	getAuditTrailKey(Event e)
com.orbitz.consul.Consul	getConsul() Getter accessor for attribute 'consul'.
String	getFeatureKey(String featureName)
Set<String>	getFeatureList()
String	getFeatureName(String key)
com.orbitz.consul.HealthClient	getHealthClient() Getter accessor for attribute 'healthClient'.
String	getHitCountKey(Event e)
com.orbitz.consul.KeyValueClient	getKeyValueClient() Getter accessor for attribute 'keyValueClient'.
String	getMissKey(Event e)
String	getPropertyKey(String propertyName)
Set<String>	getPropertyList()
String	getPropertyName(String key)
String	getValue(String key)
void	putValue(String key, String value)
void	registerFeature(String featureName)
void	registerProperty(String propertyName)
void	unregisterFeature(String featureName)
void	unregisterProperty(String propertyName)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsulConnection

public ConsulConnection()

Default.

ConsulConnection

public ConsulConnection(com.orbitz.consul.Consul definedConsul)

Constructor with existing configuration.

Parameters:

definedConsul - target consul

ConsulConnection

public ConsulConnection(com.orbitz.consul.Consul definedConsul,
                        ConsulKeyBuilder keyBuilder)

Constructor with existing configuration and keyBuilder.

Parameters:

definedConsul - target consul

keyBuilder - the key builder

Method Detail

getConsul

public com.orbitz.consul.Consul getConsul()

Getter accessor for attribute 'consul'.

Returns:

current value of 'consul'

getAgentClient

public com.orbitz.consul.AgentClient getAgentClient()

Getter accessor for attribute 'agentClient'.

Returns:

current value of 'agentClient'

getHealthClient

public com.orbitz.consul.HealthClient getHealthClient()

Getter accessor for attribute 'healthClient'.

Returns:

current value of 'healthClient'

getKeyValueClient

public com.orbitz.consul.KeyValueClient getKeyValueClient()

Getter accessor for attribute 'keyValueClient'.

Returns:

current value of 'keyValueClient'

existKey

public boolean existKey(String key)

Specified by:

existKey in interface KeyValueDriver<String,String>

deleteKey

public void deleteKey(String key)

Specified by:

deleteKey in interface KeyValueDriver<String,String>

getValue

public String getValue(String key)

Specified by:

getValue in interface KeyValueDriver<String,String>

putValue

public void putValue(String key,
                     String value)

Specified by:

putValue in interface KeyValueDriver<String,String>

getFeatureKey

public String getFeatureKey(String featureName)

Specified by:

getFeatureKey in interface KeyValueDriver<String,String>

getFeatureName

public String getFeatureName(String key)

Specified by:

getFeatureName in interface KeyValueDriver<String,String>

getFeatureList

public Set<String> getFeatureList()

Specified by:

getFeatureList in interface KeyValueDriver<String,String>

registerFeature

public void registerFeature(String featureName)

Specified by:

registerFeature in interface KeyValueDriver<String,String>

unregisterFeature

public void unregisterFeature(String featureName)

Specified by:

unregisterFeature in interface KeyValueDriver<String,String>

getPropertyKey

public String getPropertyKey(String propertyName)

Specified by:

getPropertyKey in interface KeyValueDriver<String,String>

getPropertyName

public String getPropertyName(String key)

Specified by:

getPropertyName in interface KeyValueDriver<String,String>

getPropertyList

public Set<String> getPropertyList()

Specified by:

getPropertyList in interface KeyValueDriver<String,String>

registerProperty

public void registerProperty(String propertyName)

Specified by:

registerProperty in interface KeyValueDriver<String,String>

unregisterProperty

public void unregisterProperty(String propertyName)

Specified by:

unregisterProperty in interface KeyValueDriver<String,String>

getHitCountKey

public String getHitCountKey(Event e)

Specified by:

getHitCountKey in interface KeyValueDriver<String,String>

getMissKey

public String getMissKey(Event e)

Specified by:

getMissKey in interface KeyValueDriver<String,String>

getAuditTrailKey

public String getAuditTrailKey(Event e)

Specified by:

getAuditTrailKey in interface KeyValueDriver<String,String>