| <!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: VersionInfoUtil, interface: ServiceCallFunction"> |
| <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 org.apache.hadoop.hbase.ipc.RpcCallContext;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.ipc.RpcServer;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">023</span><span id="line-23"></span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">/**</span> |
| <span class="source-line-no">028</span><span id="line-28"> * Class to help with parsing the version info.</span> |
| <span class="source-line-no">029</span><span id="line-29"> */</span> |
| <span class="source-line-no">030</span><span id="line-30">@InterfaceAudience.Private</span> |
| <span class="source-line-no">031</span><span id="line-31">public final class VersionInfoUtil {</span> |
| <span class="source-line-no">032</span><span id="line-32"> private static final ThreadLocal<HBaseProtos.VersionInfo> NonCallVersion = new ThreadLocal<>();</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34"> private VersionInfoUtil() {</span> |
| <span class="source-line-no">035</span><span id="line-35"> /* UTIL CLASS ONLY */</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"> public static boolean currentClientHasMinimumVersion(int major, int minor) {</span> |
| <span class="source-line-no">039</span><span id="line-39"> return hasMinimumVersion(getCurrentClientVersionInfo(), major, minor);</span> |
| <span class="source-line-no">040</span><span id="line-40"> }</span> |
| <span class="source-line-no">041</span><span id="line-41"></span> |
| <span class="source-line-no">042</span><span id="line-42"> public static boolean hasMinimumVersion(HBaseProtos.VersionInfo versionInfo, int major,</span> |
| <span class="source-line-no">043</span><span id="line-43"> int minor) {</span> |
| <span class="source-line-no">044</span><span id="line-44"> if (versionInfo != null) {</span> |
| <span class="source-line-no">045</span><span id="line-45"> if (versionInfo.hasVersionMajor() && versionInfo.hasVersionMinor()) {</span> |
| <span class="source-line-no">046</span><span id="line-46"> int clientMajor = versionInfo.getVersionMajor();</span> |
| <span class="source-line-no">047</span><span id="line-47"> if (clientMajor != major) {</span> |
| <span class="source-line-no">048</span><span id="line-48"> return clientMajor > major;</span> |
| <span class="source-line-no">049</span><span id="line-49"> }</span> |
| <span class="source-line-no">050</span><span id="line-50"> int clientMinor = versionInfo.getVersionMinor();</span> |
| <span class="source-line-no">051</span><span id="line-51"> return clientMinor >= minor;</span> |
| <span class="source-line-no">052</span><span id="line-52"> }</span> |
| <span class="source-line-no">053</span><span id="line-53"> try {</span> |
| <span class="source-line-no">054</span><span id="line-54"> final String[] components = getVersionComponents(versionInfo);</span> |
| <span class="source-line-no">055</span><span id="line-55"></span> |
| <span class="source-line-no">056</span><span id="line-56"> int clientMajor = components.length > 0 ? Integer.parseInt(components[0]) : 0;</span> |
| <span class="source-line-no">057</span><span id="line-57"> if (clientMajor != major) {</span> |
| <span class="source-line-no">058</span><span id="line-58"> return clientMajor > major;</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"> int clientMinor = components.length > 1 ? Integer.parseInt(components[1]) : 0;</span> |
| <span class="source-line-no">062</span><span id="line-62"> return clientMinor >= minor;</span> |
| <span class="source-line-no">063</span><span id="line-63"> } catch (NumberFormatException e) {</span> |
| <span class="source-line-no">064</span><span id="line-64"> return false;</span> |
| <span class="source-line-no">065</span><span id="line-65"> }</span> |
| <span class="source-line-no">066</span><span id="line-66"> }</span> |
| <span class="source-line-no">067</span><span id="line-67"> return false;</span> |
| <span class="source-line-no">068</span><span id="line-68"> }</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"> * We intend to use the local version for service call shortcut(s), so we use an interface</span> |
| <span class="source-line-no">072</span><span id="line-72"> * compatible with a typical service call, with 2 args, return type, and an exception type.</span> |
| <span class="source-line-no">073</span><span id="line-73"> */</span> |
| <span class="source-line-no">074</span><span id="line-74"> public interface ServiceCallFunction<T1, T2, R, E extends Throwable> {</span> |
| <span class="source-line-no">075</span><span id="line-75"> R apply(T1 t1, T2 t2) throws E;</span> |
| <span class="source-line-no">076</span><span id="line-76"> }</span> |
| <span class="source-line-no">077</span><span id="line-77"></span> |
| <span class="source-line-no">078</span><span id="line-78"> public static <T1, T2, R, E extends Throwable> R</span> |
| <span class="source-line-no">079</span><span id="line-79"> callWithVersion(ServiceCallFunction<T1, T2, R, E> f, T1 t1, T2 t2) throws E {</span> |
| <span class="source-line-no">080</span><span id="line-80"> // Note: just as RpcServer.CurCall, this will only apply on the current thread.</span> |
| <span class="source-line-no">081</span><span id="line-81"> NonCallVersion.set(ProtobufUtil.getVersionInfo());</span> |
| <span class="source-line-no">082</span><span id="line-82"> try {</span> |
| <span class="source-line-no">083</span><span id="line-83"> return f.apply(t1, t2);</span> |
| <span class="source-line-no">084</span><span id="line-84"> } finally {</span> |
| <span class="source-line-no">085</span><span id="line-85"> NonCallVersion.remove();</span> |
| <span class="source-line-no">086</span><span id="line-86"> }</span> |
| <span class="source-line-no">087</span><span id="line-87"> }</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> /** Returns the versionInfo extracted from the current RpcCallContext */</span> |
| <span class="source-line-no">090</span><span id="line-90"> public static HBaseProtos.VersionInfo getCurrentClientVersionInfo() {</span> |
| <span class="source-line-no">091</span><span id="line-91"> return RpcServer.getCurrentCall().map(RpcCallContext::getClientVersionInfo)</span> |
| <span class="source-line-no">092</span><span id="line-92"> .orElse(NonCallVersion.get());</span> |
| <span class="source-line-no">093</span><span id="line-93"> }</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> /**</span> |
| <span class="source-line-no">096</span><span id="line-96"> * Returns the passed-in <code>version</code> int as a version String (e.g. 0x0103004 is 1.3.4)</span> |
| <span class="source-line-no">097</span><span id="line-97"> */</span> |
| <span class="source-line-no">098</span><span id="line-98"> public static String versionNumberToString(final int version) {</span> |
| <span class="source-line-no">099</span><span id="line-99"> return String.format("%d.%d.%d", ((version >> 20) & 0xff), ((version >> 12) & 0xff),</span> |
| <span class="source-line-no">100</span><span id="line-100"> (version & 0xfff));</span> |
| <span class="source-line-no">101</span><span id="line-101"> }</span> |
| <span class="source-line-no">102</span><span id="line-102"></span> |
| <span class="source-line-no">103</span><span id="line-103"> /**</span> |
| <span class="source-line-no">104</span><span id="line-104"> * Pack the full number version in a int. by shifting each component by 8bit, except the dot</span> |
| <span class="source-line-no">105</span><span id="line-105"> * release which has 12bit. Examples: (1.3.4 is 0x0103004, 2.1.0 is 0x0201000)</span> |
| <span class="source-line-no">106</span><span id="line-106"> * @param versionInfo the VersionInfo object to pack</span> |
| <span class="source-line-no">107</span><span id="line-107"> * @return the version number as int. (e.g. 0x0103004 is 1.3.4)</span> |
| <span class="source-line-no">108</span><span id="line-108"> */</span> |
| <span class="source-line-no">109</span><span id="line-109"> public static int getVersionNumber(final HBaseProtos.VersionInfo versionInfo) {</span> |
| <span class="source-line-no">110</span><span id="line-110"> if (versionInfo != null) {</span> |
| <span class="source-line-no">111</span><span id="line-111"> try {</span> |
| <span class="source-line-no">112</span><span id="line-112"> final String[] components = getVersionComponents(versionInfo);</span> |
| <span class="source-line-no">113</span><span id="line-113"> int clientMajor = components.length > 0 ? Integer.parseInt(components[0]) : 0;</span> |
| <span class="source-line-no">114</span><span id="line-114"> int clientMinor = components.length > 1 ? Integer.parseInt(components[1]) : 0;</span> |
| <span class="source-line-no">115</span><span id="line-115"> int clientPatch = components.length > 2 ? Integer.parseInt(components[2]) : 0;</span> |
| <span class="source-line-no">116</span><span id="line-116"> return buildVersionNumber(clientMajor, clientMinor, clientPatch);</span> |
| <span class="source-line-no">117</span><span id="line-117"> } catch (NumberFormatException e) {</span> |
| <span class="source-line-no">118</span><span id="line-118"> int clientMajor = versionInfo.hasVersionMajor() ? versionInfo.getVersionMajor() : 0;</span> |
| <span class="source-line-no">119</span><span id="line-119"> int clientMinor = versionInfo.hasVersionMinor() ? versionInfo.getVersionMinor() : 0;</span> |
| <span class="source-line-no">120</span><span id="line-120"> return buildVersionNumber(clientMajor, clientMinor, 0);</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> |
| <span class="source-line-no">123</span><span id="line-123"> return (0); // no version</span> |
| <span class="source-line-no">124</span><span id="line-124"> }</span> |
| <span class="source-line-no">125</span><span id="line-125"></span> |
| <span class="source-line-no">126</span><span id="line-126"> /**</span> |
| <span class="source-line-no">127</span><span id="line-127"> * Pack the full number version in a int. by shifting each component by 8bit, except the dot</span> |
| <span class="source-line-no">128</span><span id="line-128"> * release which has 12bit. Examples: (1.3.4 is 0x0103004, 2.1.0 is 0x0201000)</span> |
| <span class="source-line-no">129</span><span id="line-129"> * @param major version major number</span> |
| <span class="source-line-no">130</span><span id="line-130"> * @param minor version minor number</span> |
| <span class="source-line-no">131</span><span id="line-131"> * @param patch version patch number</span> |
| <span class="source-line-no">132</span><span id="line-132"> * @return the version number as int. (e.g. 0x0103004 is 1.3.4)</span> |
| <span class="source-line-no">133</span><span id="line-133"> */</span> |
| <span class="source-line-no">134</span><span id="line-134"> private static int buildVersionNumber(int major, int minor, int patch) {</span> |
| <span class="source-line-no">135</span><span id="line-135"> return (major << 20) | (minor << 12) | patch;</span> |
| <span class="source-line-no">136</span><span id="line-136"> }</span> |
| <span class="source-line-no">137</span><span id="line-137"></span> |
| <span class="source-line-no">138</span><span id="line-138"> /**</span> |
| <span class="source-line-no">139</span><span id="line-139"> * Returns the version components Examples: "1.4.3" returns [1, 4, 3], "4.5.6-SNAPSHOT" returns</span> |
| <span class="source-line-no">140</span><span id="line-140"> * [4, 5, 6, "SNAPSHOT"]</span> |
| <span class="source-line-no">141</span><span id="line-141"> * @return the components of the version string</span> |
| <span class="source-line-no">142</span><span id="line-142"> */</span> |
| <span class="source-line-no">143</span><span id="line-143"> private static String[] getVersionComponents(final HBaseProtos.VersionInfo versionInfo) {</span> |
| <span class="source-line-no">144</span><span id="line-144"> return versionInfo.getVersion().split("[\\.-]");</span> |
| <span class="source-line-no">145</span><span id="line-145"> }</span> |
| <span class="source-line-no">146</span><span id="line-146">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
