Package org.qubership.integration.platform.variables.management.consul

Class ConsulClient

java.lang.Object

org.qubership.integration.platform.variables.management.consul.ConsulClient

@Component
public class ConsulClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONSUL_INDEX_HEADER
static final String	CONSUL_KV_DELETE_PARAMS
static final String	CONSUL_KV_PATH
static final String	CONSUL_KV_QUERY_PARAMS
static final String	CONSUL_TOKEN_HEADER
static final String	CONSUL_TXN_PATH
static final int	MAX_TXN_SIZE

Constructor Summary

Constructors

Constructor	Description
ConsulClient(org.springframework.web.client.RestTemplate restTemplate, String consulUrl)

Method Summary

Modifier and Type	Method	Description
void	createOrUpdateKV(String key, Object value)
void	createOrUpdateKVsInTransaction(Map<String,String> map)
void	deleteKV(String key, boolean recurse)
void	deleteKVsInTransaction(List<String> keys)
List<KeyResponse>	getKV(String key, boolean recurse)
List<KVResponse>	getKVsInTransaction(List<String> keys)	Throws ConsulException if at least one key in a list is not present in consul
org.apache.commons.lang3.tuple.Pair<Long,List<KeyResponse>>	waitForKVChanges(String key, boolean recurse, long index, String waitTimeout)

Methods inherited from class java.lang.Object

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

Field Details

MAX_TXN_SIZE

public static final int MAX_TXN_SIZE

See Also:

• Constant Field Values

CONSUL_TOKEN_HEADER

public static final String CONSUL_TOKEN_HEADER

See Also:

• Constant Field Values

CONSUL_INDEX_HEADER

public static final String CONSUL_INDEX_HEADER

See Also:

• Constant Field Values

CONSUL_KV_PATH

public static final String CONSUL_KV_PATH

See Also:

• Constant Field Values

CONSUL_TXN_PATH

public static final String CONSUL_TXN_PATH

See Also:

• Constant Field Values

CONSUL_KV_QUERY_PARAMS

public static final String CONSUL_KV_QUERY_PARAMS

See Also:

• Constant Field Values

CONSUL_KV_DELETE_PARAMS

public static final String CONSUL_KV_DELETE_PARAMS

See Also:

• Constant Field Values

Constructor Details

ConsulClient

@Autowired
public ConsulClient(@Qualifier("restTemplateMS")
 org.springframework.web.client.RestTemplate restTemplate,
 @Value("${consul.url}")
 String consulUrl)

Method Details

getKV

public List<KeyResponse> getKV(String key,
 boolean recurse)
                        throws KVNotFoundException

Throws:

KVNotFoundException

getKVsInTransaction

public List<KVResponse> getKVsInTransaction(List<String> keys)
                                     throws ConsulException

Throws ConsulException if at least one key in a list is not present in consul

Parameters:

keys - path without leading slash (e.g. 'config/test/key')

Throws:

ConsulException

createOrUpdateKV

public void createOrUpdateKV(String key,
 Object value)

createOrUpdateKVsInTransaction

public void createOrUpdateKVsInTransaction(Map<String,String> map)

Parameters:

map - key/value mapping, key - path without a leading slash (e.g. 'config/test/key')

deleteKV

public void deleteKV(String key,
 boolean recurse)

deleteKVsInTransaction

public void deleteKVsInTransaction(List<String> keys)

Parameters:

keys - path without leading slash (e.g. 'config/test/key')

waitForKVChanges

public org.apache.commons.lang3.tuple.Pair<Long,List<KeyResponse>> waitForKVChanges(String key,
 boolean recurse,
 long index,
 String waitTimeout)
                                                                             throws KVNotFoundException

Throws:

KVNotFoundException