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 hosts statistics.
26 */
27 public interface HostsStatisticsMXBean {
28
29 /**
30 * Gets a list of all hosts
31 *
32 * @return an array including all hosts
33 */
34 String[] getAll();
35
36 /**
37 * Gets a list of online hosts
38 *
39 * @return an array including online hosts
40 */
41 String[] getOnline();
42
43 /**
44 * Gets a list of offline hosts
45 *
46 * @return an array including offline hosts
47 */
48 String[] getOffline();
49
50 /**
51 * Gets a list of hosts in maintenance mode
52 *
53 * @return an array including hosts in maintenance mode
54 */
55 String[] getInMaintenance();
56
57 /**
58 * Gets the total number of hosts
59 *
60 * @return the number of hosts
61 */
62 int getTotalCount();
63
64 /**
65 * Gets the number of online hosts
66 *
67 * @return the number of online hosts
68 */
69 int getOnlineCount();
70
71 /**
72 * Gets the number of offline hosts
73 *
74 * @return the number of offline hosts
75 */
76 int getOfflineCount();
77
78 /**
79 * Gets the number of hosts in maintenance mode
80 *
81 * @return the number of hosts in maintenance mode
82 */
83 int getInMaintenanceCount();
84
85 }