HostsStatisticsMXBean.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community 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://opensource.org/licenses/ecl2.txt
 *
 * 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.
 *
 */

package org.opencastproject.serviceregistry.impl.jmx;

/**
 * JMX Bean interface exposing hosts statistics.
 */
public interface HostsStatisticsMXBean {

  /**
   * Gets a list of all hosts
   *
   * @return an array including all hosts
   */
  String[] getAll();

  /**
   * Gets a list of online hosts
   *
   * @return an array including online hosts
   */
  String[] getOnline();

  /**
   * Gets a list of offline hosts
   *
   * @return an array including offline hosts
   */
  String[] getOffline();

  /**
   * Gets a list of hosts in maintenance mode
   *
   * @return an array including hosts in maintenance mode
   */
  String[] getInMaintenance();

  /**
   * Gets the total number of hosts
   *
   * @return the number of hosts
   */
  int getTotalCount();

  /**
   * Gets the number of online hosts
   *
   * @return the number of online hosts
   */
  int getOnlineCount();

  /**
   * Gets the number of offline hosts
   *
   * @return the number of offline hosts
   */
  int getOfflineCount();

  /**
   * Gets the number of hosts in maintenance mode
   *
   * @return the number of hosts in maintenance mode
   */
  int getInMaintenanceCount();

}