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