Update the license for 2017-2018 license
[aai/aai-common.git] / aai-core / src / main / java / org / onap / aai / util / HbaseSaltPrefixer.java
1 /**
2  * ============LICENSE_START=======================================================
3  * org.onap.aai
4  * ================================================================================
5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
6  * ================================================================================
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *    http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ============LICENSE_END=========================================================
19  */
20 package org.onap.aai.util;
21
22 /*
23  * logging to hbase encountered hotspotting issues, so per
24  * http://archive.cloudera.com/cdh5/cdh/5/hbase-0.98.6-cdh5.3.8/book/rowkey.design.html
25  * we decided to salt the rowkeys
26  * as these keys are generated in a couple places, I made a class to contain that logic
27  */
28 public class HbaseSaltPrefixer {
29         private int NUM_REGION_BUCKETS = 3; //the number of hbase region servers per cluster
30
31         private static class SingletonHolder{
32                 private static final HbaseSaltPrefixer INSTANCE = new HbaseSaltPrefixer();
33         }
34         
35         /**
36          * Instantiates a new hbase salt prefixer.
37          */
38         private HbaseSaltPrefixer(){}
39         
40         /**
41          * Gets the single instance of HbaseSaltPrefixer.
42          *
43          * @return single instance of HbaseSaltPrefixer
44          */
45         public static HbaseSaltPrefixer getInstance() {
46                 return SingletonHolder.INSTANCE;
47         }
48         
49         /**
50          * Prepend salt.
51          *
52          * @param key the key
53          * @return the string
54          */
55         public String prependSalt(String key) {
56                 int salt = Math.abs(key.hashCode()) % NUM_REGION_BUCKETS;
57                 return salt + "-" + key;
58         }
59 }