diff --git hbase-common/src/main/resources/hbase-default.xml hbase-common/src/main/resources/hbase-default.xml index decf490..3b0e8ad 100644 --- hbase-common/src/main/resources/hbase-default.xml +++ hbase-common/src/main/resources/hbase-default.xml @@ -1027,4 +1027,11 @@ possible configurations would overwhelm and obscure the important. HBASE-1936 for more details. + + hbase.rest.filter.classes + org.apache.hadoop.hbase.rest.filter.GzipFilter + + Servlet filters for REST service. + + diff --git hbase-server/src/main/java/org/apache/hadoop/hbase/rest/Constants.java hbase-server/src/main/java/org/apache/hadoop/hbase/rest/Constants.java index 6abdc6c..ec99e08 100644 --- hbase-server/src/main/java/org/apache/hadoop/hbase/rest/Constants.java +++ hbase-server/src/main/java/org/apache/hadoop/hbase/rest/Constants.java @@ -57,4 +57,5 @@ public interface Constants { static final String REST_DNS_NAMESERVER = "hbase.rest.dns.nameserver"; static final String REST_DNS_INTERFACE = "hbase.rest.dns.interface"; + public static final String FILTER_CLASSES = "hbase.rest.filter.classes"; } diff --git hbase-server/src/main/java/org/apache/hadoop/hbase/rest/RESTServer.java hbase-server/src/main/java/org/apache/hadoop/hbase/rest/RESTServer.java index 48bd1ac..7de4d70 100644 --- hbase-server/src/main/java/org/apache/hadoop/hbase/rest/RESTServer.java +++ hbase-server/src/main/java/org/apache/hadoop/hbase/rest/RESTServer.java @@ -28,6 +28,7 @@ import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.apache.commons.cli.PosixParser; +import org.apache.commons.lang.ArrayUtils; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.hadoop.classification.InterfaceAudience; @@ -226,7 +227,13 @@ public class RESTServer implements Constants { context.addFilter(authFilter, "/*", 1); } - context.addFilter(GzipFilter.class, "/*", 0); + // Load filters from configuration. + String[] filterClasses = servlet.getConfiguration().getStrings(FILTER_CLASSES, + ArrayUtils.EMPTY_STRING_ARRAY); + for (String filter : filterClasses) { + filter = filter.trim(); + context.addFilter(Class.forName(filter), "/*", 0); + } // Put up info server. int port = conf.getInt("hbase.rest.info.port", 8085); diff --git hbase-server/src/test/java/org/apache/hadoop/hbase/rest/DummyFilter.java hbase-server/src/test/java/org/apache/hadoop/hbase/rest/DummyFilter.java new file mode 100644 index 0000000..ef53f46 --- /dev/null +++ hbase-server/src/test/java/org/apache/hadoop/hbase/rest/DummyFilter.java @@ -0,0 +1,64 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.hadoop.hbase.rest; + +import java.io.IOException; + +import javax.servlet.Filter; +import javax.servlet.FilterChain; +import javax.servlet.FilterConfig; +import javax.servlet.ServletException; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +public class DummyFilter implements Filter { + private Log LOG = LogFactory.getLog(getClass()); + + @Override + public void destroy() { + } + + @Override + public void doFilter(ServletRequest paramServletRequest, ServletResponse paramServletResponse, + FilterChain paramFilterChain) throws IOException, ServletException { + if (paramServletRequest instanceof HttpServletRequest + && paramServletResponse instanceof HttpServletResponse) { + HttpServletRequest request = (HttpServletRequest) paramServletRequest; + HttpServletResponse response = (HttpServletResponse) paramServletResponse; + + String path = request.getRequestURI(); + LOG.info(path); + if (path.indexOf("/status/cluster") >= 0) { + LOG.info("Blocking cluster status request"); + response.sendError(HttpServletResponse.SC_NOT_FOUND, "Cluster status cannot be requested."); + } else { + paramFilterChain.doFilter(request, response); + } + } + } + + @Override + public void init(FilterConfig filterChain) throws ServletException { + } + +} diff --git hbase-server/src/test/java/org/apache/hadoop/hbase/rest/HBaseRESTTestingUtility.java hbase-server/src/test/java/org/apache/hadoop/hbase/rest/HBaseRESTTestingUtility.java index 3a1b479..8c316dd 100644 --- hbase-server/src/test/java/org/apache/hadoop/hbase/rest/HBaseRESTTestingUtility.java +++ hbase-server/src/test/java/org/apache/hadoop/hbase/rest/HBaseRESTTestingUtility.java @@ -18,6 +18,7 @@ */ package org.apache.hadoop.hbase.rest; +import org.apache.commons.lang.ArrayUtils; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.hadoop.conf.Configuration; @@ -67,7 +68,14 @@ public class HBaseRESTTestingUtility { // set up context Context context = new Context(server, "/", Context.SESSIONS); context.addServlet(sh, "/*"); - context.addFilter(GzipFilter.class, "/*", 0); + // Load filters specified from configuration. + String[] filterClasses = conf.getStrings(Constants.FILTER_CLASSES, + ArrayUtils.EMPTY_STRING_ARRAY); + for (String filter : filterClasses) { + filter = filter.trim(); + context.addFilter(Class.forName(filter), "/*", 0); + } + LOG.info("Loaded filter classes :" + filterClasses); // start the server server.start(); // get the port diff --git hbase-server/src/test/java/org/apache/hadoop/hbase/rest/TestGzipFilter.java hbase-server/src/test/java/org/apache/hadoop/hbase/rest/TestGzipFilter.java index ea0ad9b..23da0ec 100644 --- hbase-server/src/test/java/org/apache/hadoop/hbase/rest/TestGzipFilter.java +++ hbase-server/src/test/java/org/apache/hadoop/hbase/rest/TestGzipFilter.java @@ -19,13 +19,21 @@ package org.apache.hadoop.hbase.rest; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; + import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.util.zip.GZIPInputStream; import java.util.zip.GZIPOutputStream; import org.apache.commons.httpclient.Header; -import org.apache.hadoop.hbase.*; +import org.apache.hadoop.hbase.HBaseTestingUtility; +import org.apache.hadoop.hbase.HColumnDescriptor; +import org.apache.hadoop.hbase.HTableDescriptor; +import org.apache.hadoop.hbase.MediumTests; +import org.apache.hadoop.hbase.TableName; import org.apache.hadoop.hbase.client.Get; import org.apache.hadoop.hbase.client.HBaseAdmin; import org.apache.hadoop.hbase.client.HTable; @@ -33,10 +41,8 @@ import org.apache.hadoop.hbase.client.Result; import org.apache.hadoop.hbase.rest.client.Client; import org.apache.hadoop.hbase.rest.client.Cluster; import org.apache.hadoop.hbase.rest.client.Response; +import org.apache.hadoop.hbase.rest.filter.GzipFilter; import org.apache.hadoop.hbase.util.Bytes; - -import static org.junit.Assert.*; - import org.junit.AfterClass; import org.junit.BeforeClass; import org.junit.Test; @@ -115,6 +121,7 @@ public class TestGzipFilter { is.read(value, 0, VALUE_1.length); assertTrue(Bytes.equals(value, VALUE_1)); is.close(); + table.close(); testScannerResultCodes(); } diff --git hbase-server/src/test/java/org/apache/hadoop/hbase/rest/TestResourceFilter.java hbase-server/src/test/java/org/apache/hadoop/hbase/rest/TestResourceFilter.java new file mode 100644 index 0000000..49bbf22 --- /dev/null +++ hbase-server/src/test/java/org/apache/hadoop/hbase/rest/TestResourceFilter.java @@ -0,0 +1,61 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.hadoop.hbase.rest; + +import static org.junit.Assert.assertEquals; + +import org.apache.hadoop.hbase.HBaseTestingUtility; +import org.apache.hadoop.hbase.SmallTests; +import org.apache.hadoop.hbase.rest.client.Client; +import org.apache.hadoop.hbase.rest.client.Cluster; +import org.apache.hadoop.hbase.rest.client.Response; +import org.junit.AfterClass; +import org.junit.BeforeClass; +import org.junit.Test; +import org.junit.experimental.categories.Category; + +@Category(SmallTests.class) +public class TestResourceFilter { + + private static final HBaseTestingUtility TEST_UTIL = new HBaseTestingUtility(); + private static final HBaseRESTTestingUtility REST_TEST_UTIL = + new HBaseRESTTestingUtility(); + private static Client client; + + @BeforeClass + public static void setUpBeforeClass() throws Exception { + TEST_UTIL.getConfiguration().set(Constants.FILTER_CLASSES, DummyFilter.class.getName()); + TEST_UTIL.startMiniCluster(); + REST_TEST_UTIL.startServletContainer(TEST_UTIL.getConfiguration()); + client = new Client(new Cluster().add("localhost", + REST_TEST_UTIL.getServletPort())); + } + + @AfterClass + public static void tearDownAfterClass() throws Exception { + REST_TEST_UTIL.shutdownServletContainer(); + TEST_UTIL.shutdownMiniCluster(); + } + + @Test + public void testFilter() throws Exception { + String path = "/status/cluster"; + Response response = client.get(path); + assertEquals(404, response.getCode()); + } +}