HBASE-28518 Allow specifying a filter for the REST multiget endpoint …

…(addendum: revert SCAN_FILTER constant name)
apache · Apr 25, 2024 · 944d4c1 · 944d4c1
1 parent 6c6e776
commit 944d4c1
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/Constants.java b/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/Constants.java
@@ -85,7 +85,7 @@ public interface Constants {
   String SCAN_BATCH_SIZE = "batchsize";
   String SCAN_LIMIT = "limit";
   String SCAN_FETCH_SIZE = "hbase.rest.scan.fetchsize";
-  String FILTER = "filter";
+  String SCAN_FILTER = "filter";
   String FILTER_B64 = "filter_b64";
   String SCAN_REVERSED = "reversed";
   String SCAN_CACHE_BLOCKS = "cacheblocks";

diff --git a/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/MultiRowResource.java b/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/MultiRowResource.java
@@ -75,7 +75,7 @@ public MultiRowResource(TableResource tableResource, String versions, String col
   public Response get(final @Context UriInfo uriInfo,
     final @HeaderParam("Encoding") String keyEncodingHeader,
     @QueryParam(Constants.FILTER_B64) @Encoded String paramFilterB64,
-    @QueryParam(Constants.FILTER) String paramFilter) {
+    @QueryParam(Constants.SCAN_FILTER) String paramFilter) {
     MultivaluedMap<String, String> params = uriInfo.getQueryParameters();
     String keyEncoding = (keyEncodingHeader != null)
       ? keyEncodingHeader

diff --git a/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/TableResource.java b/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/TableResource.java
@@ -134,7 +134,7 @@ public TableScanResource getScanResource(final @PathParam("scanspec") String sca
     @DefaultValue(Long.MAX_VALUE + "") @QueryParam(Constants.SCAN_END_TIME) long endTime,
     @DefaultValue("true") @QueryParam(Constants.SCAN_CACHE_BLOCKS) boolean cacheBlocks,
     @DefaultValue("false") @QueryParam(Constants.SCAN_REVERSED) boolean reversed,
-    @QueryParam(Constants.FILTER) String paramFilter,
+    @QueryParam(Constants.SCAN_FILTER) String paramFilter,
     @QueryParam(Constants.FILTER_B64) @Encoded String paramFilterB64) {
     try {
       Filter prefixFilter = null;

diff --git a/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/TestMultiRowResource.java b/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/TestMultiRowResource.java
@@ -369,7 +369,7 @@ public void testMultiCellGetFilterJSON() throws IOException {
     checkMultiCellGetJSON(response);
 
     // Same with non binary clean param
-    positivePath = path.toString() + ("&" + Constants.FILTER + "="
+    positivePath = path.toString() + ("&" + Constants.SCAN_FILTER + "="
       + URLEncoder.encode("PrefixFilter('testrow')", StandardCharsets.UTF_8.name()));
     response = client.get(positivePath, Constants.MIMETYPE_JSON);
     checkMultiCellGetJSON(response);
@@ -381,7 +381,7 @@ public void testMultiCellGetFilterJSON() throws IOException {
     assertEquals(404, response.getCode());
 
     // Same with non binary clean param
-    negativePath = path.toString() + ("&" + Constants.FILTER + "="
+    negativePath = path.toString() + ("&" + Constants.SCAN_FILTER + "="
       + URLEncoder.encode("PrefixFilter('notfound')", StandardCharsets.UTF_8.name()));
     response = client.get(negativePath, Constants.MIMETYPE_JSON);
     assertEquals(404, response.getCode());

diff --git a/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/TestTableScan.java b/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/TestTableScan.java
@@ -450,7 +450,7 @@ public void testSimpleFilter() throws IOException, JAXBException {
     builder.append("&");
     builder.append(Constants.SCAN_END_ROW + "=aay");
     builder.append("&");
-    builder.append(Constants.FILTER + "=" + URLEncoder.encode("PrefixFilter('aab')", "UTF-8"));
+    builder.append(Constants.SCAN_FILTER + "=" + URLEncoder.encode("PrefixFilter('aab')", "UTF-8"));
     Response response = client.get("/" + TABLE + builder.toString(), Constants.MIMETYPE_XML);
     assertEquals(200, response.getCode());
     JAXBContext ctx = JAXBContext.newInstance(CellSetModel.class);
@@ -494,7 +494,7 @@ public void testQualifierAndPrefixFilters() throws IOException, JAXBException {
     builder.append("/abc*");
     builder.append("?");
     builder
-      .append(Constants.FILTER + "=" + URLEncoder.encode("QualifierFilter(=,'binary:1')", "UTF-8"));
+      .append(Constants.SCAN_FILTER + "=" + URLEncoder.encode("QualifierFilter(=,'binary:1')", "UTF-8"));
     Response response = client.get("/" + TABLE + builder.toString(), Constants.MIMETYPE_XML);
     assertEquals(200, response.getCode());
     JAXBContext ctx = JAXBContext.newInstance(CellSetModel.class);
@@ -511,7 +511,7 @@ public void testCompoundFilter() throws IOException, JAXBException {
     StringBuilder builder = new StringBuilder();
     builder.append("/*");
     builder.append("?");
-    builder.append(Constants.FILTER + "="
+    builder.append(Constants.SCAN_FILTER + "="
       + URLEncoder.encode("PrefixFilter('abc') AND QualifierFilter(=,'binary:1')", "UTF-8"));
     Response response = client.get("/" + TABLE + builder.toString(), Constants.MIMETYPE_XML);
     assertEquals(200, response.getCode());
@@ -531,7 +531,7 @@ public void testCustomFilter() throws IOException, JAXBException {
     builder.append("?");
     builder.append(Constants.SCAN_COLUMN + "=" + COLUMN_1);
     builder.append("&");
-    builder.append(Constants.FILTER + "=" + URLEncoder.encode("CustomFilter('abc')", "UTF-8"));
+    builder.append(Constants.SCAN_FILTER + "=" + URLEncoder.encode("CustomFilter('abc')", "UTF-8"));
     Response response = client.get("/" + TABLE + builder.toString(), Constants.MIMETYPE_XML);
     assertEquals(200, response.getCode());
     JAXBContext ctx = JAXBContext.newInstance(CellSetModel.class);
@@ -550,7 +550,7 @@ public void testNegativeCustomFilter() throws IOException, JAXBException {
     builder.append("?");
     builder.append(Constants.SCAN_COLUMN + "=" + COLUMN_1);
     builder.append("&");
-    builder.append(Constants.FILTER + "=" + URLEncoder.encode("CustomFilter('abc')", "UTF-8"));
+    builder.append(Constants.SCAN_FILTER + "=" + URLEncoder.encode("CustomFilter('abc')", "UTF-8"));
     Response response = client.get("/" + TABLE + builder.toString(), Constants.MIMETYPE_XML);
     assertEquals(200, response.getCode());
     JAXBContext ctx = JAXBContext.newInstance(CellSetModel.class);