From 146a0fb8b0e90f9196e569152f649baf60d6cc8f Mon Sep 17 00:00:00 2001
From: Joaquín Reñé <jrene@curisit.net>
Date: Tue, 07 Oct 2025 14:52:57 +0000
Subject: [PATCH] #4410 - Comments on classes
---
securis/src/main/java/net/curisit/securis/GzipFilter.java | 21 +++++++++++++++++++++
1 files changed, 21 insertions(+), 0 deletions(-)
diff --git a/securis/src/main/java/net/curisit/securis/GzipFilter.java b/securis/src/main/java/net/curisit/securis/GzipFilter.java
index a8ceaee..9b153f2 100644
--- a/securis/src/main/java/net/curisit/securis/GzipFilter.java
+++ b/securis/src/main/java/net/curisit/securis/GzipFilter.java
@@ -1,3 +1,6 @@
+/*
+ * Copyright @ 2013 CurisTEC, S.A.S. All Rights Reserved.
+ */
package net.curisit.securis;
import java.io.IOException;
@@ -18,6 +21,12 @@
import net.curisit.securis.utils.GZipServletResponseWrapper;
+/**
+* GzipFilter
+* <p>
+* Servlet filter that compresses <code>*.js</code> responses with GZIP when the client
+* advertises <code>Accept-Encoding: gzip</code>.
+*/
@ApplicationScoped
@WebFilter(urlPatterns = "*.js")
public class GzipFilter implements Filter {
@@ -25,10 +34,16 @@
@SuppressWarnings("unused")
private static final Logger LOG = LogManager.getLogger(GzipFilter.class);
+ /** init<p>Filter init hook (unused). */
@Override
public void init(FilterConfig fc) throws ServletException {
}
+ /**
+ * doFilter
+ * <p>
+ * Wrap the response with a GZIP-compressing wrapper if supported by the client.
+ */
@Override
public void doFilter(ServletRequest sreq, ServletResponse sres, FilterChain chain) throws IOException, ServletException {
HttpServletRequest httpRequest = (HttpServletRequest) sreq;
@@ -44,12 +59,18 @@
}
}
+ /**
+ * acceptsGZipEncoding
+ * <p>
+ * @return {@code true} when request header contains "gzip" in <code>Accept-Encoding</code>.
+ */
private boolean acceptsGZipEncoding(HttpServletRequest httpRequest) {
String acceptEncoding = httpRequest.getHeader("Accept-Encoding");
return acceptEncoding != null && acceptEncoding.indexOf("gzip") != -1;
}
+ /** destroy<p>Filter destroy hook (unused). */
@Override
public void destroy() {
}
--
Gitblit v1.3.2