Google Git
Sign in
apache / hbase-site / 0082cda45f48d1755543336c908ec6d80d4ec0a9 / . / devapidocs / src-html / org / apache / hadoop / hbase / rest / ScannerInstanceResource.html
blob: c9afd4e24664eac8789927720eab260f79853047 [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: ScannerInstanceResource">
<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 java.util.Base64;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.Cell;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.CellUtil;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.TableNotFoundException;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.rest.model.CellModel;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.rest.model.CellSetModel;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.rest.model.RowModel;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">030</span><span id="line-30">import org.slf4j.Logger;</span>
<span class="source-line-no">031</span><span id="line-31">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">032</span><span id="line-32"></span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hbase.thirdparty.javax.ws.rs.DELETE;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hbase.thirdparty.javax.ws.rs.GET;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hbase.thirdparty.javax.ws.rs.Produces;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hbase.thirdparty.javax.ws.rs.QueryParam;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hbase.thirdparty.javax.ws.rs.core.CacheControl;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hbase.thirdparty.javax.ws.rs.core.Context;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hbase.thirdparty.javax.ws.rs.core.Response;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hbase.thirdparty.javax.ws.rs.core.Response.ResponseBuilder;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hbase.thirdparty.javax.ws.rs.core.UriInfo;</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 ScannerInstanceResource extends ResourceBase {</span>
<span class="source-line-no">045</span><span id="line-45"> private static final Logger LOG = LoggerFactory.getLogger(ScannerInstanceResource.class);</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47"> static CacheControl cacheControl;</span>
<span class="source-line-no">048</span><span id="line-48"> static {</span>
<span class="source-line-no">049</span><span id="line-49"> cacheControl = new CacheControl();</span>
<span class="source-line-no">050</span><span id="line-50"> cacheControl.setNoCache(true);</span>
<span class="source-line-no">051</span><span id="line-51"> cacheControl.setNoTransform(false);</span>
<span class="source-line-no">052</span><span id="line-52"> }</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> ResultGenerator generator = null;</span>
<span class="source-line-no">055</span><span id="line-55"> String id = null;</span>
<span class="source-line-no">056</span><span id="line-56"> int batch = 1;</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 ScannerInstanceResource() throws IOException {</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"> public ScannerInstanceResource(String table, String id, ResultGenerator generator, int batch)</span>
<span class="source-line-no">062</span><span id="line-62"> throws IOException {</span>
<span class="source-line-no">063</span><span id="line-63"> this.id = id;</span>
<span class="source-line-no">064</span><span id="line-64"> this.generator = generator;</span>
<span class="source-line-no">065</span><span id="line-65"> this.batch = batch;</span>
<span class="source-line-no">066</span><span id="line-66"> }</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_XML, MIMETYPE_JSON, MIMETYPE_PROTOBUF, MIMETYPE_PROTOBUF_IETF })</span>
<span class="source-line-no">070</span><span id="line-70"> public Response get(final @Context UriInfo uriInfo, @QueryParam("n") int maxRows,</span>
<span class="source-line-no">071</span><span id="line-71"> final @QueryParam("c") int maxValues) {</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"> if (generator == null) {</span>
<span class="source-line-no">077</span><span id="line-77"> servlet.getMetrics().incrementFailedGetRequests(1);</span>
<span class="source-line-no">078</span><span id="line-78"> return Response.status(Response.Status.NOT_FOUND).type(MIMETYPE_TEXT)</span>
<span class="source-line-no">079</span><span id="line-79"> .entity("Not found" + CRLF).build();</span>
<span class="source-line-no">080</span><span id="line-80"> } else {</span>
<span class="source-line-no">081</span><span id="line-81"> // Updated the connection access time for each client next() call</span>
<span class="source-line-no">082</span><span id="line-82"> RESTServlet.getInstance().getConnectionCache().updateConnectionAccessTime();</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"> CellSetModel model = new CellSetModel();</span>
<span class="source-line-no">085</span><span id="line-85"> RowModel rowModel = null;</span>
<span class="source-line-no">086</span><span id="line-86"> byte[] rowKeyArray = null;</span>
<span class="source-line-no">087</span><span id="line-87"> int rowKeyOffset = 0;</span>
<span class="source-line-no">088</span><span id="line-88"> int rowKeyLength = 0;</span>
<span class="source-line-no">089</span><span id="line-89"> int limit = batch;</span>
<span class="source-line-no">090</span><span id="line-90"> if (maxValues &gt; 0) {</span>
<span class="source-line-no">091</span><span id="line-91"> limit = maxValues;</span>
<span class="source-line-no">092</span><span id="line-92"> }</span>
<span class="source-line-no">093</span><span id="line-93"> int count = limit;</span>
<span class="source-line-no">094</span><span id="line-94"> do {</span>
<span class="source-line-no">095</span><span id="line-95"> Cell value = null;</span>
<span class="source-line-no">096</span><span id="line-96"> try {</span>
<span class="source-line-no">097</span><span id="line-97"> value = generator.next();</span>
<span class="source-line-no">098</span><span id="line-98"> } catch (IllegalStateException e) {</span>
<span class="source-line-no">099</span><span id="line-99"> if (ScannerResource.delete(id)) {</span>
<span class="source-line-no">100</span><span id="line-100"> servlet.getMetrics().incrementSucessfulDeleteRequests(1);</span>
<span class="source-line-no">101</span><span id="line-101"> } else {</span>
<span class="source-line-no">102</span><span id="line-102"> servlet.getMetrics().incrementFailedDeleteRequests(1);</span>
<span class="source-line-no">103</span><span id="line-103"> }</span>
<span class="source-line-no">104</span><span id="line-104"> servlet.getMetrics().incrementFailedGetRequests(1);</span>
<span class="source-line-no">105</span><span id="line-105"> return Response.status(Response.Status.GONE).type(MIMETYPE_TEXT).entity("Gone" + CRLF)</span>
<span class="source-line-no">106</span><span id="line-106"> .build();</span>
<span class="source-line-no">107</span><span id="line-107"> } catch (IllegalArgumentException e) {</span>
<span class="source-line-no">108</span><span id="line-108"> Throwable t = e.getCause();</span>
<span class="source-line-no">109</span><span id="line-109"> if (t instanceof TableNotFoundException) {</span>
<span class="source-line-no">110</span><span id="line-110"> return Response.status(Response.Status.NOT_FOUND).type(MIMETYPE_TEXT)</span>
<span class="source-line-no">111</span><span id="line-111"> .entity("Not found" + CRLF).build();</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"> throw e;</span>
<span class="source-line-no">114</span><span id="line-114"> }</span>
<span class="source-line-no">115</span><span id="line-115"> if (value == null) {</span>
<span class="source-line-no">116</span><span id="line-116"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">117</span><span id="line-117"> LOG.trace("generator exhausted");</span>
<span class="source-line-no">118</span><span id="line-118"> }</span>
<span class="source-line-no">119</span><span id="line-119"> // respond with 204 (No Content) if an empty cell set would be</span>
<span class="source-line-no">120</span><span id="line-120"> // returned</span>
<span class="source-line-no">121</span><span id="line-121"> if (count == limit) {</span>
<span class="source-line-no">122</span><span id="line-122"> return Response.noContent().build();</span>
<span class="source-line-no">123</span><span id="line-123"> }</span>
<span class="source-line-no">124</span><span id="line-124"> break;</span>
<span class="source-line-no">125</span><span id="line-125"> }</span>
<span class="source-line-no">126</span><span id="line-126"> if (rowKeyArray == null) {</span>
<span class="source-line-no">127</span><span id="line-127"> rowKeyArray = value.getRowArray();</span>
<span class="source-line-no">128</span><span id="line-128"> rowKeyOffset = value.getRowOffset();</span>
<span class="source-line-no">129</span><span id="line-129"> rowKeyLength = value.getRowLength();</span>
<span class="source-line-no">130</span><span id="line-130"> rowModel = new RowModel(rowKeyArray, rowKeyOffset, rowKeyLength);</span>
<span class="source-line-no">131</span><span id="line-131"> }</span>
<span class="source-line-no">132</span><span id="line-132"> if (!CellUtil.matchingRow(value, rowKeyArray, rowKeyOffset, rowKeyLength)) {</span>
<span class="source-line-no">133</span><span id="line-133"> // if maxRows was given as a query param, stop if we would exceed the</span>
<span class="source-line-no">134</span><span id="line-134"> // specified number of rows</span>
<span class="source-line-no">135</span><span id="line-135"> if (maxRows &gt; 0) {</span>
<span class="source-line-no">136</span><span id="line-136"> if (--maxRows == 0) {</span>
<span class="source-line-no">137</span><span id="line-137"> generator.putBack(value);</span>
<span class="source-line-no">138</span><span id="line-138"> break;</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"> }</span>
<span class="source-line-no">141</span><span id="line-141"> model.addRow(rowModel);</span>
<span class="source-line-no">142</span><span id="line-142"> rowKeyArray = value.getRowArray();</span>
<span class="source-line-no">143</span><span id="line-143"> rowKeyOffset = value.getRowOffset();</span>
<span class="source-line-no">144</span><span id="line-144"> rowKeyLength = value.getRowLength();</span>
<span class="source-line-no">145</span><span id="line-145"> rowModel = new RowModel(rowKeyArray, rowKeyOffset, rowKeyLength);</span>
<span class="source-line-no">146</span><span id="line-146"> }</span>
<span class="source-line-no">147</span><span id="line-147"> rowModel.addCell(new CellModel(value));</span>
<span class="source-line-no">148</span><span id="line-148"> } while (--count &gt; 0);</span>
<span class="source-line-no">149</span><span id="line-149"> model.addRow(rowModel);</span>
<span class="source-line-no">150</span><span id="line-150"> ResponseBuilder response = Response.ok(model);</span>
<span class="source-line-no">151</span><span id="line-151"> response.cacheControl(cacheControl);</span>
<span class="source-line-no">152</span><span id="line-152"> servlet.getMetrics().incrementSucessfulGetRequests(1);</span>
<span class="source-line-no">153</span><span id="line-153"> return response.build();</span>
<span class="source-line-no">154</span><span id="line-154"> }</span>
<span class="source-line-no">155</span><span id="line-155"></span>
<span class="source-line-no">156</span><span id="line-156"> @GET</span>
<span class="source-line-no">157</span><span id="line-157"> @Produces(MIMETYPE_BINARY)</span>
<span class="source-line-no">158</span><span id="line-158"> public Response getBinary(final @Context UriInfo uriInfo) {</span>
<span class="source-line-no">159</span><span id="line-159"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">160</span><span id="line-160"> LOG.trace("GET " + uriInfo.getAbsolutePath() + " as " + MIMETYPE_BINARY);</span>
<span class="source-line-no">161</span><span id="line-161"> }</span>
<span class="source-line-no">162</span><span id="line-162"> servlet.getMetrics().incrementRequests(1);</span>
<span class="source-line-no">163</span><span id="line-163"> try {</span>
<span class="source-line-no">164</span><span id="line-164"> if (generator == null) {</span>
<span class="source-line-no">165</span><span id="line-165"> servlet.getMetrics().incrementFailedGetRequests(1);</span>
<span class="source-line-no">166</span><span id="line-166"> return Response.status(Response.Status.NOT_FOUND).type(MIMETYPE_TEXT)</span>
<span class="source-line-no">167</span><span id="line-167"> .entity("Not found" + CRLF).build();</span>
<span class="source-line-no">168</span><span id="line-168"> }</span>
<span class="source-line-no">169</span><span id="line-169"> Cell value = generator.next();</span>
<span class="source-line-no">170</span><span id="line-170"> if (value == null) {</span>
<span class="source-line-no">171</span><span id="line-171"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">172</span><span id="line-172"> LOG.trace("generator exhausted");</span>
<span class="source-line-no">173</span><span id="line-173"> }</span>
<span class="source-line-no">174</span><span id="line-174"> return Response.noContent().build();</span>
<span class="source-line-no">175</span><span id="line-175"> }</span>
<span class="source-line-no">176</span><span id="line-176"> ResponseBuilder response = Response.ok(CellUtil.cloneValue(value));</span>
<span class="source-line-no">177</span><span id="line-177"> response.cacheControl(cacheControl);</span>
<span class="source-line-no">178</span><span id="line-178"> response.header("X-Row",</span>
<span class="source-line-no">179</span><span id="line-179"> Bytes.toString(Base64.getEncoder().encode(CellUtil.cloneRow(value))));</span>
<span class="source-line-no">180</span><span id="line-180"> response.header("X-Column", Bytes.toString(Base64.getEncoder()</span>
<span class="source-line-no">181</span><span id="line-181"> .encode(CellUtil.makeColumn(CellUtil.cloneFamily(value), CellUtil.cloneQualifier(value)))));</span>
<span class="source-line-no">182</span><span id="line-182"> response.header("X-Timestamp", value.getTimestamp());</span>
<span class="source-line-no">183</span><span id="line-183"> servlet.getMetrics().incrementSucessfulGetRequests(1);</span>
<span class="source-line-no">184</span><span id="line-184"> return response.build();</span>
<span class="source-line-no">185</span><span id="line-185"> } catch (IllegalStateException e) {</span>
<span class="source-line-no">186</span><span id="line-186"> if (ScannerResource.delete(id)) {</span>
<span class="source-line-no">187</span><span id="line-187"> servlet.getMetrics().incrementSucessfulDeleteRequests(1);</span>
<span class="source-line-no">188</span><span id="line-188"> } else {</span>
<span class="source-line-no">189</span><span id="line-189"> servlet.getMetrics().incrementFailedDeleteRequests(1);</span>
<span class="source-line-no">190</span><span id="line-190"> }</span>
<span class="source-line-no">191</span><span id="line-191"> servlet.getMetrics().incrementFailedGetRequests(1);</span>
<span class="source-line-no">192</span><span id="line-192"> return Response.status(Response.Status.GONE).type(MIMETYPE_TEXT).entity("Gone" + CRLF)</span>
<span class="source-line-no">193</span><span id="line-193"> .build();</span>
<span class="source-line-no">194</span><span id="line-194"> }</span>
<span class="source-line-no">195</span><span id="line-195"> }</span>
<span class="source-line-no">196</span><span id="line-196"></span>
<span class="source-line-no">197</span><span id="line-197"> @DELETE</span>
<span class="source-line-no">198</span><span id="line-198"> public Response delete(final @Context UriInfo uriInfo) {</span>
<span class="source-line-no">199</span><span id="line-199"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">200</span><span id="line-200"> LOG.trace("DELETE " + uriInfo.getAbsolutePath());</span>
<span class="source-line-no">201</span><span id="line-201"> }</span>
<span class="source-line-no">202</span><span id="line-202"> servlet.getMetrics().incrementRequests(1);</span>
<span class="source-line-no">203</span><span id="line-203"> if (servlet.isReadOnly()) {</span>
<span class="source-line-no">204</span><span id="line-204"> return Response.status(Response.Status.FORBIDDEN).type(MIMETYPE_TEXT)</span>
<span class="source-line-no">205</span><span id="line-205"> .entity("Forbidden" + CRLF).build();</span>
<span class="source-line-no">206</span><span id="line-206"> }</span>
<span class="source-line-no">207</span><span id="line-207"> if (generator == null) {</span>
<span class="source-line-no">208</span><span id="line-208"> servlet.getMetrics().incrementFailedDeleteRequests(1);</span>
<span class="source-line-no">209</span><span id="line-209"> return Response.status(Response.Status.NOT_FOUND).type(MIMETYPE_TEXT)</span>
<span class="source-line-no">210</span><span id="line-210"> .entity("Not found" + CRLF).build();</span>
<span class="source-line-no">211</span><span id="line-211"> }</span>
<span class="source-line-no">212</span><span id="line-212"> if (ScannerResource.delete(id)) {</span>
<span class="source-line-no">213</span><span id="line-213"> servlet.getMetrics().incrementSucessfulDeleteRequests(1);</span>
<span class="source-line-no">214</span><span id="line-214"> } else {</span>
<span class="source-line-no">215</span><span id="line-215"> servlet.getMetrics().incrementFailedDeleteRequests(1);</span>
<span class="source-line-no">216</span><span id="line-216"> }</span>
<span class="source-line-no">217</span><span id="line-217"> return Response.ok().build();</span>
<span class="source-line-no">218</span><span id="line-218"> }</span>
<span class="source-line-no">219</span><span id="line-219">}</span>
</pre>
</div>
</main>
</body>
</html>