| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.client, class: RegionInfoDisplay"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.client;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.master.RegionState;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * Utility used composing RegionInfo for 'display'; e.g. on the web UI</span> |
| <span class="source-line-no">030</span><span id="line-30"> */</span> |
| <span class="source-line-no">031</span><span id="line-31">@InterfaceAudience.Private</span> |
| <span class="source-line-no">032</span><span id="line-32">public class RegionInfoDisplay {</span> |
| <span class="source-line-no">033</span><span id="line-33"> public final static String DISPLAY_KEYS_KEY = "hbase.display.keys";</span> |
| <span class="source-line-no">034</span><span id="line-34"> public final static byte[] HIDDEN_END_KEY = Bytes.toBytes("hidden-end-key");</span> |
| <span class="source-line-no">035</span><span id="line-35"> public final static byte[] HIDDEN_START_KEY = Bytes.toBytes("hidden-start-key");</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37"> /**</span> |
| <span class="source-line-no">038</span><span id="line-38"> * Get the descriptive name as {@link RegionState} does it but with hidden startkey optionally</span> |
| <span class="source-line-no">039</span><span id="line-39"> * @return descriptive string</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41"> public static String getDescriptiveNameFromRegionStateForDisplay(RegionState state,</span> |
| <span class="source-line-no">042</span><span id="line-42"> Configuration conf) {</span> |
| <span class="source-line-no">043</span><span id="line-43"> if (conf.getBoolean(DISPLAY_KEYS_KEY, true)) return state.toDescriptiveString();</span> |
| <span class="source-line-no">044</span><span id="line-44"> String descriptiveStringFromState = state.toDescriptiveString();</span> |
| <span class="source-line-no">045</span><span id="line-45"> int idx = descriptiveStringFromState.lastIndexOf(" state=");</span> |
| <span class="source-line-no">046</span><span id="line-46"> String regionName = getRegionNameAsStringForDisplay(</span> |
| <span class="source-line-no">047</span><span id="line-47"> RegionInfoBuilder.newBuilder(state.getRegion()).build(), conf);</span> |
| <span class="source-line-no">048</span><span id="line-48"> return regionName + descriptiveStringFromState.substring(idx);</span> |
| <span class="source-line-no">049</span><span id="line-49"> }</span> |
| <span class="source-line-no">050</span><span id="line-50"></span> |
| <span class="source-line-no">051</span><span id="line-51"> /**</span> |
| <span class="source-line-no">052</span><span id="line-52"> * Get the end key for display. Optionally hide the real end key.</span> |
| <span class="source-line-no">053</span><span id="line-53"> * @return the endkey</span> |
| <span class="source-line-no">054</span><span id="line-54"> */</span> |
| <span class="source-line-no">055</span><span id="line-55"> public static byte[] getEndKeyForDisplay(RegionInfo ri, Configuration conf) {</span> |
| <span class="source-line-no">056</span><span id="line-56"> boolean displayKey = conf.getBoolean(DISPLAY_KEYS_KEY, true);</span> |
| <span class="source-line-no">057</span><span id="line-57"> if (displayKey) return ri.getEndKey();</span> |
| <span class="source-line-no">058</span><span id="line-58"> return HIDDEN_END_KEY;</span> |
| <span class="source-line-no">059</span><span id="line-59"> }</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> /**</span> |
| <span class="source-line-no">062</span><span id="line-62"> * Get the start key for display. Optionally hide the real start key.</span> |
| <span class="source-line-no">063</span><span id="line-63"> * @return the startkey</span> |
| <span class="source-line-no">064</span><span id="line-64"> */</span> |
| <span class="source-line-no">065</span><span id="line-65"> public static byte[] getStartKeyForDisplay(RegionInfo ri, Configuration conf) {</span> |
| <span class="source-line-no">066</span><span id="line-66"> boolean displayKey = conf.getBoolean(DISPLAY_KEYS_KEY, true);</span> |
| <span class="source-line-no">067</span><span id="line-67"> if (displayKey) return ri.getStartKey();</span> |
| <span class="source-line-no">068</span><span id="line-68"> return HIDDEN_START_KEY;</span> |
| <span class="source-line-no">069</span><span id="line-69"> }</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> /**</span> |
| <span class="source-line-no">072</span><span id="line-72"> * Get the region name for display. Optionally hide the start key.</span> |
| <span class="source-line-no">073</span><span id="line-73"> * @return region name as String</span> |
| <span class="source-line-no">074</span><span id="line-74"> */</span> |
| <span class="source-line-no">075</span><span id="line-75"> public static String getRegionNameAsStringForDisplay(RegionInfo ri, Configuration conf) {</span> |
| <span class="source-line-no">076</span><span id="line-76"> return Bytes.toStringBinary(getRegionNameForDisplay(ri, conf));</span> |
| <span class="source-line-no">077</span><span id="line-77"> }</span> |
| <span class="source-line-no">078</span><span id="line-78"></span> |
| <span class="source-line-no">079</span><span id="line-79"> /**</span> |
| <span class="source-line-no">080</span><span id="line-80"> * Get the region name for display. Optionally hide the start key.</span> |
| <span class="source-line-no">081</span><span id="line-81"> * @return region name bytes</span> |
| <span class="source-line-no">082</span><span id="line-82"> */</span> |
| <span class="source-line-no">083</span><span id="line-83"> public static byte[] getRegionNameForDisplay(RegionInfo ri, Configuration conf) {</span> |
| <span class="source-line-no">084</span><span id="line-84"> boolean displayKey = conf.getBoolean(DISPLAY_KEYS_KEY, true);</span> |
| <span class="source-line-no">085</span><span id="line-85"> if (displayKey || ri.getTable().equals(TableName.META_TABLE_NAME)) {</span> |
| <span class="source-line-no">086</span><span id="line-86"> return ri.getRegionName();</span> |
| <span class="source-line-no">087</span><span id="line-87"> } else {</span> |
| <span class="source-line-no">088</span><span id="line-88"> // create a modified regionname with the startkey replaced but preserving</span> |
| <span class="source-line-no">089</span><span id="line-89"> // the other parts including the encodedname.</span> |
| <span class="source-line-no">090</span><span id="line-90"> try {</span> |
| <span class="source-line-no">091</span><span id="line-91"> byte[][] regionNameParts = RegionInfo.parseRegionName(ri.getRegionName());</span> |
| <span class="source-line-no">092</span><span id="line-92"> regionNameParts[1] = HIDDEN_START_KEY; // replace the real startkey</span> |
| <span class="source-line-no">093</span><span id="line-93"> int len = 0;</span> |
| <span class="source-line-no">094</span><span id="line-94"> // get the total length</span> |
| <span class="source-line-no">095</span><span id="line-95"> for (byte[] b : regionNameParts) {</span> |
| <span class="source-line-no">096</span><span id="line-96"> len += b.length;</span> |
| <span class="source-line-no">097</span><span id="line-97"> }</span> |
| <span class="source-line-no">098</span><span id="line-98"> byte[] encodedRegionName = Bytes.toBytes(RegionInfo.encodeRegionName(ri.getRegionName()));</span> |
| <span class="source-line-no">099</span><span id="line-99"> len += encodedRegionName.length;</span> |
| <span class="source-line-no">100</span><span id="line-100"> // allocate some extra bytes for the delimiters and the last '.'</span> |
| <span class="source-line-no">101</span><span id="line-101"> byte[] modifiedName = new byte[len + regionNameParts.length + 1];</span> |
| <span class="source-line-no">102</span><span id="line-102"> int lengthSoFar = 0;</span> |
| <span class="source-line-no">103</span><span id="line-103"> int loopCount = 0;</span> |
| <span class="source-line-no">104</span><span id="line-104"> for (byte[] b : regionNameParts) {</span> |
| <span class="source-line-no">105</span><span id="line-105"> System.arraycopy(b, 0, modifiedName, lengthSoFar, b.length);</span> |
| <span class="source-line-no">106</span><span id="line-106"> lengthSoFar += b.length;</span> |
| <span class="source-line-no">107</span><span id="line-107"> if (loopCount++ == 2) modifiedName[lengthSoFar++] = RegionInfo.REPLICA_ID_DELIMITER;</span> |
| <span class="source-line-no">108</span><span id="line-108"> else modifiedName[lengthSoFar++] = HConstants.DELIMITER;</span> |
| <span class="source-line-no">109</span><span id="line-109"> }</span> |
| <span class="source-line-no">110</span><span id="line-110"> // replace the last comma with '.'</span> |
| <span class="source-line-no">111</span><span id="line-111"> modifiedName[lengthSoFar - 1] = RegionInfo.ENC_SEPARATOR;</span> |
| <span class="source-line-no">112</span><span id="line-112"> System.arraycopy(encodedRegionName, 0, modifiedName, lengthSoFar, encodedRegionName.length);</span> |
| <span class="source-line-no">113</span><span id="line-113"> lengthSoFar += encodedRegionName.length;</span> |
| <span class="source-line-no">114</span><span id="line-114"> modifiedName[lengthSoFar] = RegionInfo.ENC_SEPARATOR;</span> |
| <span class="source-line-no">115</span><span id="line-115"> return modifiedName;</span> |
| <span class="source-line-no">116</span><span id="line-116"> } catch (IOException e) {</span> |
| <span class="source-line-no">117</span><span id="line-117"> // LOG.warn("Encountered exception " + e);</span> |
| <span class="source-line-no">118</span><span id="line-118"> throw new RuntimeException(e);</span> |
| <span class="source-line-no">119</span><span id="line-119"> }</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</span> |
| <span class="source-line-no">121</span><span id="line-121"> }</span> |
| <span class="source-line-no">122</span><span id="line-122">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
