Checkstyle fixes for prov eelf and utils
[dmaap/datarouter.git] / datarouter-prov / src / main / java / org / onap / dmaap / datarouter / provisioning / utils / ThrottleFilter.java
index da06f6b..659dbac 100644 (file)
@@ -61,8 +61,8 @@ import org.onap.dmaap.datarouter.provisioning.beans.Parameters;
  * If the action is missing, it defaults to <i>drop</i>.\r
  * </td></tr>\r
  * </table>\r
- * <p>\r
- * The <i>action</i> is triggered iff:\r
+ *\r
+ * <p>* The <i>action</i> is triggered iff:\r
  * <ol>\r
  * <li>the filter is enabled, and</li>\r
  * <li>N /publish requests come to the provisioning server in M minutes\r
@@ -76,7 +76,8 @@ import org.onap.dmaap.datarouter.provisioning.beans.Parameters;
  * The action that can be performed (if triggered) are:\r
  * <ol>\r
  * <li><i>drop</i> - the connection is dropped immediately.</li>\r
- * <li><i>throttle</i> - [not supported] the connection is put into a low priority queue with all other throttled connections.\r
+ * <li><i>throttle</i> - [not supported] the connection is put into a low priority queue\r
+ * with all other throttled connections.\r
  * These are then processed at a slower rate.  Note: this option does not work correctly, and is disabled.\r
  * The only action that is supported is <i>drop</i>.\r
  * </li>\r
@@ -85,6 +86,7 @@ import org.onap.dmaap.datarouter.provisioning.beans.Parameters;
  * @author Robert Eby\r
  * @version $Id: ThrottleFilter.java,v 1.2 2014/03/12 19:45:41 eby Exp $\r
  */\r
