1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.serviceregistry.impl.jmx;
23
24 /**
25 * JMX Bean interface exposing service statistics.
26 */
27 public interface ServicesStatisticsMXBean {
28
29 /**
30 * Gets a list of all services
31 *
32 * @return an array including all services
33 */
34 String[] getServices();
35
36 /**
37 * Gets a list of all normal services
38 *
39 * @return an array including all normal services
40 */
41 String[] getNormalServices();
42
43 /**
44 * Gets a list of all services in warning state
45 *
46 * @return an array including all services in warning state
47 */
48 String[] getWarningServices();
49
50 /**
51 * Gets a list of all services in error state
52 *
53 * @return an array including all services in error state
54 */
55 String[] getErrorServices();
56
57 /**
58 * Gets a list of all services of this JMX node
59 *
60 * @return an array including all services of this JMX node
61 */
62 String[] getServicesByNode();
63
64 /**
65 * Gets a list of all normal services of this JMX node
66 *
67 * @return an array including all normal services of this JMX node
68 */
69 String[] getNormalServicesByNode();
70
71 /**
72 * Gets a list of all services in warning state of this JMX node
73 *
74 * @return an array including all services in warning state of this JMX node
75 */
76 String[] getWarningServicesByNode();
77
78 /**
79 * Gets a list of all services in error state of this JMX node
80 *
81 * @return an array including all services in error state of this JMX node
82 */
83 String[] getErrorServicesByNode();
84
85 /**
86 * Gets the total number of services
87 *
88 * @return the number of services
89 */
90 int getServiceCount();
91
92 /**
93 * Gets the total number of normal services
94 *
95 * @return the number of normal services
96 */
97 int getNormalServiceCount();
98
99 /**
100 * Gets the total number of services in warning state
101 *
102 * @return the number of services in warning state
103 */
104 int getWarningServiceCount();
105
106 /**
107 * Gets the total number of services in error state
108 *
109 * @return the number of services in error state
110 */
111 int getErrorServiceCount();
112
113 /**
114 * Gets the number of services of this JMX node
115 *
116 * @return the number of services of this JMX node
117 */
118 int getServiceCountByNode();
119
120 /**
121 * Gets the number of normal services of this JMX node
122 *
123 * @return the number of normal services of this JMX node
124 */
125 int getNormalServiceCountByNode();
126
127 /**
128 * Gets the number of services in warning state of this JMX node
129 *
130 * @return the number of services in warning state
131 */
132 int getWarningServiceCountByNode();
133
134 /**
135 * Gets the number of services in error state of this JMX node
136 *
137 * @return the number of services in error state
138 */
139 int getErrorServiceCountByNode();
140
141 }