/*
 * 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
 *
 *   https://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.accumulo.server;

/**
 * This interface allows service implementations which support running multiple instances
 * concurrently with only one active instance to report whether or not they are the active service.
 */
public interface HighlyAvailableService {

  /**
   * Is this service instance currently the active instance for the Accumulo cluster.
   *
   * @return True if the service is the active service, false otherwise.
   */
  boolean isActiveService();

  /**
   * Is this service instance currently in the process of upgrading.
   *
   * @return True if the service is upgrading, false otherwise.
   */
  default boolean isUpgrading() {
    return false;
  }

  /**
   * Get the name of the service
   *
   * @return service name
   */
  default String getServiceName() {
    return this.getClass().getSimpleName();
  }
}
