Package com.networknt.consul.client

Class ConsulClientImpl

java.lang.Object

com.networknt.consul.client.ConsulClientImpl

All Implemented Interfaces:

ConsulClient

public class ConsulClientImpl
extends Object
implements ConsulClient

A client that talks to Consul agent with REST API. Client and connection are cached as instance variable in singleton class.

Author:

Steve Hu

Constructor Summary

Constructors

Constructor	Description
ConsulClientImpl()	Construct ConsulClient with all parameters from consul.yml config file.

Method Summary

Modifier and Type	Method	Description
void	checkFail(String serviceId, String token)	Set specific serviceId status as fail
void	checkPass(String serviceId, String token)	Set specific serviceId status as pass
ConsulResponse<List<ConsulService>>	lookupHealthService(String serviceName, String tag, long lastConsulIndex, String token)	to lookup health services based on serviceName, if lastConsulIndex == 0, will get result right away.
void	registerService(ConsulService service, String token)	register a consul service
void	unregisterService(String serviceId, String token)	unregister a consul service

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsulClientImpl

public ConsulClientImpl()

Construct ConsulClient with all parameters from consul.yml config file. The other two constructors are just for backward compatibility.

Method Detail

checkPass

public void checkPass(String serviceId,
                      String token)

Description copied from interface: ConsulClient

Set specific serviceId status as pass

Specified by:

checkPass in interface ConsulClient

Parameters:

serviceId - service id

token - ACL token for consul

checkFail

public void checkFail(String serviceId,
                      String token)

Description copied from interface: ConsulClient

Set specific serviceId status as fail

Specified by:

checkFail in interface ConsulClient

Parameters:

serviceId - service id

token - ACL token for consul

registerService

public void registerService(ConsulService service,
                            String token)

Description copied from interface: ConsulClient

register a consul service

Specified by:

registerService in interface ConsulClient

Parameters:

service - service object

token - ACL token for consul

unregisterService

public void unregisterService(String serviceId,
                              String token)

Description copied from interface: ConsulClient

unregister a consul service

Specified by:

unregisterService in interface ConsulClient

Parameters:

serviceId - service id

token - ACL token for consul

lookupHealthService

public ConsulResponse<List<ConsulService>> lookupHealthService(String serviceName,
                                                               String tag,
                                                               long lastConsulIndex,
                                                               String token)

to lookup health services based on serviceName, if lastConsulIndex == 0, will get result right away. if lastConsulIndex != 0, will establish a long query with consul with wait seconds.

Specified by:

lookupHealthService in interface ConsulClient

Parameters:

serviceName - service name (service_id)

tag - tag that is used for filtering (env_tag)

lastConsulIndex - last consul index

token - Consul token for security (Consul ACL)

Returns:

if Consul connection fails: - newResponse is null if Consul connection successful: - newResponse is non-null, and - newResponse.getValue() != null, and - newResponse.getValue().size() == number of IPs registered for serviceName in Consul