| <!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> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.master.webapp;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.UnsupportedEncodingException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.net.URLDecoder;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.net.URLEncoder;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.nio.charset.StandardCharsets;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.ArrayList;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.Collection;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Iterator;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.LinkedList;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.List;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.stream.StreamSupport;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import javax.servlet.http.HttpServletRequest;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.commons.lang3.StringUtils;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.commons.lang3.builder.ToStringBuilder;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.commons.lang3.builder.ToStringStyle;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.CompareOperator;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.HConstants;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.TableName;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.client.AdvancedScanResultConsumer;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.client.AsyncConnection;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.client.AsyncTable;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.client.ResultScanner;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.filter.Filter;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.filter.FilterList;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.filter.PrefixFilter;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.filter.SingleColumnValueFilter;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.master.RegionState;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import org.apache.hbase.thirdparty.com.google.common.collect.Iterators;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import org.apache.hbase.thirdparty.io.netty.handler.codec.http.QueryStringEncoder;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span>/**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <p><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Support class for the "Meta Entries" section in {@code resources/hbase-webapps/master/table.jsp}.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * </p><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <p><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <b>Interface</b>. This class's intended consumer is {@code table.jsp}. As such, it's primary<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * interface is the active {@link HttpServletRequest}, from which it uses the {@code scan_*}<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * request parameters. This class supports paging through an optionally filtered view of the<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * contents of {@code hbase:meta}. Those filters and the pagination offset are specified via these<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * request parameters. It provides helper methods for constructing pagination links.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * <ul><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <li>{@value #NAME_PARAM} - the name of the table requested. The only table of our concern here<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * is {@code hbase:meta}; any other value is effectively ignored by the giant conditional in the<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * jsp.</li><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * <li>{@value #SCAN_LIMIT_PARAM} - specifies a limit on the number of region (replicas) rendered<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * on the by the table in a single request -- a limit on page size. This corresponds to the<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * number of {@link RegionReplicaInfo} objects produced by {@link Results#iterator()}. When a<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * value for {@code scan_limit} is invalid or not specified, the default value of<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * {@value #SCAN_LIMIT_DEFAULT} is used. In order to avoid excessive resource consumption, a<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * maximum value of {@value #SCAN_LIMIT_MAX} is enforced.</li><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * <li>{@value #SCAN_REGION_STATE_PARAM} - an optional filter on {@link RegionState}.</li><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <li>{@value #SCAN_START_PARAM} - specifies the rowkey at which a scan should start. For usage<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * details, see the below section on <b>Pagination</b>.</li><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * <li>{@value #SCAN_TABLE_PARAM} - specifies a filter on the values returned, limiting them to<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * regions from a specified table. This parameter is implemented as a prefix filter on the<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * {@link Scan}, so in effect it can be used for simple namespace and multi-table matches.</li><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * </ul><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * </p><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * <p><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <b>Pagination</b>. A single page of results are made available via {@link #getResults()} / an<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * instance of {@link Results}. Callers use its {@link Iterator} consume the page of<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * {@link RegionReplicaInfo} instances, each of which represents a region or region replica. Helper<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * methods are provided for building page navigation controls preserving the user's selected filter<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * set: {@link #buildFirstPageUrl()}, {@link #buildNextPageUrl(byte[])}. Pagination is implemented<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * using a simple offset + limit system. Offset is provided by the {@value #SCAN_START_PARAM},<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * limit via {@value #SCAN_LIMIT_PARAM}. Under the hood, the {@link Scan} is constructed with<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * {@link Scan#setMaxResultSize(long)} set to ({@value SCAN_LIMIT_PARAM} +1), while the<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * {@link Results} {@link Iterator} honors {@value #SCAN_LIMIT_PARAM}. The +1 allows the caller to<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * know if a "next page" is available via {@link Results#hasMoreResults()}. Note that this<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * pagination strategy is incomplete when it comes to region replicas and can potentially omit<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * rendering replicas that fall between the last rowkey offset and {@code replicaCount % page size}.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * </p><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * <p><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * <b>Error Messages</b>. Any time there's an error parsing user input, a message will be populated<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * in {@link #getErrorMessages()}. Any fields which produce an error will have their filter values<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * set to the default, except for a value of {@value #SCAN_LIMIT_PARAM} that exceeds<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * {@value #SCAN_LIMIT_MAX}, in which case {@value #SCAN_LIMIT_MAX} is used.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * </p><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> */<a name="line.100"></a> |
| <span class="sourceLineNo">101</span>@InterfaceAudience.Private<a name="line.101"></a> |
| <span class="sourceLineNo">102</span>public class MetaBrowser {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> public static final String NAME_PARAM = "name";<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> public static final String SCAN_LIMIT_PARAM = "scan_limit";<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public static final String SCAN_REGION_STATE_PARAM = "scan_region_state";<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> public static final String SCAN_START_PARAM = "scan_start";<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> public static final String SCAN_TABLE_PARAM = "scan_table";<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public static final int SCAN_LIMIT_DEFAULT = 10;<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> public static final int SCAN_LIMIT_MAX = 10_000;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> private final AsyncConnection connection;<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> private final HttpServletRequest request;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> private final List<String> errorMessages;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> private final String name;<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> private final Integer scanLimit;<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> private final RegionState.State scanRegionState;<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> private final byte[] scanStart;<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> private final TableName scanTable;<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> public MetaBrowser(final AsyncConnection connection, final HttpServletRequest request) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> this.connection = connection;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> this.request = request;<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> this.errorMessages = new LinkedList<>();<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> this.name = resolveName(request);<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> this.scanLimit = resolveScanLimit(request);<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> this.scanRegionState = resolveScanRegionState(request);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> this.scanStart = resolveScanStart(request);<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> this.scanTable = resolveScanTable(request);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> public List<String> getErrorMessages() {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> return errorMessages;<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> public String getName() {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> return name;<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> public Integer getScanLimit() {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> return scanLimit;<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> public byte[] getScanStart() {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> return scanStart;<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 RegionState.State getScanRegionState() {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return scanRegionState;<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> public TableName getScanTable() {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> return scanTable;<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> public Results getResults() {<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> final AsyncTable<AdvancedScanResultConsumer> asyncTable =<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> connection.getTable(TableName.META_TABLE_NAME);<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> return new Results(asyncTable.getScanner(buildScan()));<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> }<a name="line.160"></a> |
| <span class="sourceLineNo">161</span><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> @Override<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> public String toString() {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> .append("scanStart", scanStart)<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> .append("scanLimit", scanLimit)<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> .append("scanTable", scanTable)<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> .append("scanRegionState", scanRegionState)<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> .toString();<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> }<a name="line.170"></a> |
| <span class="sourceLineNo">171</span><a name="line.171"></a> |
| <span class="sourceLineNo">172</span> private static String resolveName(final HttpServletRequest request) {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> return resolveRequestParameter(request, NAME_PARAM);<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> private Integer resolveScanLimit(final HttpServletRequest request) {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> final String requestValueStr = resolveRequestParameter(request, SCAN_LIMIT_PARAM);<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> if (StringUtils.isBlank(requestValueStr)) {<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> return null;<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> }<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> final Integer requestValue = tryParseInt(requestValueStr);<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> if (requestValue == null) {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> errorMessages.add(buildScanLimitMalformedErrorMessage(requestValueStr));<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> return null;<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> }<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> if (requestValue <= 0) {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> errorMessages.add(buildScanLimitLTEQZero(requestValue));<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> return SCAN_LIMIT_DEFAULT;<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> }<a name="line.190"></a> |
| <span class="sourceLineNo">191</span><a name="line.191"></a> |
| <span class="sourceLineNo">192</span> final int truncatedValue = Math.min(requestValue, SCAN_LIMIT_MAX);<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> if (requestValue != truncatedValue) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> errorMessages.add(buildScanLimitExceededErrorMessage(requestValue));<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> return truncatedValue;<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> }<a name="line.197"></a> |
| <span class="sourceLineNo">198</span><a name="line.198"></a> |
| <span class="sourceLineNo">199</span> private RegionState.State resolveScanRegionState(final HttpServletRequest request) {<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> final String requestValueStr = resolveRequestParameter(request, SCAN_REGION_STATE_PARAM);<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> if (requestValueStr == null) {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> return null;<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> final RegionState.State requestValue = tryValueOf(RegionState.State.class, requestValueStr);<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> if (requestValue == null) {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> errorMessages.add(buildScanRegionStateMalformedErrorMessage(requestValueStr));<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> return null;<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> }<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> return requestValue;<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> }<a name="line.210"></a> |
| <span class="sourceLineNo">211</span><a name="line.211"></a> |
| <span class="sourceLineNo">212</span> private static byte[] resolveScanStart(final HttpServletRequest request) {<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> // TODO: handle replicas that fall between the last rowkey and pagination limit.<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> final String requestValue = resolveRequestParameter(request, SCAN_START_PARAM);<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> if (requestValue == null) {<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> return null;<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> }<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> return Bytes.toBytesBinary(requestValue);<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> }<a name="line.219"></a> |
| <span class="sourceLineNo">220</span><a name="line.220"></a> |
| <span class="sourceLineNo">221</span> private static TableName resolveScanTable(final HttpServletRequest request) {<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> final String requestValue = resolveRequestParameter(request, SCAN_TABLE_PARAM);<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> if (requestValue == null) {<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> return null;<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> }<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> return TableName.valueOf(requestValue);<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> }<a name="line.227"></a> |
| <span class="sourceLineNo">228</span><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> private static String resolveRequestParameter(final HttpServletRequest request,<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> final String param) {<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> if (request == null) {<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> return null;<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> }<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> final String requestValueStrEnc = request.getParameter(param);<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> if (StringUtils.isBlank(requestValueStrEnc)) {<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> return null;<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> }<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> return urlDecode(requestValueStrEnc);<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> }<a name="line.239"></a> |
| <span class="sourceLineNo">240</span><a name="line.240"></a> |
| <span class="sourceLineNo">241</span> private static Filter buildTableFilter(final TableName tableName) {<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> return new PrefixFilter(tableName.toBytes());<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> }<a name="line.243"></a> |
| <span class="sourceLineNo">244</span><a name="line.244"></a> |
| <span class="sourceLineNo">245</span> private static Filter buildScanRegionStateFilter(final RegionState.State state) {<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> return new SingleColumnValueFilter(<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> HConstants.CATALOG_FAMILY,<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> HConstants.STATE_QUALIFIER,<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> CompareOperator.EQUAL,<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> // use the same serialization strategy as found in MetaTableAccessor#addRegionStateToPut<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> Bytes.toBytes(state.name()));<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> }<a name="line.252"></a> |
| <span class="sourceLineNo">253</span><a name="line.253"></a> |
| <span class="sourceLineNo">254</span> private Filter buildScanFilter() {<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> if (scanTable == null && scanRegionState == null) {<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> return null;<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> }<a name="line.257"></a> |
| <span class="sourceLineNo">258</span><a name="line.258"></a> |
| <span class="sourceLineNo">259</span> final List<Filter> filters = new ArrayList<>(2);<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> if (scanTable != null) {<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> filters.add(buildTableFilter(scanTable));<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> }<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> if (scanRegionState != null) {<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> filters.add(buildScanRegionStateFilter(scanRegionState));<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> }<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> if (filters.size() == 1) {<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> return filters.get(0);<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> }<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> return new FilterList(FilterList.Operator.MUST_PASS_ALL, filters);<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> }<a name="line.270"></a> |
| <span class="sourceLineNo">271</span><a name="line.271"></a> |
| <span class="sourceLineNo">272</span> private Scan buildScan() {<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> final Scan metaScan = new Scan()<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> .addFamily(HConstants.CATALOG_FAMILY)<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> .readVersions(1)<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> .setLimit((scanLimit != null ? scanLimit : SCAN_LIMIT_DEFAULT) + 1);<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> if (scanStart != null) {<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> metaScan.withStartRow(scanStart, false);<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> final Filter filter = buildScanFilter();<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> if (filter != null) {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> metaScan.setFilter(filter);<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> }<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> return metaScan;<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> }<a name="line.285"></a> |
| <span class="sourceLineNo">286</span><a name="line.286"></a> |
| <span class="sourceLineNo">287</span> /**<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * Adds {@code value} to {@code encoder} under {@code paramName} when {@code value} is non-null.<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> */<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> private void addParam(final QueryStringEncoder encoder, final String paramName,<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> final Object value) {<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> if (value != null) {<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> encoder.addParam(paramName, value.toString());<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> }<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> }<a name="line.295"></a> |
| <span class="sourceLineNo">296</span><a name="line.296"></a> |
| <span class="sourceLineNo">297</span> private QueryStringEncoder buildFirstPageEncoder() {<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> final QueryStringEncoder encoder =<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> new QueryStringEncoder(request.getRequestURI());<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> addParam(encoder, NAME_PARAM, name);<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> addParam(encoder, SCAN_LIMIT_PARAM, scanLimit);<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> addParam(encoder, SCAN_REGION_STATE_PARAM, scanRegionState);<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> addParam(encoder, SCAN_TABLE_PARAM, scanTable);<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> return encoder;<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> }<a name="line.305"></a> |
| <span class="sourceLineNo">306</span><a name="line.306"></a> |
| <span class="sourceLineNo">307</span> public String buildFirstPageUrl() {<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> return buildFirstPageEncoder().toString();<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> }<a name="line.309"></a> |
| <span class="sourceLineNo">310</span><a name="line.310"></a> |
| <span class="sourceLineNo">311</span> static String buildStartParamFrom(final byte[] lastRow) {<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> if (lastRow == null) {<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> return null;<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> }<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> return urlEncode(Bytes.toStringBinary(lastRow));<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> }<a name="line.316"></a> |
| <span class="sourceLineNo">317</span><a name="line.317"></a> |
| <span class="sourceLineNo">318</span> public String buildNextPageUrl(final byte[] lastRow) {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> final QueryStringEncoder encoder = buildFirstPageEncoder();<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> final String startRow = buildStartParamFrom(lastRow);<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> addParam(encoder, SCAN_START_PARAM, startRow);<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> return encoder.toString();<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> }<a name="line.323"></a> |
| <span class="sourceLineNo">324</span><a name="line.324"></a> |
| <span class="sourceLineNo">325</span> private static String urlEncode(final String val) {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> if (StringUtils.isEmpty(val)) {<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> return null;<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> }<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> try {<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> return URLEncoder.encode(val, StandardCharsets.UTF_8.toString());<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> } catch (UnsupportedEncodingException e) {<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> return null;<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> }<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> }<a name="line.334"></a> |
| <span class="sourceLineNo">335</span><a name="line.335"></a> |
| <span class="sourceLineNo">336</span> private static String urlDecode(final String val) {<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> if (StringUtils.isEmpty(val)) {<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> return null;<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> }<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> try {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> return URLDecoder.decode(val, StandardCharsets.UTF_8.toString());<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> } catch (UnsupportedEncodingException e) {<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> return null;<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> }<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> }<a name="line.345"></a> |
| <span class="sourceLineNo">346</span><a name="line.346"></a> |
| <span class="sourceLineNo">347</span> private static Integer tryParseInt(final String val) {<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> if (StringUtils.isEmpty(val)) {<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> return null;<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> }<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> try {<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> return Integer.parseInt(val);<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> } catch (NumberFormatException e) {<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> return null;<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> }<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> }<a name="line.356"></a> |
| <span class="sourceLineNo">357</span><a name="line.357"></a> |
| <span class="sourceLineNo">358</span> private static <T extends Enum<T>> T tryValueOf(final Class<T> clazz,<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> final String value) {<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> if (clazz == null || value == null) {<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> return null;<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> }<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> try {<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> return Enum.valueOf(clazz, value);<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> } catch (IllegalArgumentException e) {<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> return null;<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> }<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> }<a name="line.368"></a> |
| <span class="sourceLineNo">369</span><a name="line.369"></a> |
| <span class="sourceLineNo">370</span> private static String buildScanLimitExceededErrorMessage(final int requestValue) {<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> return String.format(<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> "Requested SCAN_LIMIT value %d exceeds maximum value %d.", requestValue, SCAN_LIMIT_MAX);<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> }<a name="line.373"></a> |
| <span class="sourceLineNo">374</span><a name="line.374"></a> |
| <span class="sourceLineNo">375</span> private static String buildScanLimitMalformedErrorMessage(final String requestValue) {<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> return String.format(<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> "Requested SCAN_LIMIT value '%s' cannot be parsed as an integer.", requestValue);<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> }<a name="line.378"></a> |
| <span class="sourceLineNo">379</span><a name="line.379"></a> |
| <span class="sourceLineNo">380</span> private static String buildScanLimitLTEQZero(final int requestValue) {<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> return String.format("Requested SCAN_LIMIT value %d is <= 0.", requestValue);<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> }<a name="line.382"></a> |
| <span class="sourceLineNo">383</span><a name="line.383"></a> |
| <span class="sourceLineNo">384</span> private static String buildScanRegionStateMalformedErrorMessage(final String requestValue) {<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> return String.format(<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> "Requested SCAN_REGION_STATE value '%s' cannot be parsed as a RegionState.", requestValue);<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> }<a name="line.387"></a> |
| <span class="sourceLineNo">388</span><a name="line.388"></a> |
| <span class="sourceLineNo">389</span> /**<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> * Encapsulates the results produced by this {@link MetaBrowser} instance.<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> */<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> public final class Results implements AutoCloseable, Iterable<RegionReplicaInfo> {<a name="line.392"></a> |
| <span class="sourceLineNo">393</span><a name="line.393"></a> |
| <span class="sourceLineNo">394</span> private final ResultScanner resultScanner;<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> private final Iterator<RegionReplicaInfo> sourceIterator;<a name="line.395"></a> |
| <span class="sourceLineNo">396</span><a name="line.396"></a> |
| <span class="sourceLineNo">397</span> private Results(final ResultScanner resultScanner) {<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> this.resultScanner = resultScanner;<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> this.sourceIterator = StreamSupport.stream(resultScanner.spliterator(), false)<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> .map(RegionReplicaInfo::from)<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> .flatMap(Collection::stream)<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> .iterator();<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> }<a name="line.403"></a> |
| <span class="sourceLineNo">404</span><a name="line.404"></a> |
| <span class="sourceLineNo">405</span> /**<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> * @return {@code true} when the underlying {@link ResultScanner} is not yet exhausted,<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> * {@code false} otherwise.<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> */<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> public boolean hasMoreResults() {<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> return sourceIterator.hasNext();<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> }<a name="line.411"></a> |
| <span class="sourceLineNo">412</span><a name="line.412"></a> |
| <span class="sourceLineNo">413</span> @Override<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> public void close() {<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> if (resultScanner != null) {<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> resultScanner.close();<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> }<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> }<a name="line.418"></a> |
| <span class="sourceLineNo">419</span><a name="line.419"></a> |
| <span class="sourceLineNo">420</span> @Override public Iterator<RegionReplicaInfo> iterator() {<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> return Iterators.limit(sourceIterator, scanLimit != null ? scanLimit : SCAN_LIMIT_DEFAULT);<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> }<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> }<a name="line.423"></a> |
| <span class="sourceLineNo">424</span>}<a name="line.424"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
