geode-core/src/main/java/org/apache/geode/admin/DistributedSystemHealthConfig.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You 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.
 */
package org.apache.geode.admin;

/**
 * Provides configuration information relating to the health of an entire GemFire distributed
 * system.
 *
 * <P>
 *
 * If any of the following criteria is true, then the distributed system is considered to be in
 * {@link GemFireHealth#OKAY_HEALTH OKAY_HEALTH}.
 *
 * <UL>
 *
 * </UL>
 *
 * If any of the following criteria is true, then the distributed system is considered to be in
 * {@link GemFireHealth#POOR_HEALTH POOR_HEALTH}.
 *
 * <UL>
 *
 * <LI>Too many application members {@linkplain #getMaxDepartedApplications unexpectedly leave} the
 * distributed system.</LI>
 *
 * <LI>Too many application members {@linkplain #getMaxDepartedApplications unexpectedly leave} the
 * distributed system.</LI>
 *
 * </UL>
 *
 *
 * @since GemFire 3.5
 * @deprecated as of 7.0 use the <code><a href=
 *             "{@docRoot}/org/apache/geode/management/package-summary.html">management</a></code>
 *             package instead
 */
public interface DistributedSystemHealthConfig {

  /**
   * The default maximum number of application members that can unexceptedly leave a healthy the
   * distributed system.
   */
  long DEFAULT_MAX_DEPARTED_APPLICATIONS = 10;

  /////////////////////// Instance Methods ///////////////////////

  /**
   * Returns the maximum number of application members that can unexceptedly leave a healthy the
   * distributed system.
   *
   * @see #DEFAULT_MAX_DEPARTED_APPLICATIONS
   */
  long getMaxDepartedApplications();

  /**
   * Sets the maximum number of application members that can unexceptedly leave a healthy the
   * distributed system.
   *
   * @see #getMaxDepartedApplications
   */
  void setMaxDepartedApplications(long maxDepartedApplications);
}