+\r
 public class ThrottleFilter extends TimerTask implements Filter {\r
     private static final int DEFAULT_N = 10;\r
     private static final int DEFAULT_M = 5;\r
@@ -111,27 +113,30 @@ public class ThrottleFilter extends TimerTask implements Filter {
     }\r
 \r
     /**\r
-     * Configure the throttle.  This should be called from BaseServlet.provisioningParametersChanged(), to make sure it stays up to date.\r
+     * Configure the throttle.  This should be called from BaseServlet.provisioningParametersChanged(),\r
+     * to make sure it stays up to date.\r
      */\r
     public static void configure() {\r
-        Parameters p = Parameters.getParameter(Parameters.THROTTLE_FILTER);\r
-        if (p != null) {\r
+        Parameters param = Parameters.getParameter(Parameters.THROTTLE_FILTER);\r
+        if (param != null) {\r
             try {\r
                 Class.forName(JETTY_REQUEST);\r
-                String v = p.getValue();\r
-                if (v != null && !"off".equals(v)) {\r
-                    String[] pp = v.split(",");\r
+                String val = param.getValue();\r
+                if (val != null && !"off".equals(val)) {\r
+                    String[] pp = val.split(",");\r
                     if (pp != null) {\r
                         numRequests = (pp.length > 0) ? getInt(pp[0], DEFAULT_N) : DEFAULT_N;\r
                         samplingPeriod = (pp.length > 1) ? getInt(pp[1], DEFAULT_M) : DEFAULT_M;\r
-                        action = (pp.length > 2 && pp[2] != null && "throttle".equalsIgnoreCase(pp[2])) ? ACTION_THROTTLE : ACTION_DROP;\r
+                        action = (pp.length > 2 && pp[2] != null\r
+                                          && "throttle".equalsIgnoreCase(pp[2])) ? ACTION_THROTTLE : ACTION_DROP;\r
                         enabled = true;\r
                         // ACTION_THROTTLE is not currently working, so is not supported\r
                         if (action == ACTION_THROTTLE) {\r
                             action = ACTION_DROP;\r
                             logger.info("Throttling is not currently supported; action changed to DROP");\r
                         }\r
-                        logger.info("ThrottleFilter is ENABLED for /publish requests; N=" + numRequests + ", M=" + samplingPeriod\r
+                        logger.info("ThrottleFilter is ENABLED for /publish requests; N="\r
+                                            + numRequests + ", M=" + samplingPeriod\r
                             + ", Action=" + action);\r
                         return;\r
                     }\r
@@ -145,9 +150,9 @@ public class ThrottleFilter extends TimerTask implements Filter {
         map.clear();\r
     }\r
 \r
-    private static int getInt(String s, int deflt) {\r
+    private static int getInt(String str, int deflt) {\r
         try {\r
-            return Integer.parseInt(s);\r
+            return Integer.parseInt(str);\r
         } catch (NumberFormatException x) {\r
             return deflt;\r
         }\r
@@ -171,14 +176,23 @@ public class ThrottleFilter extends TimerTask implements Filter {
         }\r
     }\r
 \r
+    /**\r
+     * Method to drop filter chain.\r
+     * @param request HttpServletRequest\r
+     * @param response HttpServletResponse\r
+     * @param chain FilterChain\r
+     * @throws IOException input/output exception\r
+     * @throws ServletException servle exception\r
+     */\r
     public void dropFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)\r
             throws IOException, ServletException {\r
         int rate = getRequestRate(request);\r
         if (rate >= numRequests) {\r
             // drop request - only works under Jetty\r
-            String m = String.format("Dropping connection: %s %d bad connections in %d minutes", getConnectionId(request), rate,\r
+            String str = String.format("Dropping connection: %s %d bad connections in %d minutes",\r
+                    getConnectionId(request), rate,\r
                 samplingPeriod);\r
-            logger.info(m);\r
+            logger.info(str);\r
             Request baseRequest = (request instanceof Request)\r
                     ? (Request) request\r
                     : HttpConnection.getCurrentConnection().getHttpChannel().getRequest();\r
@@ -195,9 +209,9 @@ public class ThrottleFilter extends TimerTask implements Filter {
         int rate = getRequestRate(request);\r
         Object results = request.getAttribute(THROTTLE_MARKER);\r
         if (rate >= numRequests && results == null) {\r
-            String m = String.format("Throttling connection: %s %d bad connections in %d minutes",\r
+            String str = String.format("Throttling connection: %s %d bad connections in %d minutes",\r
                 getConnectionId(request), rate, samplingPeriod);\r
-            logger.info(m);\r
+            logger.info(str);\r
             Continuation continuation = ContinuationSupport.getContinuation(request);\r
             continuation.suspend();\r
             register(id, continuation);\r
@@ -206,10 +220,10 @@ public class ThrottleFilter extends TimerTask implements Filter {
             chain.doFilter(request, response);\r
             @SuppressWarnings("resource")\r
             InputStream is = request.getInputStream();\r
-            byte[] b = new byte[4096];\r
-            int n = is.read(b);\r
-            while (n > 0) {\r
-                n = is.read(b);\r
+            byte[] bite = new byte[4096];\r
+            int num = is.read(bite);\r
+            while (num > 0) {\r
+                num = is.read(bite);\r
             }\r
             resume(id);\r
         }\r
@@ -249,8 +263,9 @@ public class ThrottleFilter extends TimerTask implements Filter {
      */\r
     private int getRequestRate(HttpServletRequest request) {\r
         String expecthdr = request.getHeader("Expect");\r
-        if (expecthdr != null && "100-continue".equalsIgnoreCase(expecthdr))\r
+        if (expecthdr != null && "100-continue".equalsIgnoreCase(expecthdr)) {\r
             return 0;\r
+        }\r
 \r
         String key = getConnectionId(request);\r
         synchronized (map) {\r
@@ -266,13 +281,17 @@ public class ThrottleFilter extends TimerTask implements Filter {
     public class Counter {\r
         private List<Long> times = new ArrayList<>();    // a record of request times\r
 \r
+        /**\r
+         * Method to prune request rate.\r
+         * @return times\r
+         */\r
         public int prune() {\r
             try {\r
-                long n = System.currentTimeMillis() - (samplingPeriod * ONE_MINUTE);\r
-                long t = times.get(0);\r
-                while (t < n) {\r
+                long num = System.currentTimeMillis() - (samplingPeriod * ONE_MINUTE);\r
+                long time = times.get(0);\r
+                while (time < num) {\r
                     times.remove(0);\r
-                    t = times.get(0);\r
+                    time = times.get(0);\r
                 }\r
             } catch (IndexOutOfBoundsException e) {\r
                 logger.trace("Exception: " + e.getMessage(), e);\r
@@ -295,12 +314,14 @@ public class ThrottleFilter extends TimerTask implements Filter {
 \r
     private int getFeedId(HttpServletRequest req) {\r
         String path = req.getPathInfo();\r
-        if (path == null || path.length() < 2)\r
+        if (path == null || path.length() < 2) {\r
             return -1;\r
+        }\r
         path = path.substring(1);\r
         int ix = path.indexOf('/');\r
-        if (ix < 0 || ix == path.length() - 1)\r
+        if (ix < 0 || ix == path.length() - 1) {\r
             return -2;\r
+        }\r
         try {\r
             return Integer.parseInt(path.substring(0, ix));\r
         } catch (NumberFormatException e) {\r
@@ -313,9 +334,10 @@ public class ThrottleFilter extends TimerTask implements Filter {
         // Once every 5 minutes, go through the map, and remove empty entrys\r
         for (Object s : map.keySet().toArray()) {\r
             synchronized (map) {\r
-                Counter c = map.get(s);\r
-                if (c.prune() <= 0)\r
+                Counter counter = map.get(s);\r
+                if (counter.prune() <= 0) {\r
                     map.remove(s);\r
+                }\r
             }\r
         }\r
     }\r