Google Git
Sign in
apache / hbase-site / 8fd2c4eb88e16adcde8c37477d08d4a362fe1126 / . / devapidocs / src-html / org / apache / hadoop / hbase / rest / TableScanResource.html
blob: 949ec8c876036d5a47812c1dd28a0357eb70dd95 [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> *<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a>
<span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a>
<span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a>
<span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a>
<span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a>
<span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a>
<span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a>
<span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.rest;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.ArrayList;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Iterator;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.List;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import javax.ws.rs.GET;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import javax.ws.rs.HeaderParam;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import javax.ws.rs.Produces;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import javax.ws.rs.core.Context;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import javax.ws.rs.core.Response;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import javax.ws.rs.core.Response.ResponseBuilder;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import javax.ws.rs.core.StreamingOutput;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import javax.ws.rs.core.UriInfo;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import javax.xml.bind.annotation.XmlAccessType;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import javax.xml.bind.annotation.XmlAccessorType;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import javax.xml.bind.annotation.XmlElement;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import javax.xml.bind.annotation.XmlRootElement;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.Cell;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.client.Result;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.client.ResultScanner;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.rest.model.CellModel;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.rest.model.RowModel;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.slf4j.Logger;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.slf4j.LoggerFactory;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>import com.fasterxml.jackson.annotation.JsonIgnore;<a name="line.49"></a>
<span class="sourceLineNo">050</span>import com.fasterxml.jackson.annotation.JsonProperty;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span>@InterfaceAudience.Private<a name="line.52"></a>
<span class="sourceLineNo">053</span>public class TableScanResource extends ResourceBase {<a name="line.53"></a>
<span class="sourceLineNo">054</span> private static final Logger LOG = LoggerFactory.getLogger(TableScanResource.class);<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> TableResource tableResource;<a name="line.56"></a>
<span class="sourceLineNo">057</span> ResultScanner results;<a name="line.57"></a>
<span class="sourceLineNo">058</span> int userRequestedLimit;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> public TableScanResource(ResultScanner scanner, int userRequestedLimit) throws IOException {<a name="line.60"></a>
<span class="sourceLineNo">061</span> super();<a name="line.61"></a>
<span class="sourceLineNo">062</span> this.results = scanner;<a name="line.62"></a>
<span class="sourceLineNo">063</span> this.userRequestedLimit = userRequestedLimit;<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> @GET<a name="line.66"></a>
<span class="sourceLineNo">067</span> @Produces({ Constants.MIMETYPE_XML, Constants.MIMETYPE_JSON })<a name="line.67"></a>
<span class="sourceLineNo">068</span> public CellSetModelStream get(final @Context UriInfo uriInfo) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> if (LOG.isTraceEnabled()) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> LOG.trace("GET " + uriInfo.getAbsolutePath());<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span> servlet.getMetrics().incrementRequests(1);<a name="line.72"></a>
<span class="sourceLineNo">073</span> final int rowsToSend = userRequestedLimit;<a name="line.73"></a>
<span class="sourceLineNo">074</span> servlet.getMetrics().incrementSucessfulScanRequests(1);<a name="line.74"></a>
<span class="sourceLineNo">075</span> final Iterator&lt;Result&gt; itr = results.iterator();<a name="line.75"></a>
<span class="sourceLineNo">076</span> return new CellSetModelStream(new ArrayList&lt;RowModel&gt;() {<a name="line.76"></a>
<span class="sourceLineNo">077</span> @Override<a name="line.77"></a>
<span class="sourceLineNo">078</span> public Iterator&lt;RowModel&gt; iterator() {<a name="line.78"></a>
<span class="sourceLineNo">079</span> return new Iterator&lt;RowModel&gt;() {<a name="line.79"></a>
<span class="sourceLineNo">080</span> int count = rowsToSend;<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> @Override<a name="line.82"></a>
<span class="sourceLineNo">083</span> public boolean hasNext() {<a name="line.83"></a>
<span class="sourceLineNo">084</span> return count &gt; 0 &amp;&amp; itr.hasNext();<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> @Override<a name="line.87"></a>
<span class="sourceLineNo">088</span> public RowModel next() {<a name="line.88"></a>
<span class="sourceLineNo">089</span> Result rs = itr.next();<a name="line.89"></a>
<span class="sourceLineNo">090</span> if ((rs == null) || (count &lt;= 0)) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> return null;<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> byte[] rowKey = rs.getRow();<a name="line.93"></a>
<span class="sourceLineNo">094</span> RowModel rModel = new RowModel(rowKey);<a name="line.94"></a>
<span class="sourceLineNo">095</span> List&lt;Cell&gt; kvs = rs.listCells();<a name="line.95"></a>
<span class="sourceLineNo">096</span> for (Cell kv : kvs) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> rModel.addCell(new CellModel(CellUtil.cloneFamily(kv), CellUtil.cloneQualifier(kv),<a name="line.97"></a>
<span class="sourceLineNo">098</span> kv.getTimestamp(), CellUtil.cloneValue(kv)));<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> count--;<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (count == 0) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> results.close();<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span> return rModel;<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span> };<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><a name="line.110"></a>
<span class="sourceLineNo">111</span> @GET<a name="line.111"></a>
<span class="sourceLineNo">112</span> @Produces({ Constants.MIMETYPE_PROTOBUF, Constants.MIMETYPE_PROTOBUF_IETF })<a name="line.112"></a>
<span class="sourceLineNo">113</span> public Response getProtobuf(<a name="line.113"></a>
<span class="sourceLineNo">114</span> final @Context UriInfo uriInfo,<a name="line.114"></a>
<span class="sourceLineNo">115</span> final @HeaderParam("Accept") String contentType) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> if (LOG.isTraceEnabled()) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> LOG.trace("GET " + uriInfo.getAbsolutePath() + " as " +<a name="line.117"></a>
<span class="sourceLineNo">118</span> MIMETYPE_BINARY);<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> servlet.getMetrics().incrementRequests(1);<a name="line.120"></a>
<span class="sourceLineNo">121</span> try {<a name="line.121"></a>
<span class="sourceLineNo">122</span> int fetchSize = this.servlet.getConfiguration().getInt(Constants.SCAN_FETCH_SIZE, 10);<a name="line.122"></a>
<span class="sourceLineNo">123</span> StreamingOutput stream = new ProtobufStreamingOutput(this.results, contentType,<a name="line.123"></a>
<span class="sourceLineNo">124</span> userRequestedLimit, fetchSize);<a name="line.124"></a>
<span class="sourceLineNo">125</span> servlet.getMetrics().incrementSucessfulScanRequests(1);<a name="line.125"></a>
<span class="sourceLineNo">126</span> ResponseBuilder response = Response.ok(stream);<a name="line.126"></a>
<span class="sourceLineNo">127</span> response.header("content-type", contentType);<a name="line.127"></a>
<span class="sourceLineNo">128</span> return response.build();<a name="line.128"></a>
<span class="sourceLineNo">129</span> } catch (Exception exp) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> servlet.getMetrics().incrementFailedScanRequests(1);<a name="line.130"></a>
<span class="sourceLineNo">131</span> processException(exp);<a name="line.131"></a>
<span class="sourceLineNo">132</span> LOG.warn(exp.toString(), exp);<a name="line.132"></a>
<span class="sourceLineNo">133</span> return null;<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> @XmlRootElement(name = "CellSet")<a name="line.137"></a>
<span class="sourceLineNo">138</span> @XmlAccessorType(XmlAccessType.FIELD)<a name="line.138"></a>
<span class="sourceLineNo">139</span> public static class CellSetModelStream {<a name="line.139"></a>
<span class="sourceLineNo">140</span> // JAXB needs an arraylist for streaming<a name="line.140"></a>
<span class="sourceLineNo">141</span> @XmlElement(name = "Row")<a name="line.141"></a>
<span class="sourceLineNo">142</span> @JsonIgnore<a name="line.142"></a>
<span class="sourceLineNo">143</span> private ArrayList&lt;RowModel&gt; Row;<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> public CellSetModelStream() {<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> public CellSetModelStream(final ArrayList&lt;RowModel&gt; rowList) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> this.Row = rowList;<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> // jackson needs an iterator for streaming<a name="line.152"></a>
<span class="sourceLineNo">153</span> @JsonProperty("Row")<a name="line.153"></a>
<span class="sourceLineNo">154</span> public Iterator&lt;RowModel&gt; getIterator() {<a name="line.154"></a>
<span class="sourceLineNo">155</span> return Row.iterator();<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span>}<a name="line.158"></a>
</pre>
</div>
</body>
</html>