TimeDistanceBasedRateLimiterFilter.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.Map;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;

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

/**
 * Ensure a minimum time between requests (a kind of DDOS protection).
 *
 * @author ken
 *
 */
@WebFilter(filterName = "TimeDistanceBasedRateLimiterFilter", displayName = "TimeDistanceBasedRateLimiterFilter", servletNames = {
        "StartPageServlet"}, description = "Ensure a minimum time between requests (kind of DDOS protection)")
public final class TimeDistanceBasedRateLimiterFilter extends HttpFilter {

    public static final String FILTER_PARAMETER_MIN_TIME_BETWEEN_REQUESTS = "minTimeBetweenRequests";

    private final Map<String, Long> remoteAddrMap = new ConcurrentHashMap<>();
    private int minTimeBetweenRequests;

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

    @Override
    public void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        final Long lastTime = Optional
                .ofNullable(remoteAddrMap.put(request.getRemoteAddr(), System.currentTimeMillis())).orElse(0L);
        if (System.currentTimeMillis() - lastTime > minTimeBetweenRequests) {
            // 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() {
        remoteAddrMap.clear();
    }

}