TimeBasedRateLimiterFilter.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.Timer;
import java.util.TimerTask;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.TimeUnit;

import static org.apache.http.HttpStatus.SC_TOO_MANY_REQUESTS;

/**
 * Ensure a maximum number of requests per minute (server overload protection).
 *
 * @author ken
 *
 */
@WebFilter(filterName = "TimeBasedRateLimiterFilter", displayName = "TimeBasedRateLimiterFilter", servletNames = {
        "StartPageServlet"}, description = "Ensure a maximum number of requests per minute (server overload protection)")
public class TimeBasedRateLimiterFilter extends HttpFilter {

    public static final String FILTER_PARAMETER_MAX_REQUESTS_PER_MINUTE = "maxRequestsPerMinute";

    private final ConcurrentHashMap<String, RequestTimer> requestTimers = new ConcurrentHashMap<>();
    private int maxRequestsPerMinute;

    @Override
    public void init() throws ServletException {
        maxRequestsPerMinute = Integer.parseInt(
                Optional.ofNullable(getFilterConfig().getInitParameter(FILTER_PARAMETER_MAX_REQUESTS_PER_MINUTE))
                        .orElseThrow(() -> new UnavailableException(FILTER_PARAMETER_MAX_REQUESTS_PER_MINUTE)));
    }

    @Override
    public void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        final RequestTimer timer = requestTimers.computeIfAbsent(request.getRemoteAddr(), RequestTimer::new);
        if (timer.increment() < maxRequestsPerMinute) {
            // 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");
        }
    }

    @Override
    public void destroy() {
        requestTimers.values().forEach(RequestTimer::cancel);
    }

    private final class RequestTimer {
        private final Timer timer;
        private int count;

        private RequestTimer(String clientIp) {
            timer = new Timer(TimeBasedRateLimiterFilter.class.getSimpleName() + "-Timer-" + clientIp, false);
            timer.schedule(new TimerTask() {

                @Override
                public void run() {
                    cancel();
                }

                @Override
                public boolean cancel() {
                    requestTimers.remove(clientIp);
                    return super.cancel();
                }

            }, TimeUnit.MINUTES.toMillis(1));
        }

        public int increment() {
            return count++;
        }

        public void cancel() {
            timer.cancel();
        }
    }
}