Google Git
Sign in
apache / trafodion-site / 0f742caac55ca35044838df47d6a6f41c1f568e2 / . / docs / 2.4.0 / rest_reference / xref / org / trafodion / rest / VersionResource.html
blob: 0ef2b8a3bcb35209ae609b56d629408ffb8352dd [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>VersionResource xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/trafodion/rest/VersionResource.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">* @@@ START COPYRIGHT @@@ </em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_javadoccomment">*</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_javadoccomment">* Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_javadoccomment">* or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_javadoccomment">* distributed with this work for additional information</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_javadoccomment">* regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_javadoccomment">* to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_javadoccomment">* "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_javadoccomment">* with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_javadoccomment">*</em>
<a class="jxr_linenumber" name="12" href="#12">12</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="13" href="#13">13</a> <em class="jxr_javadoccomment">*</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_javadoccomment">* Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_javadoccomment">* software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_javadoccomment">* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_javadoccomment">* KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_javadoccomment">* specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <em class="jxr_javadoccomment">* 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> <em class="jxr_javadoccomment">* @@@ END COPYRIGHT @@@</em>
<a class="jxr_linenumber" name="22" href="#22">22</a> <em class="jxr_javadoccomment">*/</em>
<a class="jxr_linenumber" name="23" href="#23">23</a>
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">package</strong> org.trafodion.<strong class="jxr_keyword">rest</strong>;
<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> java.io.IOException;
<a class="jxr_linenumber" name="27" href="#27">27</a>
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletContext;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> javax.ws.rs.GET;
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> javax.ws.rs.Path;
<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> javax.ws.rs.Produces;
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> javax.ws.rs.core.CacheControl;
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> javax.ws.rs.core.Context;
<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> javax.ws.rs.core.Response;
<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> javax.ws.rs.core.UriInfo;
<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> javax.ws.rs.core.Response.ResponseBuilder;
<a class="jxr_linenumber" name="37" href="#37">37</a>
<a class="jxr_linenumber" name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.commons.logging.Log;
<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.apache.commons.logging.LogFactory;
<a class="jxr_linenumber" name="40" href="#40">40</a>
<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.trafodion.<strong class="jxr_keyword">rest</strong>.model.VersionModel;
<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"> * Implements REST software version reporting</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * &lt;tt&gt;/version/rest&lt;/tt&gt;</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * &lt;tt&gt;/version&lt;/tt&gt; (alias for &lt;tt&gt;/version/rest&lt;/tt&gt;)</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../org/trafodion/rest/VersionResource.html">VersionResource</a> <strong class="jxr_keyword">extends</strong> <a href="../../../org/trafodion/rest/ResourceBase.html">ResourceBase</a> {
<a class="jxr_linenumber" name="51" href="#51">51</a>
<a class="jxr_linenumber" name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Log LOG = LogFactory.getLog(VersionResource.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="53" href="#53">53</a>
<a class="jxr_linenumber" name="54" href="#54">54</a> <strong class="jxr_keyword">static</strong> CacheControl cacheControl;
<a class="jxr_linenumber" name="55" href="#55">55</a> <strong class="jxr_keyword">static</strong> {
<a class="jxr_linenumber" name="56" href="#56">56</a> cacheControl = <strong class="jxr_keyword">new</strong> CacheControl();
<a class="jxr_linenumber" name="57" href="#57">57</a> cacheControl.setNoCache(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="58" href="#58">58</a> cacheControl.setNoTransform(false);
<a class="jxr_linenumber" name="59" href="#59">59</a> }
<a class="jxr_linenumber" name="60" href="#60">60</a>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Constructor</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @throws IOException</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/trafodion/rest/VersionResource.html">VersionResource</a>() <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">super</strong>();
<a class="jxr_linenumber" name="67" href="#67">67</a> }
<a class="jxr_linenumber" name="68" href="#68">68</a>
<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * Build a response for a version request.</em>
<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @param context servlet context</em>
<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @param uriInfo (JAX-RS context variable) request URL</em>
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @return a response for a version request </em>
<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="75" href="#75">75</a>
<a class="jxr_linenumber" name="76" href="#76">76</a> @GET
<a class="jxr_linenumber" name="77" href="#77">77</a> @Produces({MIMETYPE_TEXT, MIMETYPE_XML, MIMETYPE_JSON})
<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">public</strong> Response get(<strong class="jxr_keyword">final</strong> @Context ServletContext context,
<a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">final</strong> @Context UriInfo uriInfo) {
<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">if</strong> (LOG.isDebugEnabled()) {
<a class="jxr_linenumber" name="81" href="#81">81</a> LOG.debug(<span class="jxr_string">"GET "</span> + uriInfo.getAbsolutePath());
<a class="jxr_linenumber" name="82" href="#82">82</a> }
<a class="jxr_linenumber" name="83" href="#83">83</a> ResponseBuilder response = Response.ok(<strong class="jxr_keyword">new</strong> <a href="../../../org/trafodion/rest/model/VersionModel.html">VersionModel</a>(context));
<a class="jxr_linenumber" name="84" href="#84">84</a> response.cacheControl(cacheControl);
<a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">return</strong> response.build();
<a class="jxr_linenumber" name="86" href="#86">86</a> }
<a class="jxr_linenumber" name="87" href="#87">87</a>
<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * Dispatch &lt;tt&gt;/version/rest&lt;/tt&gt; to self.</em>
<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="91" href="#91">91</a> @Path(<span class="jxr_string">"rest"</span>)
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/trafodion/rest/VersionResource.html">VersionResource</a> getVersionResource() {
<a class="jxr_linenumber" name="93" href="#93">93</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="94" href="#94">94</a> }
<a class="jxr_linenumber" name="95" href="#95">95</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>