update Javadoc

planetlevel · planetlevel · commit 52caecb60ef9 · 2008-12-28T02:52:46.000Z
diff --git a/src/main/java/org/owasp/esapi/filters/RequestRateThrottleFilter.java b/src/main/java/org/owasp/esapi/filters/RequestRateThrottleFilter.java
@@ -29,7 +29,11 @@
 import javax.servlet.http.HttpSession;
 
 /**
- * Servlet filter class.
+ * A simple servlet filter that limits the request rate to a certain threshold of requests per second.
+ * The default rate is 5 hits in 10 seconds. This can be overridden in the web.xml file by adding
+ * parameters named "hits" and "period" with the desired values. When the rate is exceeded, a short
+ * string is written to the response output stream and the chain method is not invoked. Otherwise,
+ * processing proceeds as normal.
  */
 public class RequestRateThrottleFilter implements Filter
 {
