View Javadoc

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 static org.apache.hadoop.hbase.io.hfile.BlockType.MAGIC_LENGTH;
21  
22  import java.nio.ByteBuffer;
23  import java.nio.charset.Charset;
24  import java.util.Arrays;
25  import java.util.Collections;
26  import java.util.List;
27  import java.util.UUID;
28  import java.util.regex.Pattern;
29  
30  import org.apache.commons.lang.ArrayUtils;
31  import org.apache.hadoop.hbase.classification.InterfaceAudience;
32  import org.apache.hadoop.hbase.classification.InterfaceStability;
33  import org.apache.hadoop.hbase.util.Bytes;
34  
35  /**
36   * HConstants holds a bunch of HBase-related constants
37   */
38  @InterfaceAudience.Public
39  @InterfaceStability.Stable
40  public final class HConstants {
41    // NOTICE!!!! Please do not add a constants here, unless they are referenced by a lot of classes.
42  
43    //Bytes.UTF8_ENCODING should be updated if this changed
44    /** When we encode strings, we always specify UTF8 encoding */
45    public static final String UTF8_ENCODING = "UTF-8";
46  
47    //Bytes.UTF8_CHARSET should be updated if this changed
48    /** When we encode strings, we always specify UTF8 encoding */
49    public static final Charset UTF8_CHARSET = Charset.forName(UTF8_ENCODING);
50    /**
51     * Default block size for an HFile.
52     */
53    public final static int DEFAULT_BLOCKSIZE = 64 * 1024;
54  
55    /** Used as a magic return value while optimized index key feature enabled(HBASE-7845) */
56    public final static int INDEX_KEY_MAGIC = -2;
57    /*
58       * Name of directory that holds recovered edits written by the wal log
59       * splitting code, one per region
60       */
61    public static final String RECOVERED_EDITS_DIR = "recovered.edits";
62    /**
63     * The first four bytes of Hadoop RPC connections
64     */
65    public static final byte[] RPC_HEADER = new byte[] { 'H', 'B', 'a', 's' };
66    public static final byte RPC_CURRENT_VERSION = 0;
67  
68    // HFileBlock constants.
69  
70    /** The size data structures with minor version is 0 */
71    public static final int HFILEBLOCK_HEADER_SIZE_NO_CHECKSUM = MAGIC_LENGTH + 2 * Bytes.SIZEOF_INT
72        + Bytes.SIZEOF_LONG;
73    /** The size of a version 2 HFile block header, minor version 1.
74     * There is a 1 byte checksum type, followed by a 4 byte bytesPerChecksum
75     * followed by another 4 byte value to store sizeofDataOnDisk.
76     */
77    public static final int HFILEBLOCK_HEADER_SIZE = HFILEBLOCK_HEADER_SIZE_NO_CHECKSUM +
78      Bytes.SIZEOF_BYTE + 2 * Bytes.SIZEOF_INT;
79    /** Just an array of bytes of the right size. */
80    public static final byte[] HFILEBLOCK_DUMMY_HEADER = new byte[HFILEBLOCK_HEADER_SIZE];
81  
82    //End HFileBlockConstants.
83  
84    /**
85     * Status codes used for return values of bulk operations.
86     */
87    @InterfaceAudience.Private
88    public enum OperationStatusCode {
89      NOT_RUN,
90      SUCCESS,
91      BAD_FAMILY,
92      SANITY_CHECK_FAILURE,
93      FAILURE;
94    }
95  
96    /** long constant for zero */
97    public static final Long ZERO_L = Long.valueOf(0L);
98    public static final String NINES = "99999999999999";
99    public static final String ZEROES = "00000000000000";
100 
101   // For migration
102 
103   /** name of version file */
104   public static final String VERSION_FILE_NAME = "hbase.version";
105 
106   /**
107    * Current version of file system.
108    * Version 4 supports only one kind of bloom filter.
109    * Version 5 changes versions in catalog table regions.
110    * Version 6 enables blockcaching on catalog tables.
111    * Version 7 introduces hfile -- hbase 0.19 to 0.20..
112    * Version 8 introduces namespace
113    */
114   // public static final String FILE_SYSTEM_VERSION = "6";
115   public static final String FILE_SYSTEM_VERSION = "8";
116 
117   // Configuration parameters
118 
119   //TODO: Is having HBase homed on port 60k OK?
120 
121   /** Cluster is in distributed mode or not */
122   public static final String CLUSTER_DISTRIBUTED = "hbase.cluster.distributed";
123 
124   /** Config for pluggable load balancers */
125   public static final String HBASE_MASTER_LOADBALANCER_CLASS = "hbase.master.loadbalancer.class";
126 
127   /** Config for balancing the cluster by table */
128   public static final String HBASE_MASTER_LOADBALANCE_BYTABLE = "hbase.master.loadbalance.bytable";
129 
130   /** The name of the ensemble table */
131   public static final String ENSEMBLE_TABLE_NAME = "hbase:ensemble";
132 
133   /** Config for pluggable region normalizer */
134   public static final String HBASE_MASTER_NORMALIZER_CLASS =
135     "hbase.master.normalizer.class";
136 
137   /** Config for enabling/disabling pluggable region normalizer */
138   public static final String HBASE_NORMALIZER_ENABLED =
139     "hbase.normalizer.enabled";
140 
141   /** Cluster is standalone or pseudo-distributed */
142   public static final boolean CLUSTER_IS_LOCAL = false;
143 
144   /** Cluster is fully-distributed */
145   public static final boolean CLUSTER_IS_DISTRIBUTED = true;
146 
147   /** Default value for cluster distributed mode */
148   public static final boolean DEFAULT_CLUSTER_DISTRIBUTED = CLUSTER_IS_LOCAL;
149 
150   /** default host address */
151   public static final String DEFAULT_HOST = "0.0.0.0";
152 
153   /** Parameter name for port master listens on. */
154   public static final String MASTER_PORT = "hbase.master.port";
155 
156   /** default port that the master listens on */
157   public static final int DEFAULT_MASTER_PORT = 16000;
158 
159   /** default port for master web api */
160   public static final int DEFAULT_MASTER_INFOPORT = 16010;
161 
162   /** Configuration key for master web API port */
163   public static final String MASTER_INFO_PORT = "hbase.master.info.port";
164 
165   /** Parameter name for the master type being backup (waits for primary to go inactive). */
166   public static final String MASTER_TYPE_BACKUP = "hbase.master.backup";
167 
168   /** by default every master is a possible primary master unless the conf explicitly overrides it */
169   public static final boolean DEFAULT_MASTER_TYPE_BACKUP = false;
170 
171   /** Name of ZooKeeper quorum configuration parameter. */
172   public static final String ZOOKEEPER_QUORUM = "hbase.zookeeper.quorum";
173 
174   /** Name of ZooKeeper config file in conf/ directory. */
175   public static final String ZOOKEEPER_CONFIG_NAME = "zoo.cfg";
176 
177   /** Common prefix of ZooKeeper configuration properties */
178   public static final String ZK_CFG_PROPERTY_PREFIX =
179       "hbase.zookeeper.property.";
180 
181   public static final int ZK_CFG_PROPERTY_PREFIX_LEN =
182       ZK_CFG_PROPERTY_PREFIX.length();
183 
184   /**
185    * The ZK client port key in the ZK properties map. The name reflects the
186    * fact that this is not an HBase configuration key.
187    */
188   public static final String CLIENT_PORT_STR = "clientPort";
189 
190   /** Parameter name for the client port that the zookeeper listens on */
191   public static final String ZOOKEEPER_CLIENT_PORT =
192       ZK_CFG_PROPERTY_PREFIX + CLIENT_PORT_STR;
193 
194   /** Default client port that the zookeeper listens on */
195   public static final int DEFAULT_ZOOKEPER_CLIENT_PORT = 2181;
196 
197   /** Parameter name for the wait time for the recoverable zookeeper */
198   public static final String ZOOKEEPER_RECOVERABLE_WAITTIME = "hbase.zookeeper.recoverable.waittime";
199 
200   /** Default wait time for the recoverable zookeeper */
201   public static final long DEFAULT_ZOOKEPER_RECOVERABLE_WAITIME = 10000;
202 
203   /** Parameter name for the root dir in ZK for this cluster */
204   public static final String ZOOKEEPER_ZNODE_PARENT = "zookeeper.znode.parent";
205 
206   public static final String DEFAULT_ZOOKEEPER_ZNODE_PARENT = "/hbase";
207 
208   /**
209    * Parameter name for the limit on concurrent client-side zookeeper
210    * connections
211    */
212   public static final String ZOOKEEPER_MAX_CLIENT_CNXNS =
213       ZK_CFG_PROPERTY_PREFIX + "maxClientCnxns";
214 
215   /** Parameter name for the ZK data directory */
216   public static final String ZOOKEEPER_DATA_DIR =
217       ZK_CFG_PROPERTY_PREFIX + "dataDir";
218 
219   /** Parameter name for the ZK tick time */
220   public static final String ZOOKEEPER_TICK_TIME =
221       ZK_CFG_PROPERTY_PREFIX + "tickTime";
222 
223   /** Default limit on concurrent client-side zookeeper connections */
224   public static final int DEFAULT_ZOOKEPER_MAX_CLIENT_CNXNS = 300;
225 
226   /** Configuration key for ZooKeeper session timeout */
227   public static final String ZK_SESSION_TIMEOUT = "zookeeper.session.timeout";
228 
229   /** Default value for ZooKeeper session timeout */
230   public static final int DEFAULT_ZK_SESSION_TIMEOUT = 180 * 1000;
231 
232   /** Configuration key for whether to use ZK.multi */
233   public static final String ZOOKEEPER_USEMULTI = "hbase.zookeeper.useMulti";
234 
235   /** Parameter name for port region server listens on. */
236   public static final String REGIONSERVER_PORT = "hbase.regionserver.port";
237 
238   /** Default port region server listens on. */
239   public static final int DEFAULT_REGIONSERVER_PORT = 16020;
240 
241   /** default port for region server web api */
242   public static final int DEFAULT_REGIONSERVER_INFOPORT = 16030;
243 
244   /** A configuration key for regionserver info port */
245   public static final String REGIONSERVER_INFO_PORT =
246     "hbase.regionserver.info.port";
247 
248   /** A flag that enables automatic selection of regionserver info port */
249   public static final String REGIONSERVER_INFO_PORT_AUTO =
250       REGIONSERVER_INFO_PORT + ".auto";
251 
252   /** Parameter name for what region server implementation to use. */
253   public static final String REGION_SERVER_IMPL= "hbase.regionserver.impl";
254 
255   /** Parameter name for what master implementation to use. */
256   public static final String MASTER_IMPL= "hbase.master.impl";
257 
258   /** Parameter name for what hbase client implementation to use. */
259   public static final String HBASECLIENT_IMPL= "hbase.hbaseclient.impl";
260 
261   /** Parameter name for how often threads should wake up */
262   public static final String THREAD_WAKE_FREQUENCY = "hbase.server.thread.wakefrequency";
263 
264   /** Default value for thread wake frequency */
265   public static final int DEFAULT_THREAD_WAKE_FREQUENCY = 10 * 1000;
266 
267   /** Parameter name for how often we should try to write a version file, before failing */
268   public static final String VERSION_FILE_WRITE_ATTEMPTS = "hbase.server.versionfile.writeattempts";
269 
270   /** Parameter name for how often we should try to write a version file, before failing */
271   public static final int DEFAULT_VERSION_FILE_WRITE_ATTEMPTS = 3;
272 
273   /** Parameter name for how often a region should should perform a major compaction */
274   public static final String MAJOR_COMPACTION_PERIOD = "hbase.hregion.majorcompaction";
275 
276   /** Parameter name for the maximum batch of KVs to be used in flushes and compactions */
277   public static final String COMPACTION_KV_MAX = "hbase.hstore.compaction.kv.max";
278   public static final int COMPACTION_KV_MAX_DEFAULT = 10;
279 
280   /** Parameter name for HBase instance root directory */
281   public static final String HBASE_DIR = "hbase.rootdir";
282 
283   /** Parameter name for HBase client IPC pool type */
284   public static final String HBASE_CLIENT_IPC_POOL_TYPE = "hbase.client.ipc.pool.type";
285 
286   /** Parameter name for HBase client IPC pool size */
287   public static final String HBASE_CLIENT_IPC_POOL_SIZE = "hbase.client.ipc.pool.size";
288 
289   /** Parameter name for HBase client operation timeout, which overrides RPC timeout */
290   public static final String HBASE_CLIENT_OPERATION_TIMEOUT = "hbase.client.operation.timeout";
291 
292   /** Parameter name for HBase client operation timeout, which overrides RPC timeout */
293   public static final String HBASE_CLIENT_META_OPERATION_TIMEOUT =
294     "hbase.client.meta.operation.timeout";
295 
296   /** Default HBase client operation timeout, which is tantamount to a blocking call */
297   public static final int DEFAULT_HBASE_CLIENT_OPERATION_TIMEOUT = 1200000;
298 
299   /** Used to construct the name of the log directory for a region server */
300   public static final String HREGION_LOGDIR_NAME = "WALs";
301 
302   /** Used to construct the name of the splitlog directory for a region server */
303   public static final String SPLIT_LOGDIR_NAME = "splitWAL";
304 
305   /** Like the previous, but for old logs that are about to be deleted */
306   public static final String HREGION_OLDLOGDIR_NAME = "oldWALs";
307 
308   public static final String CORRUPT_DIR_NAME = "corrupt";
309 
310   /** Used by HBCK to sideline backup data */
311   public static final String HBCK_SIDELINEDIR_NAME = ".hbck";
312 
313   /** Any artifacts left from migration can be moved here */
314   public static final String MIGRATION_NAME = ".migration";
315 
316   /**
317    * The directory from which co-processor/custom filter jars can be loaded
318    * dynamically by the region servers. This value can be overridden by the
319    * hbase.dynamic.jars.dir config.
320    */
321   public static final String LIB_DIR = "lib";
322 
323   /** Used to construct the name of the compaction directory during compaction */
324   public static final String HREGION_COMPACTIONDIR_NAME = "compaction.dir";
325 
326   /** Conf key for the max file size after which we split the region */
327   public static final String HREGION_MAX_FILESIZE =
328       "hbase.hregion.max.filesize";
329 
330   /** Default maximum file size */
331   public static final long DEFAULT_MAX_FILE_SIZE = 10 * 1024 * 1024 * 1024L;
332 
333   /**
334    * Max size of single row for Get's or Scan's without in-row scanning flag set.
335    */
336   public static final String TABLE_MAX_ROWSIZE_KEY = "hbase.table.max.rowsize";
337 
338   /**
339    * Default max row size (1 Gb).
340    */
341   public static final long TABLE_MAX_ROWSIZE_DEFAULT = 1024 * 1024 * 1024L;
342 
343   /**
344    * The max number of threads used for opening and closing stores or store
345    * files in parallel
346    */
347   public static final String HSTORE_OPEN_AND_CLOSE_THREADS_MAX =
348     "hbase.hstore.open.and.close.threads.max";
349 
350   /**
351    * The default number for the max number of threads used for opening and
352    * closing stores or store files in parallel
353    */
354   public static final int DEFAULT_HSTORE_OPEN_AND_CLOSE_THREADS_MAX = 1;
355 
356   /**
357    * Block updates if memstore has hbase.hregion.memstore.block.multiplier
358    * times hbase.hregion.memstore.flush.size bytes.  Useful preventing
359    * runaway memstore during spikes in update traffic.
360    */
361   public static final String HREGION_MEMSTORE_BLOCK_MULTIPLIER =
362           "hbase.hregion.memstore.block.multiplier";
363 
364   /**
365    * Default value for hbase.hregion.memstore.block.multiplier
366    */
367   public static final int DEFAULT_HREGION_MEMSTORE_BLOCK_MULTIPLIER = 4;
368 
369   /** Conf key for the memstore size at which we flush the memstore */
370   public static final String HREGION_MEMSTORE_FLUSH_SIZE =
371       "hbase.hregion.memstore.flush.size";
372 
373   public static final String HREGION_EDITS_REPLAY_SKIP_ERRORS =
374       "hbase.hregion.edits.replay.skip.errors";
375 
376   public static final boolean DEFAULT_HREGION_EDITS_REPLAY_SKIP_ERRORS =
377       false;
378 
379   /** Maximum value length, enforced on KeyValue construction */
380   public static final int MAXIMUM_VALUE_LENGTH = Integer.MAX_VALUE - 1;
381 
382   /** name of the file for unique cluster ID */
383   public static final String CLUSTER_ID_FILE_NAME = "hbase.id";
384 
385   /** Default value for cluster ID */
386   public static final String CLUSTER_ID_DEFAULT = "default-cluster";
387 
388   /** Parameter name for # days to keep MVCC values during a major compaction */
389   public static final String KEEP_SEQID_PERIOD = "hbase.hstore.compaction.keep.seqId.period";
390   /** At least to keep MVCC values in hfiles for 5 days */
391   public static final int MIN_KEEP_SEQID_PERIOD = 5;
392 
393   // Always store the location of the root table's HRegion.
394   // This HRegion is never split.
395 
396   // region name = table + startkey + regionid. This is the row key.
397   // each row in the root and meta tables describes exactly 1 region
398   // Do we ever need to know all the information that we are storing?
399 
400   // Note that the name of the root table starts with "-" and the name of the
401   // meta table starts with "." Why? it's a trick. It turns out that when we
402   // store region names in memory, we use a SortedMap. Since "-" sorts before
403   // "." (and since no other table name can start with either of these
404   // characters, the root region will always be the first entry in such a Map,
405   // followed by all the meta regions (which will be ordered by their starting
406   // row key as well), followed by all user tables. So when the Master is
407   // choosing regions to assign, it will always choose the root region first,
408   // followed by the meta regions, followed by user regions. Since the root
409   // and meta regions always need to be on-line, this ensures that they will
410   // be the first to be reassigned if the server(s) they are being served by
411   // should go down.
412 
413 
414   /** The hbase:meta table's name. */
415   @Deprecated  // for compat from 0.94 -> 0.96.
416   public static final byte[] META_TABLE_NAME = TableName.META_TABLE_NAME.getName();
417 
418   public static final String BASE_NAMESPACE_DIR = "data";
419 
420   /** delimiter used between portions of a region name */
421   public static final int META_ROW_DELIMITER = ',';
422 
423   /** The catalog family as a string*/
424   public static final String CATALOG_FAMILY_STR = "info";
425 
426   /** The catalog family */
427   public static final byte [] CATALOG_FAMILY = Bytes.toBytes(CATALOG_FAMILY_STR);
428 
429   /** The RegionInfo qualifier as a string */
430   public static final String REGIONINFO_QUALIFIER_STR = "regioninfo";
431 
432   /** The regioninfo column qualifier */
433   public static final byte [] REGIONINFO_QUALIFIER = Bytes.toBytes(REGIONINFO_QUALIFIER_STR);
434 
435   /** The server column qualifier */
436   public static final String SERVER_QUALIFIER_STR = "server";
437   /** The server column qualifier */
438   public static final byte [] SERVER_QUALIFIER = Bytes.toBytes(SERVER_QUALIFIER_STR);
439 
440   /** The startcode column qualifier */
441   public static final String STARTCODE_QUALIFIER_STR = "serverstartcode";
442   /** The startcode column qualifier */
443   public static final byte [] STARTCODE_QUALIFIER = Bytes.toBytes(STARTCODE_QUALIFIER_STR);
444 
445   /** The open seqnum column qualifier */
446   public static final String SEQNUM_QUALIFIER_STR = "seqnumDuringOpen";
447   /** The open seqnum column qualifier */
448   public static final byte [] SEQNUM_QUALIFIER = Bytes.toBytes(SEQNUM_QUALIFIER_STR);
449 
450   /** The state column qualifier */
451   public static final String STATE_QUALIFIER_STR = "state";
452 
453   public static final byte [] STATE_QUALIFIER = Bytes.toBytes(STATE_QUALIFIER_STR);
454 
455   /**
456    * The serverName column qualifier. Its the server where the region is
457    * transitioning on, while column server is the server where the region is
458    * opened on. They are the same when the region is in state OPEN.
459    */
460   public static final String SERVERNAME_QUALIFIER_STR = "sn";
461 
462   public static final byte [] SERVERNAME_QUALIFIER = Bytes.toBytes(SERVERNAME_QUALIFIER_STR);
463 
464   /** The lower-half split region column qualifier */
465   public static final byte [] SPLITA_QUALIFIER = Bytes.toBytes("splitA");
466 
467   /** The upper-half split region column qualifier */
468   public static final byte [] SPLITB_QUALIFIER = Bytes.toBytes("splitB");
469 
470   /** The lower-half merge region column qualifier */
471   public static final byte[] MERGEA_QUALIFIER = Bytes.toBytes("mergeA");
472 
473   /** The upper-half merge region column qualifier */
474   public static final byte[] MERGEB_QUALIFIER = Bytes.toBytes("mergeB");
475 
476   /**
477    * The meta table version column qualifier.
478    * We keep current version of the meta table in this column in <code>-ROOT-</code>
479    * table: i.e. in the 'info:v' column.
480    */
481   public static final byte [] META_VERSION_QUALIFIER = Bytes.toBytes("v");
482 
483   /**
484    * The current version of the meta table.
485    * - pre-hbase 0.92.  There is no META_VERSION column in the root table
486    * in this case. The meta has HTableDescriptor serialized into the HRegionInfo;
487    * - version 0 is 0.92 and 0.94. Meta data has serialized HRegionInfo's using
488    * Writable serialization, and HRegionInfo's does not contain HTableDescriptors.
489    * - version 1 for 0.96+ keeps HRegionInfo data structures, but changes the
490    * byte[] serialization from Writables to Protobuf.
491    * See HRegionInfo.VERSION
492    */
493   public static final short META_VERSION = 1;
494 
495   // Other constants
496 
497   /**
498    * An empty instance.
499    */
500   public static final byte [] EMPTY_BYTE_ARRAY = new byte [0];
501 
502   /**
503    * Used by scanners, etc when they want to start at the beginning of a region
504    */
505   public static final byte [] EMPTY_START_ROW = EMPTY_BYTE_ARRAY;
506 
507   /**
508    * Last row in a table.
509    */
510   public static final byte [] EMPTY_END_ROW = EMPTY_START_ROW;
511 
512   /**
513     * Used by scanners and others when they're trying to detect the end of a
514     * table
515     */
516   public static final byte [] LAST_ROW = EMPTY_BYTE_ARRAY;
517 
518   /**
519    * Max length a row can have because of the limitation in TFile.
520    */
521   public static final int MAX_ROW_LENGTH = Short.MAX_VALUE;
522 
523   /**
524    * Timestamp to use when we want to refer to the latest cell.
525    * This is the timestamp sent by clients when no timestamp is specified on
526    * commit.
527    */
528   public static final long LATEST_TIMESTAMP = Long.MAX_VALUE;
529 
530   /**
531    * Timestamp to use when we want to refer to the oldest cell.
532    */
533   public static final long OLDEST_TIMESTAMP = Long.MIN_VALUE;
534 
535   /**
536    * LATEST_TIMESTAMP in bytes form
537    */
538   public static final byte [] LATEST_TIMESTAMP_BYTES = {
539     // big-endian
540     (byte) (LATEST_TIMESTAMP >>> 56),
541     (byte) (LATEST_TIMESTAMP >>> 48),
542     (byte) (LATEST_TIMESTAMP >>> 40),
543     (byte) (LATEST_TIMESTAMP >>> 32),
544     (byte) (LATEST_TIMESTAMP >>> 24),
545     (byte) (LATEST_TIMESTAMP >>> 16),
546     (byte) (LATEST_TIMESTAMP >>> 8),
547     (byte) LATEST_TIMESTAMP,
548   };
549 
550   /**
551    * Define for 'return-all-versions'.
552    */
553   public static final int ALL_VERSIONS = Integer.MAX_VALUE;
554 
555   /**
556    * Unlimited time-to-live.
557    */
558 //  public static final int FOREVER = -1;
559   public static final int FOREVER = Integer.MAX_VALUE;
560 
561   /**
562    * Seconds in a week
563    */
564   public static final int WEEK_IN_SECONDS = 7 * 24 * 3600;
565 
566   /**
567    * Seconds in a day, hour and minute
568    */
569   public static final int DAY_IN_SECONDS = 24 * 60 * 60;
570   public static final int HOUR_IN_SECONDS = 60 * 60;
571   public static final int MINUTE_IN_SECONDS = 60;
572 
573   //TODO: although the following are referenced widely to format strings for
574   //      the shell. They really aren't a part of the public API. It would be
575   //      nice if we could put them somewhere where they did not need to be
576   //      public. They could have package visibility
577   public static final String NAME = "NAME";
578   public static final String VERSIONS = "VERSIONS";
579   public static final String IN_MEMORY = "IN_MEMORY";
580   public static final String METADATA = "METADATA";
581   public static final String CONFIGURATION = "CONFIGURATION";
582 
583   /**
584    * Retrying we multiply hbase.client.pause setting by what we have in this array until we
585    * run out of array items.  Retries beyond this use the last number in the array.  So, for
586    * example, if hbase.client.pause is 1 second, and maximum retries count
587    * hbase.client.retries.number is 10, we will retry at the following intervals:
588    * 1, 2, 3, 5, 10, 20, 40, 100, 100, 100.
589    * With 100ms, a back-off of 200 means 20s
590    */
591   public static final int RETRY_BACKOFF[] = {1, 2, 3, 5, 10, 20, 40, 100, 100, 100, 100, 200, 200};
592 
593   public static final String REGION_IMPL = "hbase.hregion.impl";
594 
595   /** modifyTable op for replacing the table descriptor */
596   @InterfaceAudience.Private
597   public static enum Modify {
598     CLOSE_REGION,
599     TABLE_COMPACT,
600     TABLE_FLUSH,
601     TABLE_MAJOR_COMPACT,
602     TABLE_SET_HTD,
603     TABLE_SPLIT
604   }
605 
606   /**
607    * Scope tag for locally scoped data.
608    * This data will not be replicated.
609    */
610   public static final int REPLICATION_SCOPE_LOCAL = 0;
611 
612   /**
613    * Scope tag for globally scoped data.
614    * This data will be replicated to all peers.
615    */
616   public static final int REPLICATION_SCOPE_GLOBAL = 1;
617 
618   /**
619    * Default cluster ID, cannot be used to identify a cluster so a key with
620    * this value means it wasn't meant for replication.
621    */
622   public static final UUID DEFAULT_CLUSTER_ID = new UUID(0L,0L);
623 
624   /**
625    * Parameter name for maximum number of bytes returned when calling a scanner's next method.
626    * Controlled by the client.
627    */
628   public static final String HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE_KEY =
629       "hbase.client.scanner.max.result.size";
630 
631   /**
632    * Parameter name for maximum number of bytes returned when calling a scanner's next method.
633    * Controlled by the server.
634    */
635   public static final String HBASE_SERVER_SCANNER_MAX_RESULT_SIZE_KEY =
636       "hbase.server.scanner.max.result.size";
637 
638   /**
639    * Maximum number of bytes returned when calling a scanner's next method.
640    * Note that when a single row is larger than this limit the row is still
641    * returned completely.
642    *
643    * The default value is 2MB.
644    */
645   public static final long DEFAULT_HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE = 2 * 1024 * 1024;
646 
647   /**
648    * Maximum number of bytes returned when calling a scanner's next method.
649    * Note that when a single row is larger than this limit the row is still
650    * returned completely.
651    * Safety setting to protect the region server.
652    *
653    * The default value is 100MB. (a client would rarely request larger chunks on purpose)
654    */
655   public static final long DEFAULT_HBASE_SERVER_SCANNER_MAX_RESULT_SIZE = 100 * 1024 * 1024;
656 
657   /**
658    * Parameter name for client pause value, used mostly as value to wait
659    * before running a retry of a failed get, region lookup, etc.
660    */
661   public static final String HBASE_CLIENT_PAUSE = "hbase.client.pause";
662 
663   /**
664    * Default value of {@link #HBASE_CLIENT_PAUSE}.
665    */
666   public static final long DEFAULT_HBASE_CLIENT_PAUSE = 100;
667 
668   /**
669    * The maximum number of concurrent connections the client will maintain.
670    */
671   public static final String HBASE_CLIENT_MAX_TOTAL_TASKS = "hbase.client.max.total.tasks";
672 
673   /**
674    * Default value of {@link #HBASE_CLIENT_MAX_TOTAL_TASKS}.
675    */
676   public static final int DEFAULT_HBASE_CLIENT_MAX_TOTAL_TASKS = 100;
677 
678   /**
679    * The maximum number of concurrent connections the client will maintain to a single
680    * RegionServer.
681    */
682   public static final String HBASE_CLIENT_MAX_PERSERVER_TASKS = "hbase.client.max.perserver.tasks";
683 
684   /**
685    * Default value of {@link #HBASE_CLIENT_MAX_PERSERVER_TASKS}.
686    */
687   public static final int DEFAULT_HBASE_CLIENT_MAX_PERSERVER_TASKS = 2;
688 
689   /**
690    * The maximum number of concurrent connections the client will maintain to a single
691    * Region.
692    */
693   public static final String HBASE_CLIENT_MAX_PERREGION_TASKS = "hbase.client.max.perregion.tasks";
694 
695   /**
696    * Default value of {@link #HBASE_CLIENT_MAX_PERREGION_TASKS}.
697    */
698   public static final int DEFAULT_HBASE_CLIENT_MAX_PERREGION_TASKS = 1;
699 
700   /**
701    * Parameter name for server pause value, used mostly as value to wait before
702    * running a retry of a failed operation.
703    */
704   public static final String HBASE_SERVER_PAUSE = "hbase.server.pause";
705 
706   /**
707    * Default value of {@link #HBASE_SERVER_PAUSE}.
708    */
709   public static final int DEFAULT_HBASE_SERVER_PAUSE = 1000;
710 
711   /**
712    * Parameter name for maximum retries, used as maximum for all retryable
713    * operations such as fetching of the root region from root region server,
714    * getting a cell's value, starting a row update, etc.
715    */
716   public static final String HBASE_CLIENT_RETRIES_NUMBER = "hbase.client.retries.number";
717 
718   /**
719    * Default value of {@link #HBASE_CLIENT_RETRIES_NUMBER}.
720    */
721   public static final int DEFAULT_HBASE_CLIENT_RETRIES_NUMBER = 31;
722 
723   /**
724    * Parameter name to set the default scanner caching for all clients.
725    */
726   public static final String HBASE_CLIENT_SCANNER_CACHING = "hbase.client.scanner.caching";
727 
728   /**
729    * Default value for {@link #HBASE_CLIENT_SCANNER_CACHING}
730    */
731   public static final int DEFAULT_HBASE_CLIENT_SCANNER_CACHING = Integer.MAX_VALUE;
732 
733   /**
734    * Parameter name for number of versions, kept by meta table.
735    */
736   public static String HBASE_META_VERSIONS = "hbase.meta.versions";
737 
738   /**
739    * Default value of {@link #HBASE_META_VERSIONS}.
740    */
741   public static int DEFAULT_HBASE_META_VERSIONS = 10;
742 
743   /**
744    * Parameter name for number of versions, kept by meta table.
745    */
746   public static String HBASE_META_BLOCK_SIZE = "hbase.meta.blocksize";
747 
748   /**
749    * Default value of {@link #HBASE_META_BLOCK_SIZE}.
750    */
751   public static int DEFAULT_HBASE_META_BLOCK_SIZE = 8 * 1024;
752 
753   /**
754    * Parameter name for number of rows that will be fetched when calling next on
755    * a scanner if it is not served from memory. Higher caching values will
756    * enable faster scanners but will eat up more memory and some calls of next
757    * may take longer and longer times when the cache is empty.
758    */
759   public static final String HBASE_META_SCANNER_CACHING = "hbase.meta.scanner.caching";
760 
761   /**
762    * Default value of {@link #HBASE_META_SCANNER_CACHING}.
763    */
764   public static final int DEFAULT_HBASE_META_SCANNER_CACHING = 100;
765 
766   /**
767    * Parameter name for unique identifier for this {@link org.apache.hadoop.conf.Configuration}
768    * instance. If there are two or more {@link org.apache.hadoop.conf.Configuration} instances that,
769    * for all intents and purposes, are the same except for their instance ids, then they will not be
770    * able to share the same org.apache.hadoop.hbase.client.HConnection instance. On the other hand,
771    * even if the instance ids are the same, it could result in non-shared
772    * org.apache.hadoop.hbase.client.HConnection instances if some of the other connection parameters
773    * differ.
774    */
775   public static final String HBASE_CLIENT_INSTANCE_ID = "hbase.client.instance.id";
776 
777   /**
778    * The client scanner timeout period in milliseconds.
779    */
780   public static final String HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD = "hbase.client.scanner.timeout.period";
781 
782   /**
783    * Use {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD} instead.
784    * @deprecated This config option is deprecated. Will be removed at later releases after 0.96.
785    */
786   @Deprecated
787   public static final String HBASE_REGIONSERVER_LEASE_PERIOD_KEY =
788       "hbase.regionserver.lease.period";
789 
790   /**
791    * Default value of {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD}.
792    */
793   public static final int DEFAULT_HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD = 60000;
794 
795   /**
796    * timeout for each RPC
797    */
798   public static final String HBASE_RPC_TIMEOUT_KEY = "hbase.rpc.timeout";
799 
800   /**
801    * Default value of {@link #HBASE_RPC_TIMEOUT_KEY}
802    */
803   public static final int DEFAULT_HBASE_RPC_TIMEOUT = 60000;
804 
805   /**
806    * timeout for short operation RPC
807    */
808   public static final String HBASE_RPC_SHORTOPERATION_TIMEOUT_KEY = "hbase.rpc.shortoperation.timeout";
809 
810   /**
811    * Default value of {@link #HBASE_RPC_SHORTOPERATION_TIMEOUT_KEY}
812    */
813   public static final int DEFAULT_HBASE_RPC_SHORTOPERATION_TIMEOUT = 10000;
814 
815   /**
816    * Value indicating the server name was saved with no sequence number.
817    */
818   public static final long NO_SEQNUM = -1;
819 
820 
821   /*
822    * cluster replication constants.
823    */
824   public static final String
825       REPLICATION_ENABLE_KEY = "hbase.replication";
826   public static final boolean
827       REPLICATION_ENABLE_DEFAULT = true;
828   public static final String
829       REPLICATION_SOURCE_SERVICE_CLASSNAME = "hbase.replication.source.service";
830   public static final String
831       REPLICATION_SINK_SERVICE_CLASSNAME = "hbase.replication.sink.service";
832   public static final String REPLICATION_SERVICE_CLASSNAME_DEFAULT =
833     "org.apache.hadoop.hbase.replication.regionserver.Replication";
834   public static final String REPLICATION_BULKLOAD_ENABLE_KEY = "hbase.replication.bulkload.enabled";
835   public static final boolean REPLICATION_BULKLOAD_ENABLE_DEFAULT = false;
836   /** Replication cluster id of source cluster which uniquely identifies itself with peer cluster */
837   public static final String REPLICATION_CLUSTER_ID = "hbase.replication.cluster.id";
838   /**
839    * Directory where the source cluster file system client configuration are placed which is used by
840    * sink cluster to copy HFiles from source cluster file system
841    */
842   public static final String REPLICATION_CONF_DIR = "hbase.replication.conf.dir";
843 
844   /** Maximum time to retry for a failed bulk load request */
845   public static final String BULKLOAD_MAX_RETRIES_NUMBER = "hbase.bulkload.retries.number";
846 
847   /** HBCK special code name used as server name when manipulating ZK nodes */
848   public static final String HBCK_CODE_NAME = "HBCKServerName";
849 
850   public static final String KEY_FOR_HOSTNAME_SEEN_BY_MASTER =
851     "hbase.regionserver.hostname.seen.by.master";
852 
853   public static final String HBASE_MASTER_LOGCLEANER_PLUGINS =
854       "hbase.master.logcleaner.plugins";
855 
856   public static final String HBASE_REGION_SPLIT_POLICY_KEY =
857     "hbase.regionserver.region.split.policy";
858 
859   /** Whether nonces are enabled; default is true. */
860   public static final String HBASE_RS_NONCES_ENABLED = "hbase.regionserver.nonces.enabled";
861 
862   /**
863    * Configuration key for the size of the block cache
864    */
865   public static final String HFILE_BLOCK_CACHE_SIZE_KEY =
866     "hfile.block.cache.size";
867 
868   public static final float HFILE_BLOCK_CACHE_SIZE_DEFAULT = 0.4f;
869 
870   /*
871     * Minimum percentage of free heap necessary for a successful cluster startup.
872     */
873   public static final float HBASE_CLUSTER_MINIMUM_MEMORY_THRESHOLD = 0.2f;
874 
875   public static final Pattern CP_HTD_ATTR_KEY_PATTERN = Pattern.compile
876       ("^coprocessor\\$([0-9]+)$", Pattern.CASE_INSENSITIVE);
877   public static final Pattern CP_HTD_ATTR_VALUE_PATTERN =
878       Pattern.compile("(^[^\\|]*)\\|([^\\|]+)\\|[\\s]*([\\d]*)[\\s]*(\\|.*)?$");
879 
880   public static final String CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN = "[^=,]+";
881   public static final String CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN = "[^,]+";
882   public static final Pattern CP_HTD_ATTR_VALUE_PARAM_PATTERN = Pattern.compile(
883       "(" + CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN + ")=(" +
884       CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN + "),?");
885 
886   /** The delay when re-trying a socket operation in a loop (HBASE-4712) */
887   public static final int SOCKET_RETRY_WAIT_MS = 200;
888 
889   /** Host name of the local machine */
890   public static final String LOCALHOST = "localhost";
891 
892   /**
893    * If this parameter is set to true, then hbase will read
894    * data and then verify checksums. Checksum verification
895    * inside hdfs will be switched off.  However, if the hbase-checksum
896    * verification fails, then it will switch back to using
897    * hdfs checksums for verifiying data that is being read from storage.
898    *
899    * If this parameter is set to false, then hbase will not
900    * verify any checksums, instead it will depend on checksum verification
901    * being done in the hdfs client.
902    */
903   public static final String HBASE_CHECKSUM_VERIFICATION =
904       "hbase.regionserver.checksum.verify";
905 
906   public static final String LOCALHOST_IP = "127.0.0.1";
907 
908   /** Conf key that enables unflushed WAL edits directly being replayed to region servers */
909   public static final String DISTRIBUTED_LOG_REPLAY_KEY = "hbase.master.distributed.log.replay";
910   public static final boolean DEFAULT_DISTRIBUTED_LOG_REPLAY_CONFIG = false;
911 
912   public static final String DISALLOW_WRITES_IN_RECOVERING =
913       "hbase.regionserver.disallow.writes.when.recovering";
914   public static final boolean DEFAULT_DISALLOW_WRITES_IN_RECOVERING_CONFIG = false;
915 
916   public static final String REGION_SERVER_HANDLER_COUNT = "hbase.regionserver.handler.count";
917   public static final int DEFAULT_REGION_SERVER_HANDLER_COUNT = 30;
918 
919   /*
920    * REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT:
921    * -1  => Disable aborting
922    * 0   => Abort if even a single handler has died
923    * 0.x => Abort only when this percent of handlers have died
924    * 1   => Abort only all of the handers have died
925    */
926   public static final String REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT =
927 		  "hbase.regionserver.handler.abort.on.error.percent";
928   public static final double DEFAULT_REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT = 0.5;
929 
930   //High priority handlers to deal with admin requests and system table operation requests
931   public static final String REGION_SERVER_HIGH_PRIORITY_HANDLER_COUNT =
932       "hbase.regionserver.metahandler.count";
933   public static final int DEFAULT_REGION_SERVER_HIGH_PRIORITY_HANDLER_COUNT = 20;
934 
935   public static final String REGION_SERVER_REPLICATION_HANDLER_COUNT =
936       "hbase.regionserver.replication.handler.count";
937   public static final int DEFAULT_REGION_SERVER_REPLICATION_HANDLER_COUNT = 3;
938 
939   public static final String MASTER_HANDLER_COUNT = "hbase.master.handler.count";
940   public static final int DEFAULT_MASTER_HANLDER_COUNT = 25;
941 
942   /** Conf key that specifies timeout value to wait for a region ready */
943   public static final String LOG_REPLAY_WAIT_REGION_TIMEOUT =
944       "hbase.master.log.replay.wait.region.timeout";
945 
946   /** Conf key for enabling meta replication */
947   public static final String USE_META_REPLICAS = "hbase.meta.replicas.use";
948   public static final boolean DEFAULT_USE_META_REPLICAS = false;
949   public static final String META_REPLICAS_NUM = "hbase.meta.replica.count";
950   public static final int DEFAULT_META_REPLICA_NUM = 1;
951 
952   /**
953    * The name of the configuration parameter that specifies
954    * the number of bytes in a newly created checksum chunk.
955    */
956   public static final String BYTES_PER_CHECKSUM =
957       "hbase.hstore.bytes.per.checksum";
958 
959   /**
960    * The name of the configuration parameter that specifies
961    * the name of an algorithm that is used to compute checksums
962    * for newly created blocks.
963    */
964   public static final String CHECKSUM_TYPE_NAME =
965       "hbase.hstore.checksum.algorithm";
966 
967   /** Enable file permission modification from standard hbase */
968   public static final String ENABLE_DATA_FILE_UMASK = "hbase.data.umask.enable";
969   /** File permission umask to use when creating hbase data files */
970   public static final String DATA_FILE_UMASK_KEY = "hbase.data.umask";
971 
972   /** Configuration name of WAL Compression */
973   public static final String ENABLE_WAL_COMPRESSION =
974     "hbase.regionserver.wal.enablecompression";
975 
976   /** Configuration name of WAL storage policy
977    * Valid values are:
978    *  NONE: no preference in destination of block replicas
979    *  ONE_SSD: place only one block replica in SSD and the remaining in default storage
980    *  and ALL_SSD: place all block replicas on SSD
981    *
982    * See http://hadoop.apache.org/docs/r2.6.0/hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html*/
983   public static final String WAL_STORAGE_POLICY = "hbase.wal.storage.policy";
984   public static final String DEFAULT_WAL_STORAGE_POLICY = "NONE";
985 
986   /** Region in Transition metrics threshold time */
987   public static final String METRICS_RIT_STUCK_WARNING_THRESHOLD="hbase.metrics.rit.stuck.warning.threshold";
988 
989   public static final String LOAD_BALANCER_SLOP_KEY = "hbase.regions.slop";
990 
991   /**
992    * The byte array represents for NO_NEXT_INDEXED_KEY;
993    * The actual value is irrelevant because this is always compared by reference.
994    */
995   public static final Cell NO_NEXT_INDEXED_KEY = new KeyValue();
996   /** delimiter used between portions of a region name */
997   public static final int DELIMITER = ',';
998   public static final String HBASE_CONFIG_READ_ZOOKEEPER_CONFIG =
999       "hbase.config.read.zookeeper.config";
1000   public static final boolean DEFAULT_HBASE_CONFIG_READ_ZOOKEEPER_CONFIG =
1001       false;
1002 
1003   /**
1004    * QOS attributes: these attributes are used to demarcate RPC call processing
1005    * by different set of handlers. For example, HIGH_QOS tagged methods are
1006    * handled by high priority handlers.
1007    */
1008   // normal_QOS < QOS_threshold < replication_QOS < replay_QOS < admin_QOS < high_QOS
1009   public static final int NORMAL_QOS = 0;
1010   public static final int QOS_THRESHOLD = 10;
1011   public static final int HIGH_QOS = 200;
1012   public static final int REPLICATION_QOS = 5;
1013   public static final int REPLAY_QOS = 6;
1014   public static final int ADMIN_QOS = 100;
1015   public static final int SYSTEMTABLE_QOS = HIGH_QOS;
1016 
1017   /** Directory under /hbase where archived hfiles are stored */
1018   public static final String HFILE_ARCHIVE_DIRECTORY = "archive";
1019 
1020   /**
1021    * Name of the directory to store all snapshots. See SnapshotDescriptionUtils for
1022    * remaining snapshot constants; this is here to keep HConstants dependencies at a minimum and
1023    * uni-directional.
1024    */
1025   public static final String SNAPSHOT_DIR_NAME = ".hbase-snapshot";
1026 
1027   /* Name of old snapshot directory. See HBASE-8352 for details on why it needs to be renamed */
1028   public static final String OLD_SNAPSHOT_DIR_NAME = ".snapshot";
1029 
1030   /** Temporary directory used for table creation and deletion */
1031   public static final String HBASE_TEMP_DIRECTORY = ".tmp";
1032   /**
1033    * The period (in milliseconds) between computing region server point in time metrics
1034    */
1035   public static final String REGIONSERVER_METRICS_PERIOD = "hbase.regionserver.metrics.period";
1036   public static final long DEFAULT_REGIONSERVER_METRICS_PERIOD = 5000;
1037   /** Directories that are not HBase table directories */
1038   public static final List<String> HBASE_NON_TABLE_DIRS =
1039     Collections.unmodifiableList(Arrays.asList(new String[] {
1040       HBCK_SIDELINEDIR_NAME, HBASE_TEMP_DIRECTORY, MIGRATION_NAME
1041     }));
1042 
1043   /** Directories that are not HBase user table directories */
1044   public static final List<String> HBASE_NON_USER_TABLE_DIRS =
1045     Collections.unmodifiableList(Arrays.asList((String[])ArrayUtils.addAll(
1046       new String[] { TableName.META_TABLE_NAME.getNameAsString() },
1047       HBASE_NON_TABLE_DIRS.toArray())));
1048 
1049   /** Health script related settings. */
1050   public static final String HEALTH_SCRIPT_LOC = "hbase.node.health.script.location";
1051   public static final String HEALTH_SCRIPT_TIMEOUT = "hbase.node.health.script.timeout";
1052   public static final String HEALTH_CHORE_WAKE_FREQ =
1053       "hbase.node.health.script.frequency";
1054   public static final long DEFAULT_HEALTH_SCRIPT_TIMEOUT = 60000;
1055   /**
1056    * The maximum number of health check failures a server can encounter consecutively.
1057    */
1058   public static final String HEALTH_FAILURE_THRESHOLD =
1059       "hbase.node.health.failure.threshold";
1060   public static final int DEFAULT_HEALTH_FAILURE_THRESHOLD = 3;
1061 
1062 
1063   /**
1064    * Setting to activate, or not, the publication of the status by the master. Default
1065    *  notification is by a multicast message.
1066    */
1067   public static final String STATUS_PUBLISHED = "hbase.status.published";
1068   public static final boolean STATUS_PUBLISHED_DEFAULT = false;
1069 
1070   /**
1071    * IP to use for the multicast status messages between the master and the clients.
1072    * The default address is chosen as one among others within the ones suitable for multicast
1073    * messages.
1074    */
1075   public static final String STATUS_MULTICAST_ADDRESS = "hbase.status.multicast.address.ip";
1076   public static final String DEFAULT_STATUS_MULTICAST_ADDRESS = "226.1.1.3";
1077 
1078   /**
1079    * The address to use for binding the local socket for receiving multicast. Defaults to
1080    * 0.0.0.0.
1081    * @see <a href="https://issues.apache.org/jira/browse/HBASE-9961">HBASE-9961</a>
1082    */
1083   public static final String STATUS_MULTICAST_BIND_ADDRESS = "hbase.status.multicast.bind.address.ip";
1084   public static final String DEFAULT_STATUS_MULTICAST_BIND_ADDRESS = "0.0.0.0";
1085 
1086   /**
1087    * The port to use for the multicast messages.
1088    */
1089   public static final String STATUS_MULTICAST_PORT = "hbase.status.multicast.address.port";
1090   public static final int DEFAULT_STATUS_MULTICAST_PORT = 16100;
1091 
1092   public static final long NO_NONCE = 0;
1093 
1094   /** Default cipher for encryption */
1095   public static final String CIPHER_AES = "AES";
1096 
1097   /** Configuration key for the crypto algorithm provider, a class name */
1098   public static final String CRYPTO_CIPHERPROVIDER_CONF_KEY = "hbase.crypto.cipherprovider";
1099 
1100   /** Configuration key for the crypto key provider, a class name */
1101   public static final String CRYPTO_KEYPROVIDER_CONF_KEY = "hbase.crypto.keyprovider";
1102 
1103   /** Configuration key for the crypto key provider parameters */
1104   public static final String CRYPTO_KEYPROVIDER_PARAMETERS_KEY =
1105       "hbase.crypto.keyprovider.parameters";
1106 
1107   /** Configuration key for the name of the master key for the cluster, a string */
1108   public static final String CRYPTO_MASTERKEY_NAME_CONF_KEY = "hbase.crypto.master.key.name";
1109 
1110   /** Configuration key for the name of the alternate master key for the cluster, a string */
1111   public static final String CRYPTO_MASTERKEY_ALTERNATE_NAME_CONF_KEY =
1112     "hbase.crypto.master.alternate.key.name";
1113 
1114   /** Configuration key for the algorithm to use when encrypting the WAL, a string */
1115   public static final String CRYPTO_WAL_ALGORITHM_CONF_KEY = "hbase.crypto.wal.algorithm";
1116 
1117   /** Configuration key for the name of the master WAL encryption key for the cluster, a string */
1118   public static final String CRYPTO_WAL_KEY_NAME_CONF_KEY = "hbase.crypto.wal.key.name";
1119 
1120   /** Configuration key for the algorithm used for creating jks key, a string */
1121   public static final String CRYPTO_KEY_ALGORITHM_CONF_KEY = "hbase.crypto.key.algorithm";
1122 
1123   /** Configuration key for the name of the alternate cipher algorithm for the cluster, a string */
1124   public static final String CRYPTO_ALTERNATE_KEY_ALGORITHM_CONF_KEY =
1125       "hbase.crypto.alternate.key.algorithm";
1126 
1127   /** Configuration key for enabling WAL encryption, a boolean */
1128   public static final String ENABLE_WAL_ENCRYPTION = "hbase.regionserver.wal.encryption";
1129 
1130   /** Configuration key for setting RPC codec class name */
1131   public static final String RPC_CODEC_CONF_KEY = "hbase.client.rpc.codec";
1132 
1133   /** Configuration key for setting replication codec class name */
1134   public static final String REPLICATION_CODEC_CONF_KEY = "hbase.replication.rpc.codec";
1135 
1136   /** Config for pluggable consensus provider */
1137   public static final String HBASE_COORDINATED_STATE_MANAGER_CLASS =
1138     "hbase.coordinated.state.manager.class";
1139 
1140   /** Configuration key for SplitLog manager timeout */
1141   public static final String HBASE_SPLITLOG_MANAGER_TIMEOUT = "hbase.splitlog.manager.timeout";
1142 
1143   /**
1144    * Configuration keys for Bucket cache
1145    */
1146   // TODO moving these bucket cache implementation specific configs to this level is violation of
1147   // encapsulation. But as these has to be referred from hbase-common and bucket cache
1148   // sits in hbase-server, there were no other go! Can we move the cache implementation to
1149   // hbase-common?
1150 
1151   /**
1152    * Current ioengine options in include: heap, offheap and file:PATH (where PATH is the path
1153    * to the file that will host the file-based cache.  See BucketCache#getIOEngineFromName() for
1154    * list of supported ioengine options.
1155    * <p>Set this option and a non-zero {@link #BUCKET_CACHE_SIZE_KEY} to enable bucket cache.
1156    */
1157   public static final String BUCKET_CACHE_IOENGINE_KEY = "hbase.bucketcache.ioengine";
1158 
1159   /**
1160    * When using bucket cache, this is a float that EITHER represents a percentage of total heap
1161    * memory size to give to the cache (if < 1.0) OR, it is the capacity in megabytes of the cache.
1162    */
1163   public static final String BUCKET_CACHE_SIZE_KEY = "hbase.bucketcache.size";
1164 
1165   /**
1166    * HConstants for fast fail on the client side follow
1167    */
1168   /**
1169    * Config for enabling/disabling the fast fail mode.
1170    */
1171   public static final String HBASE_CLIENT_FAST_FAIL_MODE_ENABLED =
1172       "hbase.client.fast.fail.mode.enabled";
1173 
1174   public static final boolean HBASE_CLIENT_ENABLE_FAST_FAIL_MODE_DEFAULT =
1175       false;
1176 
1177   public static final String HBASE_CLIENT_FAST_FAIL_THREASHOLD_MS =
1178       "hbase.client.fastfail.threshold";
1179 
1180   public static final long HBASE_CLIENT_FAST_FAIL_THREASHOLD_MS_DEFAULT =
1181       60000;
1182 
1183   public static final String HBASE_CLIENT_FAST_FAIL_CLEANUP_MS_DURATION_MS =
1184       "hbase.client.fast.fail.cleanup.duration";
1185 
1186   public static final long HBASE_CLIENT_FAST_FAIL_CLEANUP_DURATION_MS_DEFAULT =
1187       600000;
1188 
1189   public static final String HBASE_CLIENT_FAST_FAIL_INTERCEPTOR_IMPL =
1190       "hbase.client.fast.fail.interceptor.impl";
1191 
1192   /** Config key for if the server should send backpressure and if the client should listen to
1193    * that backpressure from the server */
1194   public static final String ENABLE_CLIENT_BACKPRESSURE = "hbase.client.backpressure.enabled";
1195   public static final boolean DEFAULT_ENABLE_CLIENT_BACKPRESSURE = false;
1196 
1197   public static final String HEAP_OCCUPANCY_LOW_WATERMARK_KEY =
1198       "hbase.heap.occupancy.low_water_mark";
1199   public static final float DEFAULT_HEAP_OCCUPANCY_LOW_WATERMARK = 0.95f;
1200   public static final String HEAP_OCCUPANCY_HIGH_WATERMARK_KEY =
1201       "hbase.heap.occupancy.high_water_mark";
1202   public static final float DEFAULT_HEAP_OCCUPANCY_HIGH_WATERMARK = 0.98f;
1203 
1204   /**
1205    * The max number of threads used for splitting storefiles in parallel during
1206    * the region split process.
1207    */
1208   public static final String REGION_SPLIT_THREADS_MAX =
1209     "hbase.regionserver.region.split.threads.max";
1210 
1211   /**
1212    * Backup/Restore constants
1213    */
1214   public final static String BACKUP_ENABLE_KEY = "hbase.backup.enable";
1215   public final static boolean BACKUP_ENABLE_DEFAULT = true;
1216   public final static String BACKUP_SYSTEM_TTL_KEY = "hbase.backup.system.ttl";
1217   public final static int BACKUP_SYSTEM_TTL_DEFAULT = FOREVER;
1218 
1219   private HConstants() {
1220     // Can't be instantiated with this ctor.
1221   }
1222 }