/*
 * 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.hadoop.hbase.rest;

import org.apache.hadoop.hbase.metrics.BaseSource;
import org.apache.hadoop.hbase.metrics.JvmPauseMonitorSource;
import org.apache.yetus.audience.InterfaceAudience;

/**
 * Interface of the Metrics Source that will export data to Hadoop's Metrics2 system.
 */
@InterfaceAudience.Private
public interface MetricsRESTSource extends BaseSource, JvmPauseMonitorSource {

  String METRICS_NAME = "REST";

  String CONTEXT = "rest";

  String JMX_CONTEXT = "REST";

  String METRICS_DESCRIPTION = "Metrics about the HBase REST server";

  String REQUEST_KEY = "requests";

  String SUCCESSFUL_GET_KEY = "successfulGet";

  String SUCCESSFUL_PUT_KEY = "successfulPut";

  String SUCCESSFUL_DELETE_KEY = "successfulDelete";

  String FAILED_GET_KEY = "failedGet";

  String FAILED_PUT_KEY = "failedPut";

  String FAILED_DELETE_KEY = "failedDelete";

  String SUCCESSFUL_SCAN_KEY = "successfulScanCount";

  String FAILED_SCAN_KEY = "failedScanCount";

  String SUCCESSFUL_APPEND_KEY = "successfulAppendCount";

  String FAILED_APPEND_KEY = "failedAppendCount";

  String SUCCESSFUL_INCREMENT_KEY = "successfulIncrementCount";

  String FAILED_INCREMENT_KEY = "failedIncrementCount";

  /**
   * Increment the number of requests
   * @param inc Ammount to increment by
   */
  void incrementRequests(int inc);

  /**
   * Increment the number of successful Get requests.
   * @param inc Number of successful get requests.
   */
  void incrementSucessfulGetRequests(int inc);

  /**
   * Increment the number of successful Put requests.
   * @param inc Number of successful put requests.
   */
  void incrementSucessfulPutRequests(int inc);

  /**
   * Increment the number of successful Delete requests.
   */
  void incrementSucessfulDeleteRequests(int inc);

  /**
   * Increment the number of failed Put Requests.
   * @param inc Number of failed Put requests.
   */
  void incrementFailedPutRequests(int inc);

  /**
   * Increment the number of failed Get requests.
   * @param inc The number of failed Get Requests.
   */
  void incrementFailedGetRequests(int inc);

  /**
   * Increment the number of failed Delete requests.
   * @param inc The number of failed delete requests.
   */
  void incrementFailedDeleteRequests(int inc);

  /**
   * Increment the number of successful scan requests.
   * @param inc Number of successful scan requests.
   */
  void incrementSucessfulScanRequests(final int inc);

  /**
   * Increment the number failed scan requests.
   * @param inc Number of failed scan requests.
   */
  void incrementFailedScanRequests(final int inc);

  /**
   * Increment the number of successful append requests.
   * @param inc Number of successful append requests.
   */
  void incrementSucessfulAppendRequests(final int inc);

  /**
   * Increment the number failed append requests.
   * @param inc Number of failed append requests.
   */
  void incrementFailedAppendRequests(final int inc);

  /**
   * Increment the number of successful increment requests.
   * @param inc Number of successful increment requests.
   */
  void incrementSucessfulIncrementRequests(final int inc);

  /**
   * Increment the number failed increment requests.
   * @param inc Number of failed increment requests.
   */
  void incrementFailedIncrementRequests(final int inc);
}
