hbase-common/src/main/java/org/apache/hadoop/hbase/HBaseInterfaceAudience.java

   1 /**
   2  * Licensed to the Apache Software Foundation (ASF) under one
   3  * or more contributor license agreements.  See the NOTICE file
   4  * distributed with this work for additional information
   5  * regarding copyright ownership.  The ASF licenses this file
   6  * to you under the Apache License, Version 2.0 (the
   7  * "License"); you may not use this file except in compliance
   8  * with the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package org.apache.hadoop.hbase;
  19
  20 import org.apache.yetus.audience.InterfaceAudience;
  21
  22 // TODO move this to hbase-annotations non-test-jar
  23
  24 /**
  25  * This class defines constants for different classes of hbase limited private apis
  26  */
  27 @InterfaceAudience.Public
  28 public final class HBaseInterfaceAudience {
  29
  30   /**
  31    * Can't create this class.
  32    */
  33   private HBaseInterfaceAudience(){}
  34
  35   public static final String COPROC = "Coprocesssor";
  36   public static final String REPLICATION = "Replication";
  37   public static final String PHOENIX = "Phoenix";
  38   public static final String SPARK = "Spark";
  39   public static final String UNITTEST = "Unittest";
  40
  41   /**
  42    * Denotes class names that appear in user facing configuration files.
  43    */
  44   public static final String CONFIG = "Configuration";
  45
  46   /**
  47    * Denotes classes used as tools (Used from cmd line). Usually, the compatibility is required
  48    * for class name, and arguments.
  49    */
  50   public static final String TOOLS = "Tools";
  51
  52   /**
  53    * Denotes classes used by hbck tool for fixing inconsistent state of HBase.
  54    */
  55   public static final String HBCK = "HBCK";
  56
  57   /**
  58    * Denotes classes that can be used to build custom authentication solutions.
  59    */
  60   public static final String AUTHENTICATION = "Authentication";
  61 }