Author: markt
Date: Fri Oct  9 16:51:26 2015
New Revision: 1707769

URL: http://svn.apache.org/viewvc?rev=1707769&view=rev
Log:
Servlet 4.0
Add GenericFilter and HttpFilter (not checked with javap yet)

Added:
    tomcat/trunk/java/javax/servlet/GenericFilter.java   (with props)
    tomcat/trunk/java/javax/servlet/HttpFilter.java   (with props)

Added: tomcat/trunk/java/javax/servlet/GenericFilter.java
URL: 
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/GenericFilter.java?rev=1707769&view=auto
==============================================================================
--- tomcat/trunk/java/javax/servlet/GenericFilter.java (added)
+++ tomcat/trunk/java/javax/servlet/GenericFilter.java Fri Oct  9 16:51:26 2015
@@ -0,0 +1,81 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package javax.servlet;
+
+import java.io.Serializable;
+import java.util.Enumeration;
+
+public abstract class GenericFilter implements Filter, FilterConfig, 
Serializable {
+
+    private static final long serialVersionUID = 1L;
+
+    private volatile FilterConfig filterConfig;
+
+
+    @Override
+    public String getFilterName() {
+        return getFilterConfig().getFilterName();
+    }
+
+
+    @Override
+    public ServletContext getServletContext() {
+        return getFilterConfig().getServletContext();
+    }
+
+
+    @Override
+    public String getInitParameter(String name) {
+        return getFilterConfig().getInitParameter(name);
+    }
+
+
+    @Override
+    public Enumeration<String> getInitParameterNames() {
+        return getFilterConfig().getInitParameterNames();
+    }
+
+
+    @Override
+    public void init(FilterConfig filterConfig) throws ServletException {
+        this.filterConfig  = filterConfig;
+        init();
+    }
+
+
+    /**
+     * Obtain the FilterConfig used to initialise this Filter instance.
+     *
+     * @return The config previously passed to the {@link #init(FilterConfig)}
+     *         method
+     */
+    public FilterConfig getFilterConfig() {
+        return filterConfig;
+    }
+
+
+    /**
+     * Convenience method for sub-classes to save them having to call
+     * <code>super.init(config)</code>. This is a NO-OP by default.
+     *
+     * @throws ServletException If an exception occurs that interrupts the
+     *         Filter's normal operation
+     */
+    public void init() throws ServletException {
+        // NO-OP
+    }
+}

Propchange: tomcat/trunk/java/javax/servlet/GenericFilter.java
------------------------------------------------------------------------------
    svn:eol-style = native

Added: tomcat/trunk/java/javax/servlet/HttpFilter.java
URL: 
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/HttpFilter.java?rev=1707769&view=auto
==============================================================================
--- tomcat/trunk/java/javax/servlet/HttpFilter.java (added)
+++ tomcat/trunk/java/javax/servlet/HttpFilter.java Fri Oct  9 16:51:26 2015
@@ -0,0 +1,91 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package javax.servlet;
+
+import java.io.IOException;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+public abstract class HttpFilter extends GenericFilter {
+
+    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.
+     *
+     * @throws ServletException If either the request or response are not of 
the
+     *         expected types or any other error occurs
+     */
+    @Override
+    public void doFilter(ServletRequest request, ServletResponse response, 
FilterChain chain)
+            throws IOException, ServletException {
+        if (!(request instanceof HttpServletRequest)) {
+            throw new ServletException(request + " not HttpServletRequest");
+        }
+        if (!(response instanceof HttpServletResponse)) {
+            throw new ServletException(request + " not HttpServletResponse");
+        }
+        doFilter((HttpServletRequest) request, (HttpServletResponse) response, 
chain);
+    }
+
+
+    /**
+     * 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>
+     * 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 request, HttpServletResponse 
response,
+            FilterChain chain) throws IOException, ServletException {
+        chain.doFilter(request, response);
+    }
+}

Propchange: tomcat/trunk/java/javax/servlet/HttpFilter.java
------------------------------------------------------------------------------
    svn:eol-style = native



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org

Reply via email to