Google Git
Sign in
apache / hbase-site / de9138236f2347a21ef79c7909d33db0d2138098 / . / devapidocs / src-html / org / apache / hadoop / hbase / util / VersionInfo.html
blob: c06b58a5613640f88ea457963b6dbf028341357d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.util;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.PrintStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.PrintWriter;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.commons.lang3.StringUtils;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.Version;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.slf4j.Logger;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.slf4j.LoggerFactory;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hbase.thirdparty.com.google.common.base.Splitter;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hbase.thirdparty.com.google.common.collect.Iterables;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>/**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * This class finds the Version information for HBase.<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>@InterfaceAudience.Public<a name="line.35"></a>
<span class="sourceLineNo">036</span>public class VersionInfo {<a name="line.36"></a>
<span class="sourceLineNo">037</span> private static final Logger LOG = LoggerFactory.getLogger(VersionInfo.class.getName());<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> // If between two dots there is not a number, we regard it as a very large number so it is<a name="line.39"></a>
<span class="sourceLineNo">040</span> // higher than any numbers in the version.<a name="line.40"></a>
<span class="sourceLineNo">041</span> private static final int VERY_LARGE_NUMBER = 100000;<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * Get the hbase version.<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @return the hbase version string, eg. "0.6.3-dev"<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> public static String getVersion() {<a name="line.47"></a>
<span class="sourceLineNo">048</span> return Version.version;<a name="line.48"></a>
<span class="sourceLineNo">049</span> }<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Get the subversion revision number for the root directory<a name="line.52"></a>
<span class="sourceLineNo">053</span> * @return the revision number, eg. "451451"<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> public static String getRevision() {<a name="line.55"></a>
<span class="sourceLineNo">056</span> return Version.revision;<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
<span class="sourceLineNo">060</span> * The date that hbase was compiled.<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @return the compilation date in unix date format<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> public static String getDate() {<a name="line.63"></a>
<span class="sourceLineNo">064</span> return Version.date;<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * The user that compiled hbase.<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @return the username of the user<a name="line.69"></a>
<span class="sourceLineNo">070</span> */<a name="line.70"></a>
<span class="sourceLineNo">071</span> public static String getUser() {<a name="line.71"></a>
<span class="sourceLineNo">072</span> return Version.user;<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
<span class="sourceLineNo">076</span> * Get the subversion URL for the root hbase directory.<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @return the url<a name="line.77"></a>
<span class="sourceLineNo">078</span> */<a name="line.78"></a>
<span class="sourceLineNo">079</span> public static String getUrl() {<a name="line.79"></a>
<span class="sourceLineNo">080</span> return Version.url;<a name="line.80"></a>
<span class="sourceLineNo">081</span> }<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> static String[] versionReport() {<a name="line.83"></a>
<span class="sourceLineNo">084</span> return new String[] { "HBase " + getVersion(),<a name="line.84"></a>
<span class="sourceLineNo">085</span> "Source code repository " + getUrl() + " revision=" + getRevision(),<a name="line.85"></a>
<span class="sourceLineNo">086</span> "Compiled by " + getUser() + " on " + getDate(),<a name="line.86"></a>
<span class="sourceLineNo">087</span> "From source with checksum " + getSrcChecksum() };<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> /**<a name="line.90"></a>
<span class="sourceLineNo">091</span> * Get the checksum of the source files from which Hadoop was compiled.<a name="line.91"></a>
<span class="sourceLineNo">092</span> * @return a string that uniquely identifies the source<a name="line.92"></a>
<span class="sourceLineNo">093</span> **/<a name="line.93"></a>
<span class="sourceLineNo">094</span> public static String getSrcChecksum() {<a name="line.94"></a>
<span class="sourceLineNo">095</span> return Version.srcChecksum;<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> public static void writeTo(PrintWriter out) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> for (String line : versionReport()) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> out.println(line);<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> public static void writeTo(PrintStream out) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> for (String line : versionReport()) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> out.println(line);<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> public static void logVersion() {<a name="line.110"></a>
<span class="sourceLineNo">111</span> for (String line : versionReport()) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> LOG.info(line);<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> public static int compareVersion(String v1, String v2) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> // fast compare equals first<a name="line.117"></a>
<span class="sourceLineNo">118</span> if (v1.equals(v2)) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> return 0;<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span> String[] v1Comps = getVersionComponents(v1);<a name="line.121"></a>
<span class="sourceLineNo">122</span> String[] v2Comps = getVersionComponents(v2);<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> int length = Math.max(v1Comps.length, v2Comps.length);<a name="line.124"></a>
<span class="sourceLineNo">125</span> for (int i = 0; i &lt; length; i++) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> Integer va = i &lt; v1Comps.length ? Integer.parseInt(v1Comps[i]) : 0;<a name="line.126"></a>
<span class="sourceLineNo">127</span> Integer vb = i &lt; v2Comps.length ? Integer.parseInt(v2Comps[i]) : 0;<a name="line.127"></a>
<span class="sourceLineNo">128</span> int compare = va.compareTo(vb);<a name="line.128"></a>
<span class="sourceLineNo">129</span> if (compare != 0) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> return compare;<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span> return 0;<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> /**<a name="line.136"></a>
<span class="sourceLineNo">137</span> * Returns the version components as String objects Examples: "1.4.3" returns ["1", "4", "3"],<a name="line.137"></a>
<span class="sourceLineNo">138</span> * "4.5.6-SNAPSHOT" returns ["4", "5", "6", "-1"] "4.5.6-beta" returns ["4", "5", "6", "-2"],<a name="line.138"></a>
<span class="sourceLineNo">139</span> * "4.5.6-alpha" returns ["4", "5", "6", "-3"] "4.5.6-UNKNOW" returns ["4", "5", "6", "-4"]<a name="line.139"></a>
<span class="sourceLineNo">140</span> * @return the components of the version string<a name="line.140"></a>
<span class="sourceLineNo">141</span> */<a name="line.141"></a>
<span class="sourceLineNo">142</span> private static String[] getVersionComponents(final String version) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> assert (version != null);<a name="line.143"></a>
<span class="sourceLineNo">144</span> List&lt;String&gt; list = Splitter.onPattern("[\\.-]").splitToList(version);<a name="line.144"></a>
<span class="sourceLineNo">145</span> String[] strComps = list.toArray(new String[list.size()]);<a name="line.145"></a>
<span class="sourceLineNo">146</span> assert (strComps.length &gt; 0);<a name="line.146"></a>
<span class="sourceLineNo">147</span> String[] comps = new String[strComps.length];<a name="line.147"></a>
<span class="sourceLineNo">148</span> for (int i = 0; i &lt; strComps.length; ++i) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> if (StringUtils.isNumeric(strComps[i])) {<a name="line.149"></a>
<span class="sourceLineNo">150</span> comps[i] = strComps[i];<a name="line.150"></a>
<span class="sourceLineNo">151</span> } else if (StringUtils.isEmpty(strComps[i])) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> comps[i] = String.valueOf(VERY_LARGE_NUMBER);<a name="line.152"></a>
<span class="sourceLineNo">153</span> } else {<a name="line.153"></a>
<span class="sourceLineNo">154</span> if ("SNAPSHOT".equals(strComps[i])) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> comps[i] = "-1";<a name="line.155"></a>
<span class="sourceLineNo">156</span> } else if ("beta".equals(strComps[i])) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> comps[i] = "-2";<a name="line.157"></a>
<span class="sourceLineNo">158</span> } else if ("alpha".equals(strComps[i])) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> comps[i] = "-3";<a name="line.159"></a>
<span class="sourceLineNo">160</span> } else {<a name="line.160"></a>
<span class="sourceLineNo">161</span> comps[i] = "-4";<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span> return comps;<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> public static int getMajorVersion(String version) {<a name="line.168"></a>
<span class="sourceLineNo">169</span> return Integer.parseInt(Iterables.get(Splitter.on('.').split(version), 0));<a name="line.169"></a>
<span class="sourceLineNo">170</span> }<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span> public static void main(String[] args) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> writeTo(System.out);<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span>}<a name="line.175"></a>
</pre>
</div>
</body>
</html>