blob: 58e3325867460942d576be281d1b9fabe91c047c [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>VersionInfo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/trafodion/dcs/util/VersionInfo.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * Copyright 2011 The Apache Software Foundation</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <em class="jxr_javadoccomment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="20" href="#20">20</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">package</strong> org.trafodion.dcs.util;
<a class="jxr_linenumber" name="22" href="#22">22</a>
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.commons.logging.LogFactory;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.PrintWriter;
<a class="jxr_linenumber" name="25" href="#25">25</a>
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.trafodion.dcs.VersionAnnotation;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.trafodion.dcs.master.DcsMaster;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.commons.logging.Log;
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * This class finds the package info for dcs and the VersionAnnotation</em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * information. Taken from hadoop. Only name of annotation is different.</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/trafodion/dcs/util/VersionInfo.html">VersionInfo</a> {
<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Log LOG = LogFactory.getLog(VersionInfo.<strong class="jxr_keyword">class</strong>.getName());
<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> Package myPackage;
<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/trafodion/dcs/VersionAnnotation.html">VersionAnnotation</a> version;
<a class="jxr_linenumber" name="37" href="#37">37</a>
<a class="jxr_linenumber" name="38" href="#38">38</a> <strong class="jxr_keyword">static</strong> {
<a class="jxr_linenumber" name="39" href="#39">39</a> myPackage = VersionAnnotation.<strong class="jxr_keyword">class</strong>.getPackage();
<a class="jxr_linenumber" name="40" href="#40">40</a> version = myPackage.getAnnotation(VersionAnnotation.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="41" href="#41">41</a> }
<a class="jxr_linenumber" name="42" href="#42">42</a>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * Get the meta-data for the dcs package.</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @return package</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <strong class="jxr_keyword">static</strong> Package getPackage() {
<a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">return</strong> myPackage;
<a class="jxr_linenumber" name="49" href="#49">49</a> }
<a class="jxr_linenumber" name="50" href="#50">50</a>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Get the dcs version.</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @return the dcs version string, eg. "1.0.0-alpha"</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getVersion() {
<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">return</strong> version != <strong class="jxr_keyword">null</strong> ? version.version() : <span class="jxr_string">"Unknown"</span>;
<a class="jxr_linenumber" name="57" href="#57">57</a> }
<a class="jxr_linenumber" name="58" href="#58">58</a>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * Get the subversion revision number for the root directory</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @return the revision number, eg. "451451"</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getRevision() {
<a class="jxr_linenumber" name="64" href="#64">64</a> <strong class="jxr_keyword">return</strong> version != <strong class="jxr_keyword">null</strong> ? version.revision() : <span class="jxr_string">"Unknown"</span>;
<a class="jxr_linenumber" name="65" href="#65">65</a> }
<a class="jxr_linenumber" name="66" href="#66">66</a>
<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * The date that dcs was compiled.</em>
<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @return the compilation date in unix date format</em>
<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="71" href="#71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getDate() {
<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">return</strong> version != <strong class="jxr_keyword">null</strong> ? version.date() : <span class="jxr_string">"Unknown"</span>;
<a class="jxr_linenumber" name="73" href="#73">73</a> }
<a class="jxr_linenumber" name="74" href="#74">74</a>
<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * The user that compiled dcs.</em>
<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * @return the username of the user</em>
<a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getUser() {
<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">return</strong> version != <strong class="jxr_keyword">null</strong> ? version.user() : <span class="jxr_string">"Unknown"</span>;
<a class="jxr_linenumber" name="81" href="#81">81</a> }
<a class="jxr_linenumber" name="82" href="#82">82</a>
<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * Get the subversion URL for the root dcs directory.</em>
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @return the url</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="87" href="#87">87</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getUrl() {
<a class="jxr_linenumber" name="88" href="#88">88</a> <strong class="jxr_keyword">return</strong> version != <strong class="jxr_keyword">null</strong> ? version.url() : <span class="jxr_string">"Unknown"</span>;
<a class="jxr_linenumber" name="89" href="#89">89</a> }
<a class="jxr_linenumber" name="90" href="#90">90</a>
<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">static</strong> String[] versionReport() {
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String[] {
<a class="jxr_linenumber" name="93" href="#93">93</a> <span class="jxr_string">"Dcs "</span> + getVersion(),
<a class="jxr_linenumber" name="94" href="#94">94</a> <span class="jxr_string">"Revision "</span> + getRevision(),
<a class="jxr_linenumber" name="95" href="#95">95</a> <span class="jxr_string">"Compiled by "</span> + getUser() + <span class="jxr_string">" on "</span> + getDate()
<a class="jxr_linenumber" name="96" href="#96">96</a> };
<a class="jxr_linenumber" name="97" href="#97">97</a> }
<a class="jxr_linenumber" name="98" href="#98">98</a>
<a class="jxr_linenumber" name="99" href="#99">99</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeTo(PrintWriter out) {
<a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">for</strong> (String line : versionReport()) {
<a class="jxr_linenumber" name="101" href="#101">101</a> out.println(line);
<a class="jxr_linenumber" name="102" href="#102">102</a> }
<a class="jxr_linenumber" name="103" href="#103">103</a> }
<a class="jxr_linenumber" name="104" href="#104">104</a>
<a class="jxr_linenumber" name="105" href="#105">105</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> logVersion() {
<a class="jxr_linenumber" name="106" href="#106">106</a> <strong class="jxr_keyword">for</strong> (String line : versionReport()) {
<a class="jxr_linenumber" name="107" href="#107">107</a> LOG.info(line);
<a class="jxr_linenumber" name="108" href="#108">108</a> }
<a class="jxr_linenumber" name="109" href="#109">109</a> }
<a class="jxr_linenumber" name="110" href="#110">110</a>
<a class="jxr_linenumber" name="111" href="#111">111</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> main(String[] args) {
<a class="jxr_linenumber" name="112" href="#112">112</a> logVersion();
<a class="jxr_linenumber" name="113" href="#113">113</a> }
<a class="jxr_linenumber" name="114" href="#114">114</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>