blob: 454ceb1ab88ef918dd813a9491184b16f47ece7c [file] [log] [blame]
<!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.rest, class: VersionResource">
<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.rest;</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 javax.servlet.ServletContext;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.rest.model.VersionModel;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">024</span><span id="line-24">import org.slf4j.Logger;</span>
<span class="source-line-no">025</span><span id="line-25">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">026</span><span id="line-26"></span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hbase.thirdparty.javax.ws.rs.GET;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hbase.thirdparty.javax.ws.rs.Path;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hbase.thirdparty.javax.ws.rs.Produces;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hbase.thirdparty.javax.ws.rs.core.CacheControl;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hbase.thirdparty.javax.ws.rs.core.Context;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hbase.thirdparty.javax.ws.rs.core.Response;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hbase.thirdparty.javax.ws.rs.core.Response.ResponseBuilder;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hbase.thirdparty.javax.ws.rs.core.UriInfo;</span>
<span class="source-line-no">035</span><span id="line-35"></span>
<span class="source-line-no">036</span><span id="line-36">/**</span>
<span class="source-line-no">037</span><span id="line-37"> * Implements REST software version reporting</span>
<span class="source-line-no">038</span><span id="line-38"> * &lt;p&gt;</span>
<span class="source-line-no">039</span><span id="line-39"> * &lt;tt&gt;/version/rest&lt;/tt&gt;</span>
<span class="source-line-no">040</span><span id="line-40"> * &lt;p&gt;</span>
<span class="source-line-no">041</span><span id="line-41"> * &lt;tt&gt;/version&lt;/tt&gt; (alias for &lt;tt&gt;/version/rest&lt;/tt&gt;)</span>
<span class="source-line-no">042</span><span id="line-42"> */</span>
<span class="source-line-no">043</span><span id="line-43">@InterfaceAudience.Private</span>
<span class="source-line-no">044</span><span id="line-44">public class VersionResource extends ResourceBase {</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46"> private static final Logger LOG = LoggerFactory.getLogger(VersionResource.class);</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48"> static CacheControl cacheControl;</span>
<span class="source-line-no">049</span><span id="line-49"> static {</span>
<span class="source-line-no">050</span><span id="line-50"> cacheControl = new CacheControl();</span>
<span class="source-line-no">051</span><span id="line-51"> cacheControl.setNoCache(true);</span>
<span class="source-line-no">052</span><span id="line-52"> cacheControl.setNoTransform(false);</span>
<span class="source-line-no">053</span><span id="line-53"> }</span>
<span class="source-line-no">054</span><span id="line-54"></span>
<span class="source-line-no">055</span><span id="line-55"> /**</span>
<span class="source-line-no">056</span><span id="line-56"> * Constructor</span>
<span class="source-line-no">057</span><span id="line-57"> */</span>
<span class="source-line-no">058</span><span id="line-58"> public VersionResource() throws IOException {</span>
<span class="source-line-no">059</span><span id="line-59"> super();</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"> /**</span>
<span class="source-line-no">063</span><span id="line-63"> * Build a response for a version request.</span>
<span class="source-line-no">064</span><span id="line-64"> * @param context servlet context</span>
<span class="source-line-no">065</span><span id="line-65"> * @param uriInfo (JAX-RS context variable) request URL</span>
<span class="source-line-no">066</span><span id="line-66"> * @return a response for a version request</span>
<span class="source-line-no">067</span><span id="line-67"> */</span>
<span class="source-line-no">068</span><span id="line-68"> @GET</span>
<span class="source-line-no">069</span><span id="line-69"> @Produces({ MIMETYPE_TEXT, MIMETYPE_XML, MIMETYPE_JSON, MIMETYPE_PROTOBUF,</span>
<span class="source-line-no">070</span><span id="line-70"> MIMETYPE_PROTOBUF_IETF })</span>
<span class="source-line-no">071</span><span id="line-71"> public Response get(final @Context ServletContext context, final @Context UriInfo uriInfo) {</span>
<span class="source-line-no">072</span><span id="line-72"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">073</span><span id="line-73"> LOG.trace("GET " + uriInfo.getAbsolutePath());</span>
<span class="source-line-no">074</span><span id="line-74"> }</span>
<span class="source-line-no">075</span><span id="line-75"> servlet.getMetrics().incrementRequests(1);</span>
<span class="source-line-no">076</span><span id="line-76"> ResponseBuilder response = Response.ok(new VersionModel(context));</span>
<span class="source-line-no">077</span><span id="line-77"> response.cacheControl(cacheControl);</span>
<span class="source-line-no">078</span><span id="line-78"> servlet.getMetrics().incrementSucessfulGetRequests(1);</span>
<span class="source-line-no">079</span><span id="line-79"> return response.build();</span>
<span class="source-line-no">080</span><span id="line-80"> }</span>
<span class="source-line-no">081</span><span id="line-81"></span>
<span class="source-line-no">082</span><span id="line-82"> /**</span>
<span class="source-line-no">083</span><span id="line-83"> * Dispatch to StorageClusterVersionResource</span>
<span class="source-line-no">084</span><span id="line-84"> */</span>
<span class="source-line-no">085</span><span id="line-85"> @Path("cluster")</span>
<span class="source-line-no">086</span><span id="line-86"> public StorageClusterVersionResource getClusterVersionResource() throws IOException {</span>
<span class="source-line-no">087</span><span id="line-87"> return new StorageClusterVersionResource();</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> /**</span>
<span class="source-line-no">091</span><span id="line-91"> * Dispatch &lt;tt&gt;/version/rest&lt;/tt&gt; to self.</span>
<span class="source-line-no">092</span><span id="line-92"> */</span>
<span class="source-line-no">093</span><span id="line-93"> @Path("rest")</span>
<span class="source-line-no">094</span><span id="line-94"> public VersionResource getVersionResource() {</span>
<span class="source-line-no">095</span><span id="line-95"> return this;</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97">}</span>
</pre>
</div>
</main>
</body>
</html>