You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by li...@apache.org on 2023/03/07 07:20:08 UTC
[tomcat] branch main updated: Revert "Align with spec"
This is an automated email from the ASF dual-hosted git repository.
lihan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/main by this push:
new e020b669a5 Revert "Align with spec"
e020b669a5 is described below
commit e020b669a5792a64c79eedb75751907aee2aa4d3
Author: lihan <li...@apache.org>
AuthorDate: Tue Mar 7 15:18:10 2023 +0800
Revert "Align with spec"
This reverts commit 1fc4b7c95dce1db3d86db9393c78023b93725f63.
---
java/jakarta/servlet/http/HttpFilter.java | 130 ++++++++++--------------------
1 file changed, 44 insertions(+), 86 deletions(-)
diff --git a/java/jakarta/servlet/http/HttpFilter.java b/java/jakarta/servlet/http/HttpFilter.java
index 14d14b35b0..4c7154bea6 100644
--- a/java/jakarta/servlet/http/HttpFilter.java
+++ b/java/jakarta/servlet/http/HttpFilter.java
@@ -25,105 +25,63 @@ import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
/**
- *
- * <p>
- * Provides an abstract class to be subclassed to create an HTTP filter suitable for a Web site. A subclass of
- * <code>HttpFilter</code> should override
- * {@link #doFilter(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, jakarta.servlet.FilterChain) }.
- * </p>
- *
- * <p>
- * Filters typically run on multithreaded servers, so be aware that a filter must handle concurrent requests and be
- * careful to synchronize access to shared resources. Shared resources include in-memory data such as instance or class
- * variables and external objects such as files, database connections, and network connections. See the
- * <a href="https://docs.oracle.com/javase/tutorial/essential/concurrency/"> Java Tutorial on Multithreaded
- * Programming</a> for more information on handling multiple threads in a Java program.
- *
- * @author Various
- *
- * @since Servlet 4.0
+ * Provides a base class that implements the Filter interface and ensures that the Request and Response are of type
+ * HttpServletRequest and HttpServletResponse respectively.
*/
public abstract class HttpFilter extends GenericFilter {
- private static final long serialVersionUID = 7478463438252262094L;
-
- /**
- * <p>
- * Does nothing, because this is an abstract class.
- * </p>
- *
- * @since Servlet 4.0
- */
- public HttpFilter() {
- }
+ private static final long serialVersionUID = 1L;
/**
+ * {@inheritDoc} This implementation tests the request and response to see if they are instances of
+ * {@link HttpServletRequest} and {@link HttpServletResponse} respectively. If they are then they are passed to
+ * {@link #doFilter(HttpServletRequest, HttpServletResponse, FilterChain)}. If not, a {@link ServletException} is
+ * thrown.
*
- * <p>
- * The <code>doFilter</code> method of the Filter is called by the container each time a request/response pair is passed
- * through the chain due to a client request for a resource at the end of the chain. The FilterChain passed in to this
- * method allows the Filter to pass on the request and response to the next entity in the chain. There's no need to
- * override this method.
- * </p>
- *
- * <p>
- * The default implementation inspects the incoming {@code req} and {@code res} objects to determine if they are
- * instances of {@link HttpServletRequest} and {@link HttpServletResponse}, respectively. If not, a
- * {@link ServletException} is thrown. Otherwise, the protected
- * {@link #doFilter(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, jakarta.servlet.FilterChain)}
- * method is called.
- * </p>
- *
- * @param req a {@link ServletRequest} object that contains the request the client has made of the filter
- *
- * @param res a {@link ServletResponse} object that contains the response the filter sends to the client
- *
- * @param chain the <code>FilterChain</code> for invoking the next filter or the resource
- *
- * @throws IOException if an input or output error is detected when the filter handles the request
- *
- * @throws ServletException if the request for the could not be handled or either parameter is not an instance of the
- * respective {@link HttpServletRequest} or {@link HttpServletResponse}.
- *
- * @since Servlet 4.0
+ * @throws ServletException If either the request or response are not of the expected types or any other error
+ * occurs
*/
@Override
- public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain)
- throws IOException, ServletException {
- if (!(req instanceof HttpServletRequest && res instanceof HttpServletResponse)) {
- throw new ServletException("non-HTTP request or response");
+ public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
+ throws IOException, ServletException {
+ if (!(request instanceof HttpServletRequest)) {
+ throw new ServletException(request + " not HttpServletRequest");
}
-
- this.doFilter((HttpServletRequest) req, (HttpServletResponse) res, chain);
+ if (!(response instanceof HttpServletResponse)) {
+ throw new ServletException(request + " not HttpServletResponse");
+ }
+ doFilter((HttpServletRequest) request, (HttpServletResponse) response, chain);
}
+
/**
- *
- * <p>
- * The <code>doFilter</code> method of the Filter is called by the container each time a request/response pair is passed
- * through the chain due to a client request for a resource at the end of the chain. The FilterChain passed in to this
- * method allows the Filter to pass on the request and response to the next entity in the chain.
- * </p>
- *
+ * The <code>doFilter</code> method of the Filter is called by the container each time a request/response pair is
+ * passed through the chain due to a client request for a resource at the end of the chain. The FilterChain passed
+ * in to this method allows the Filter to pass on the request and response to the next entity in the chain.
* <p>
- * The default implementation simply calls {@link FilterChain#doFilter}
- * </p>
- *
- * @param req a {@link HttpServletRequest} object that contains the request the client has made of the filter
- *
- * @param res a {@link HttpServletResponse} object that contains the response the filter sends to the client
- *
- * @param chain the <code>FilterChain</code> for invoking the next filter or the resource
- *
- * @throws IOException if an input or output error is detected when the filter handles the request
- *
- * @throws ServletException if the request for the could not be handled
- *
- * @since Servlet 4.0
+ * A typical implementation of this method would follow the following pattern:- <br>
+ * 1. Examine the request<br>
+ * 2. Optionally wrap the request object with a custom implementation to filter content or headers for input
+ * filtering <br>
+ * 3. Optionally wrap the response object with a custom implementation to filter content or headers for output
+ * filtering <br>
+ * 4. a) <strong>Either</strong> invoke the next entity in the chain using the FilterChain object
+ * (<code>chain.doFilter()</code>), <br>
+ * 4. b) <strong>or</strong> not pass on the request/response pair to the next entity in the filter chain to block
+ * the request processing<br>
+ * 5. Directly set headers on the response after invocation of the next entity in the filter chain. This default
+ * implementation simply calls the next filter in the filter chain.
+ *
+ * @param request The request to process
+ * @param response The response associated with the request
+ * @param chain Provides access to the next filter in the chain for this filter to pass the request and response
+ * to for further processing
+ *
+ * @throws IOException if an I/O error occurs during this filter's processing of the request
+ * @throws ServletException if the processing fails for any other reason
*/
- protected void doFilter(HttpServletRequest req, HttpServletResponse res, FilterChain chain)
- throws IOException, ServletException {
- chain.doFilter(req, res);
+ protected void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
+ throws IOException, ServletException {
+ chain.doFilter(request, response);
}
-
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org