com.orbitz.consul

Class KeyValueClient

java.lang.Object

com.orbitz.consul.KeyValueClient

public class KeyValueClient
extends Object

HTTP Client for /v1/kv/ endpoints.

Method Summary

Modifier and Type	Method and Description
boolean	acquireLock(String key, String session) Aquire a lock for a given key.
boolean	acquireLock(String key, String value, String session) Aquire a lock for a given key.
void	deleteKey(String key) Deletes a specified key.
void	deleteKeys(String key) Deletes a specified key and any below it.
List<String>	getKeys(String key) Retrieves a list of matching keys for the given key.
com.google.common.base.Optional<String>	getSession(String key) Retrieves a session string for a specific key from the key/value store.
com.google.common.base.Optional<Value>	getValue(String key) Retrieves a Value for a specific key from the key/value store.
com.google.common.base.Optional<Value>	getValue(String key, QueryOptions queryOptions) Retrieves a Value for a specific key from the key/value store.
void	getValue(String key, QueryOptions queryOptions, ConsulResponseCallback<com.google.common.base.Optional<Value>> callback) Asynchronously retrieves a Value for a specific key from the key/value store.
com.google.common.base.Optional<String>	getValueAsString(String key) Retrieves a string value for a specific key from the key/value store.
List<Value>	getValues(String key) Retrieves a list of Value objects for a specific key from the key/value store.
List<Value>	getValues(String key, QueryOptions queryOptions) Retrieves a list of Value objects for a specific key from the key/value store.
void	getValues(String key, QueryOptions queryOptions, ConsulResponseCallback<List<Value>> callback) Asynchronously retrieves a list of Value objects for a specific key from the key/value store.
List<String>	getValuesAsString(String key) Retrieves a list of string values for a specific key from the key/value store.
boolean	putValue(String key) Puts a null value into the key/value store.
boolean	putValue(String key, String value) Puts a value into the key/value store.
boolean	putValue(String key, String value, long flags) Puts a value into the key/value store.
boolean	putValue(String key, String value, long flags, PutOptions putOptions) Puts a value into the key/value store.
boolean	releaseLock(String key, String sessionId) Releases the lock for a given service and session.

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public com.google.common.base.Optional<Value> getValue(String key)

Retrieves a Value for a specific key from the key/value store. GET /v1/kv/{key}

Parameters:

key - The key to retrieve.

Returns:

An Optional containing the value or Optional.absent()

getValue

public com.google.common.base.Optional<Value> getValue(String key,
                                                       QueryOptions queryOptions)

Retrieves a Value for a specific key from the key/value store. GET /v1/kv/{key}

Parameters:

key - The key to retrieve.

queryOptions - The query options.

Returns:

An Optional containing the value or Optional.absent()

getValue

public void getValue(String key,
                     QueryOptions queryOptions,
                     ConsulResponseCallback<com.google.common.base.Optional<Value>> callback)

Asynchronously retrieves a Value for a specific key from the key/value store. GET /v1/kv/{key}

Parameters:

key - The key to retrieve.

queryOptions - The query options.

callback - Callback implemented by callee to handle results.

getValues

public List<Value> getValues(String key)

Retrieves a list of Value objects for a specific key from the key/value store. GET /v1/kv/{key}?recurse

Parameters:

key - The key to retrieve.

Returns:

A list of zero to many Value objects.

getValues

public List<Value> getValues(String key,
                             QueryOptions queryOptions)

Retrieves a list of Value objects for a specific key from the key/value store. GET /v1/kv/{key}?recurse

Parameters:

key - The key to retrieve.

queryOptions - The query options.

Returns:

A list of zero to many Value objects.

getValues

public void getValues(String key,
                      QueryOptions queryOptions,
                      ConsulResponseCallback<List<Value>> callback)

Asynchronously retrieves a list of Value objects for a specific key from the key/value store. GET /v1/kv/{key}?recurse

Parameters:

key - The key to retrieve.

queryOptions - The query options.

callback - Callback implemented by callee to handle results.

getValueAsString

public com.google.common.base.Optional<String> getValueAsString(String key)

Retrieves a string value for a specific key from the key/value store. GET /v1/kv/{key}

Parameters:

key - The key to retrieve.

Returns:

An Optional containing the value as a string or Optional.absent()

getValuesAsString

public List<String> getValuesAsString(String key)

Retrieves a list of string values for a specific key from the key/value store. GET /v1/kv/{key}?recurse

Parameters:

key - The key to retrieve.

Returns:

A list of zero to many string values.

putValue

public boolean putValue(String key)

Puts a null value into the key/value store.

Parameters:

key - The key to use as index.

Returns:

true if the value was successfully indexed.

putValue

public boolean putValue(String key,
                        String value)

Puts a value into the key/value store.

Parameters:

key - The key to use as index.

value - The value to index.

Returns:

true if the value was successfully indexed.

putValue

public boolean putValue(String key,
                        String value,
                        long flags)

Puts a value into the key/value store.

Parameters:

key - The key to use as index.

value - The value to index.

flags - The flags for this key.

Returns:

true if the value was successfully indexed.

putValue

public boolean putValue(String key,
                        String value,
                        long flags,
                        PutOptions putOptions)

Puts a value into the key/value store.

Parameters:

key - The key to use as index.

value - The value to index.

putOptions - PUT options (e.g. wait, acquire).

Returns:

true if the value was successfully indexed.

getKeys

public List<String> getKeys(String key)

Retrieves a list of matching keys for the given key. GET /v1/kv/{key}?keys

Parameters:

key - The key to retrieve.

Returns:

A list of zero to many keys.

deleteKey

public void deleteKey(String key)

Deletes a specified key. DELETE /v1/kv/{key}

Parameters:

key - The key to delete.

deleteKeys

public void deleteKeys(String key)

Deletes a specified key and any below it. DELETE /v1/kv/{key}?recurse

Parameters:

key - The key to delete.

acquireLock

public boolean acquireLock(String key,
                           String session)

Aquire a lock for a given key. PUT /v1/kv/{key}?acquire={session}

Parameters:

key - The key to acquire the lock.

session - The session to acquire lock.

Returns:

true if the lock is acquired successfully, false otherwise.

acquireLock

public boolean acquireLock(String key,
                           String value,
                           String session)

Aquire a lock for a given key. PUT /v1/kv/{key}?acquire={session}

Parameters:

key - The key to acquire the lock.

session - The session to acquire lock.

value - key value (usually - application specific info about the lock requester)

Returns:

true if the lock is acquired successfully, false otherwise.

getSession

public com.google.common.base.Optional<String> getSession(String key)

Retrieves a session string for a specific key from the key/value store. GET /v1/kv/{key}

Parameters:

key - The key to retrieve.

Returns:

An Optional containing the value as a string or Optional.absent()

releaseLock

public boolean releaseLock(String key,
                           String sessionId)

Releases the lock for a given service and session. GET /v1/kv/{key}?release={sessionId}

Parameters:

key - identifying the service.

sessionId -

Returns:

SessionInfo.