CounterBasedRateLimiterFilter.java
package server.restful.common.filters;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.UnavailableException;
import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.http.HttpFilter;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.Optional;
import java.util.concurrent.atomic.AtomicInteger;
import static org.apache.http.HttpStatus.SC_TOO_MANY_REQUESTS;
/**
* Ensure a maximum number of requests in parallel (server overload protection).
*
* @author ken
*
*/
@WebFilter(filterName = "CounterBasedRateLimiterFilter", displayName = "CounterBasedRateLimiterFilter",
servletNames = {
"PlaybackServlet",
"SpeechToTextServlet",
"DiskChangeServlet",
"DiskChangeSuggestServlet",
"EndEventServlet",
"EndEventSuggestServlet",
"KeyEventServlet",
"KeyEventSuggestServlet",
"RemoveSessionServlet",
"RandomAutoPlayServlet"}, description = "Ensure a maximum number of requests in parallel (server overload protection)")
public final class CounterBasedRateLimiterFilter extends HttpFilter {
public static final String FILTER_PARAMETER_MAX_REQUESTS_PER_SERVLET = "maxRequestsPerServlet";
private final AtomicInteger atomicServletRequestCounter = new AtomicInteger();
private int maxRequestsPerServlet;
@Override
public void init() throws ServletException {
maxRequestsPerServlet = Integer.parseInt(Optional.ofNullable(getFilterConfig().getInitParameter(FILTER_PARAMETER_MAX_REQUESTS_PER_SERVLET)).orElseThrow(() -> new UnavailableException(FILTER_PARAMETER_MAX_REQUESTS_PER_SERVLET)));
}
@Override
public void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws IOException, ServletException {
try {
if (atomicServletRequestCounter.getAndIncrement() < maxRequestsPerServlet) {
// let the request through and process as usual
chain.doFilter(request, response);
} else {
// handle limit case, e.g., return status code 429 (Too Many Requests)
response.sendError(SC_TOO_MANY_REQUESTS, "Too Many Requests");
}
} finally {
atomicServletRequestCounter.getAndDecrement();
}
}
}