org.kiwiproject.consul.HealthClient Maven / Gradle / Ivy
package org.kiwiproject.consul;
import org.kiwiproject.consul.async.ConsulResponseCallback;
import org.kiwiproject.consul.config.ClientConfig;
import org.kiwiproject.consul.model.ConsulResponse;
import org.kiwiproject.consul.model.State;
import org.kiwiproject.consul.model.health.HealthCheck;
import org.kiwiproject.consul.model.health.ServiceHealth;
import org.kiwiproject.consul.monitoring.ClientEventCallback;
import org.kiwiproject.consul.option.QueryOptions;
import retrofit2.Call;
import retrofit2.Retrofit;
import retrofit2.http.GET;
import retrofit2.http.HeaderMap;
import retrofit2.http.Path;
import retrofit2.http.Query;
import retrofit2.http.QueryMap;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* HTTP Client for /v1/health/ endpoints.
*/
public class HealthClient extends BaseCacheableClient {
private static final String CLIENT_NAME = "health";
private final Api api;
/**
* Constructs an instance of this class.
*
* @param retrofit The {@link Retrofit} to build a client from.
*/
HealthClient(Retrofit retrofit, ClientConfig config, ClientEventCallback eventCallback, Consul.NetworkTimeoutConfig networkTimeoutConfig) {
super(CLIENT_NAME, config, eventCallback, networkTimeoutConfig);
this.api = retrofit.create(Api.class);
}
/**
* Retrieves the healthchecks for a node.
*
* GET /v1/health/node/{node}
*
* @param node The node to return checks for
* @return A {@link ConsulResponse} containing a list of
* {@link HealthCheck} objects.
*/
public ConsulResponse> getNodeChecks(String node) {
return getNodeChecks(node, QueryOptions.BLANK);
}
/**
* Retrieves the healthchecks for a node in a given datacenter with {@link QueryOptions}.
*
* GET /v1/health/node/{node}?dc={datacenter}
*
* @param node The node to return checks for
* @param queryOptions The Query Options to use.
* @return A {@link ConsulResponse} containing a list of
* {@link HealthCheck} objects.
*/
public ConsulResponse> getNodeChecks(String node,
QueryOptions queryOptions) {
return http.extractConsulResponse(api.getNodeChecks(node, queryOptions.toQuery(),
queryOptions.getTag(), queryOptions.getNodeMeta(), queryOptions.toHeaders()));
}
/**
* Retrieves the healthchecks for a service.
*
* GET /v1/health/checks/{service}
*
* @param service the name of the service to get health checks for
* @return A {@link ConsulResponse} containing a list of
* {@link HealthCheck} objects.
*/
public ConsulResponse> getServiceChecks(String service) {
return getServiceChecks(service, QueryOptions.BLANK);
}
/**
* Retrieves the healthchecks for a service in a given datacenter with {@link QueryOptions}.
*
* GET /v1/health/checks/{service}?dc={datacenter}
*
* @param service the name of the service to get health checks for
* @param queryOptions The Query Options to use.
* @return A {@link ConsulResponse} containing a list of
* {@link HealthCheck} objects.
*/
public ConsulResponse> getServiceChecks(String service,
QueryOptions queryOptions) {
return http.extractConsulResponse(api.getServiceChecks(service, queryOptions.toQuery(),
queryOptions.getTag(), queryOptions.getNodeMeta(), queryOptions.toHeaders()));
}
/**
* Asynchronously retrieves the healthchecks for a service in a given
* datacenter with {@link QueryOptions}.
*
* GET /v1/health/checks/{service}?dc={datacenter}
*
* @param service The service to query.
* @param queryOptions The Query Options to use.
* @param callback Callback implemented by callee to handle results.
* {@link HealthCheck} objects.
*/
public void getServiceChecks(String service,
QueryOptions queryOptions,
ConsulResponseCallback> callback) {
http.extractConsulResponse(api.getServiceChecks(service, queryOptions.toQuery(),
queryOptions.getTag(), queryOptions.getNodeMeta(), queryOptions.toHeaders()), callback);
}
/**
* Retrieves the healthchecks for a state.
*
* GET /v1/health/state/{state}
*
* @param state The state to query.
* @return A {@link ConsulResponse} containing a list of
* {@link HealthCheck} objects.
*/
public ConsulResponse> getChecksByState(State state) {
return getChecksByState(state, QueryOptions.BLANK);
}
/**
* Retrieves the healthchecks for a state in a given datacenter with {@link QueryOptions}.
*
* GET /v1/health/state/{state}?dc={datacenter}
*
* @param state The state to query.
* @param queryOptions The Query Options to use.
* @return A {@link ConsulResponse} containing a list of
* {@link HealthCheck} objects.
*/
public ConsulResponse> getChecksByState(State state,
QueryOptions queryOptions) {
return http.extractConsulResponse(api.getChecksByState(state.getName(), queryOptions.toQuery(),
queryOptions.getTag(), queryOptions.getNodeMeta(), queryOptions.toHeaders()));
}
/**
* Asynchronously retrieves the healthchecks for a state in a given datacenter with {@link QueryOptions}.
*
* GET /v1/health/state/{state}?dc={datacenter}
*
* @param state The state to query.
* @param queryOptions The Query Options to use.
* @param callback Callback implemented by callee to handle results, containing a list of {@link HealthCheck} objects.
*/
public void getChecksByState(State state, QueryOptions queryOptions,
ConsulResponseCallback> callback) {
http.extractConsulResponse(api.getChecksByState(state.getName(), queryOptions.toQuery(),
queryOptions.getTag(), queryOptions.getNodeMeta(), queryOptions.toHeaders()), callback);
}
/**
* Retrieves the healthchecks for all healthy service instances.
*
* GET /v1/health/service/{service}?passing
*
* @param service The service to query.
* @return A {@link ConsulResponse} containing a list of
* {@link HealthCheck} objects.
*/
public ConsulResponse> getHealthyServiceInstances(String service) {
return getHealthyServiceInstances(service, QueryOptions.BLANK);
}
/**
* Retrieves the healthchecks for all healthy service instances in a given datacenter with
* {@link QueryOptions}.
*
* GET /v1/health/service/{service}?dc={datacenter}&passing
*
* @param service The service to query.
* @param queryOptions The Query Options to use.
* @return A {@link ConsulResponse} containing a list of
* {@link HealthCheck} objects.
*/
public ConsulResponse> getHealthyServiceInstances(String service,
QueryOptions queryOptions) {
return http.extractConsulResponse(api.getServiceInstances(service,
optionsFrom(Map.of("passing", "true"), queryOptions.toQuery()),
queryOptions.getTag(), queryOptions.getNodeMeta(), queryOptions.toHeaders()));
}
/**
* Asynchronously retrieves the healthchecks for all healthy service instances in a given
* datacenter with {@link QueryOptions}.
*
* GET /v1/health/service/{service}?dc={datacenter}&passing
*
* Experimental.
*
* @param service The service to query.
* @param queryOptions The Query Options to use.
* @param callback Callback implemented by callee to handle results.
*/
public void getHealthyServiceInstances(String service, QueryOptions queryOptions,
ConsulResponseCallback> callback) {
http.extractConsulResponse(api.getServiceInstances(service,
optionsFrom(Map.of("passing", "true"), queryOptions.toQuery()),
queryOptions.getTag(), queryOptions.getNodeMeta(), queryOptions.toHeaders()), callback);
}
/**
* Retrieves the healthchecks for all nodes.
*
* GET /v1/health/service/{service}
*
* @param service The service to query.
* @return A {@link ConsulResponse} containing a list of
* {@link HealthCheck} objects.
*/
public ConsulResponse> getAllServiceInstances(String service) {
return getAllServiceInstances(service, QueryOptions.BLANK);
}
/**
* Retrieves the healthchecks for all nodes in a given datacenter with
* {@link QueryOptions}.
*
* GET /v1/health/service/{service}?dc={datacenter}
*
* @param service The service to query.
* @param queryOptions The Query Options to use.
* @return A {@link ConsulResponse} containing a list of
* {@link HealthCheck} objects.
*/
public ConsulResponse> getAllServiceInstances(String service, QueryOptions queryOptions) {
return http.extractConsulResponse(api.getServiceInstances(service, queryOptions.toQuery(),
queryOptions.getTag(), queryOptions.getNodeMeta(), queryOptions.toHeaders()));
}
/**
* Asynchronously retrieves the healthchecks for all nodes in a given
* datacenter with {@link QueryOptions}.
*
* GET /v1/health/service/{service}?dc={datacenter}
*
* Experimental.
*
* @param service The service to query.
* @param queryOptions The Query Options to use.
* @param callback Callback implemented by callee to handle results.
*/
public void getAllServiceInstances(String service, QueryOptions queryOptions,
ConsulResponseCallback> callback) {
http.extractConsulResponse(api.getServiceInstances(service, queryOptions.toQuery(),
queryOptions.getTag(), queryOptions.getNodeMeta(), queryOptions.toHeaders()), callback);
}
@SafeVarargs
private static Map optionsFrom(Map... options) {
Map result = new HashMap<>();
for (Map option : options) {
result.putAll(option);
}
return result;
}
/**
* Retrofit API interface.
*/
interface Api {
@GET("health/node/{node}")
Call> getNodeChecks(@Path("node") String node,
@QueryMap Map query,
@Query("tag") List tag,
@Query("node-meta") List nodeMeta,
@HeaderMap Map headers);
@GET("health/checks/{service}")
Call> getServiceChecks(@Path("service") String service,
@QueryMap Map query,
@Query("tag") List tag,
@Query("node-meta") List nodeMeta,
@HeaderMap Map headers);
@GET("health/state/{state}")
Call> getChecksByState(@Path("state") String state,
@QueryMap Map query,
@Query("tag") List tag,
@Query("node-meta") List nodeMeta,
@HeaderMap Map headers);
@GET("health/service/{service}")
Call> getServiceInstances(@Path("service") String service,
@QueryMap Map query,
@Query("tag") List tag,
@Query("node-meta") List nodeMeta,
@HeaderMap Map headers);
}
}