blob: c63652b261c2ddc5cd7c1fe2979d0934b1058ed2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
/*******************************************************************************
* =============LICENSE_START=========================================================
*
* =================================================================================
* Copyright (c) 2019 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*
* ECOMP is a trademark and service mark of AT&T Intellectual Property.
*******************************************************************************/
package org.onap.ccsdk.dashboard.rest;
import java.util.List;
import org.onap.ccsdk.dashboard.model.ConsulDatacenter;
import org.onap.ccsdk.dashboard.model.ConsulHealthServiceRegistration;
import org.onap.ccsdk.dashboard.model.ConsulNodeInfo;
import org.onap.ccsdk.dashboard.model.ConsulServiceHealth;
import org.onap.ccsdk.dashboard.model.ConsulServiceInfo;
/**
* Defines the interface of the Consul REST client.
*/
public interface ConsulClient {
/**
* Gets all the services that are monitored by Consul.
*
* @return List of ConsulServiceHealth
*/
public List<ConsulServiceInfo> getServices(String datacenter);
/**
* Gets the status for the specified service on all nodes.
*
* @param serviceName Service name
* @return List of ConsulServiceHealth
*/
public List<ConsulServiceHealth> getServiceHealth(String datacenter, String srvcName);
/**
* Gets all the nodes that are monitored by Consul.
*
* @return List of ConsulNodeHealth
*/
public List<ConsulNodeInfo> getNodes(String datacenter);
/**
* Gets the status for all registered services running on the specified node.
*
* @param nodeId Node ID
* @return List of ConsulServiceHealth
*/
public List<ConsulServiceHealth> getNodeServicesHealth(String datacenter, String nodeId);
/**
* Gets all the data centers that are monitored by Consul.
*
* @return List of ConsulDatacenter objects
*/
public List<ConsulDatacenter> getDatacenters();
/**
* Registers a service with Consul for health check.
*
* @param registration Details about the service to be registered.
* @return Result of registering a service
*/
public String registerService(ConsulHealthServiceRegistration registration);
/**
* Deregisters a service with Consul for health check.
*
* @param serviceName Name of the service to be deregistered.
* @return Response code
*/
public int deregisterService(String serviceName);
}
|
