You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2010/01/17 11:37:17 UTC

svn commit: r900088 - in /tomcat/trunk/java/org/apache/catalina: Context.java core/ApplicationContext.java core/ApplicationFilterRegistration.java core/LocalStrings.properties

Author: markt
Date: Sun Jan 17 10:37:17 2010
New Revision: 900088

URL: http://svn.apache.org/viewvc?rev=900088&view=rev
Log:
Servlet 3.0. Implement ServletContext.addFilter(String,String)

Added:
    tomcat/trunk/java/org/apache/catalina/core/ApplicationFilterRegistration.java   (with props)
Modified:
    tomcat/trunk/java/org/apache/catalina/Context.java
    tomcat/trunk/java/org/apache/catalina/core/ApplicationContext.java
    tomcat/trunk/java/org/apache/catalina/core/LocalStrings.properties

Modified: tomcat/trunk/java/org/apache/catalina/Context.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Context.java?rev=900088&r1=900087&r2=900088&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Context.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Context.java Sun Jan 17 10:37:17 2010
@@ -500,6 +500,17 @@
      */
     public void addFilterMap(FilterMap filterMap);
 
+    /**
+     * Add a filter mapping to this Context before the mappings defined in the
+     * deployment descriptor but after any other mappings added via this method.
+     *
+     * @param filterMap The filter mapping to be added
+     *
+     * @exception IllegalArgumentException if the specified filter name
+     *  does not match an existing filter definition, or the filter mapping
+     *  is malformed
+     */
+    public void addFilterMapBefore(FilterMap filterMap);
 
     /**
      * Add the classname of an InstanceListener to be added to each

Modified: tomcat/trunk/java/org/apache/catalina/core/ApplicationContext.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/core/ApplicationContext.java?rev=900088&r1=900087&r2=900088&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/core/ApplicationContext.java (original)
+++ tomcat/trunk/java/org/apache/catalina/core/ApplicationContext.java Sun Jan 17 10:37:17 2010
@@ -54,6 +54,7 @@
 import org.apache.catalina.Wrapper;
 import org.apache.catalina.connector.Connector;
 import org.apache.catalina.deploy.ApplicationParameter;
+import org.apache.catalina.deploy.FilterDef;
 import org.apache.catalina.util.Enumerator;
 import org.apache.catalina.util.RequestUtil;
 import org.apache.catalina.util.ResourceSet;
@@ -816,7 +817,7 @@
 
 
     public FilterRegistration.Dynamic addFilter(String filterName,
-            String className) throws IllegalStateException {
+            String filterClass) throws IllegalStateException {
         
         if (context.initialized) {
             //TODO Spec breaking enhancement to ignore this restriction
@@ -825,12 +826,23 @@
                             getContextPath()));
         }
         
-        if (context.findFilterDef(filterName) != null) {
-            return null;
+        FilterDef filterDef = context.findFilterDef(filterName);
+        
+        // Assume a 'complete' FilterRegistration is one that has a class and
+        // a name
+        if (filterDef == null) {
+            filterDef = new FilterDef();
+        } else {
+            if (filterDef.getFilterName() != null &&
+                    filterDef.getFilterClass() != null) {
+                return null;
+            }
         }
 
-        // TODO SERVLET3
-        return null;
+        // Name must already be set
+        filterDef.setFilterClass(filterClass);
+        
+        return new ApplicationFilterRegistration(filterDef, context);
     }
 
     

Added: tomcat/trunk/java/org/apache/catalina/core/ApplicationFilterRegistration.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/core/ApplicationFilterRegistration.java?rev=900088&view=auto
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/core/ApplicationFilterRegistration.java (added)
+++ tomcat/trunk/java/org/apache/catalina/core/ApplicationFilterRegistration.java Sun Jan 17 10:37:17 2010
@@ -0,0 +1,210 @@
+/*
+ * 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 org.apache.catalina.core;
+
+import java.util.Collection;
+import java.util.EnumSet;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import javax.servlet.DispatcherType;
+import javax.servlet.FilterRegistration;
+
+import org.apache.catalina.Context;
+import org.apache.catalina.deploy.FilterDef;
+import org.apache.catalina.deploy.FilterMap;
+import org.apache.catalina.util.ParameterMap;
+import org.apache.tomcat.util.res.StringManager;
+
+public class ApplicationFilterRegistration
+        implements FilterRegistration.Dynamic {
+
+    /**
+     * The string manager for this package.
+     */
+    private static final StringManager sm =
+      StringManager.getManager(Constants.Package);
+    
+    private FilterDef filterDef;
+    private Context context;
+    
+    public ApplicationFilterRegistration(FilterDef filterDef,
+            Context context) {
+        this.filterDef = filterDef;
+        this.context = context;
+        
+    }
+
+    @Override
+    public void addMappingForServletNames(
+            EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter,
+            String... servletNames) {
+
+        FilterMap filterMap = new FilterMap();
+        
+        if (dispatcherTypes != null) {
+            for (DispatcherType dispatcherType : dispatcherTypes) {
+                filterMap.setDispatcher(dispatcherType.name());
+            }
+        }
+        
+        if (servletNames != null) {
+            for (String servletName : servletNames) {
+                filterMap.addServletName(servletName);
+            }
+        
+            if (isMatchAfter) {
+                context.addFilterMapBefore(filterMap);
+            } else {
+                context.addFilterMap(filterMap);
+            }
+        }
+        // else error?
+    }
+
+    @Override
+    public void addMappingForUrlPatterns(
+            EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter,
+            String... urlPatterns) {
+
+        FilterMap filterMap = new FilterMap();
+        
+        if (dispatcherTypes != null) {
+            for (DispatcherType dispatcherType : dispatcherTypes) {
+                filterMap.setDispatcher(dispatcherType.name());
+            }
+        }
+        
+        if (urlPatterns != null) {
+            for (String urlPattern : urlPatterns) {
+                filterMap.addURLPattern(urlPattern);
+            }
+        
+            if (isMatchAfter) {
+                context.addFilterMapBefore(filterMap);
+            } else {
+                context.addFilterMap(filterMap);
+            }
+        }
+        // else error?
+        
+    }
+
+    @Override
+    public Collection<String> getServletNameMappings() {
+        Collection<String> result = new HashSet<String>();
+        
+        FilterMap[] filterMaps = context.findFilterMaps();
+        
+        for (FilterMap filterMap : filterMaps) {
+            if (filterMap.getFilterName().equals(filterDef.getFilterName())) {
+                for (String servletName : filterMap.getServletNames()) {
+                    result.add(servletName);
+                }
+            }
+        }
+        return result;
+    }
+
+    @Override
+    public Collection<String> getUrlPatternMappings() {
+        Collection<String> result = new HashSet<String>();
+        
+        FilterMap[] filterMaps = context.findFilterMaps();
+        
+        for (FilterMap filterMap : filterMaps) {
+            if (filterMap.getFilterName().equals(filterDef.getFilterName())) {
+                for (String urlPattern : filterMap.getURLPatterns()) {
+                    result.add(urlPattern);
+                }
+            }
+        }
+        return result;
+    }
+
+    @Override
+    public String getClassName() {
+        return filterDef.getFilterClass();
+   }
+
+    @Override
+    public String getInitParameter(String name) {
+        return filterDef.getParameterMap().get(name);
+    }
+
+    @Override
+    public Map<String, String> getInitParameters() {
+        ParameterMap<String,String> result = new ParameterMap<String,String>();
+        result.putAll(filterDef.getParameterMap());
+        result.setLocked(true);
+        return result;
+    }
+
+    @Override
+    public String getName() {
+        return filterDef.getFilterName();
+    }
+
+    @Override
+    public boolean setInitParameter(String name, String value) {
+        if (name == null || value == null) {
+            throw new IllegalArgumentException(
+                    sm.getString("applicationFilterRegistration.nullInitParam",
+                            name, value));
+        }
+        if (getInitParameter(name) != null) {
+            return false;
+        }
+        
+        filterDef.addInitParameter(name, value);
+
+        return true;
+    }
+
+    @Override
+    public Set<String> setInitParameters(Map<String, String> initParameters) {
+        
+        Set<String> conflicts = new HashSet<String>();
+        
+        for (Map.Entry<String, String> entry : initParameters.entrySet()) {
+            if (entry.getKey() == null || entry.getValue() == null) {
+                throw new IllegalArgumentException(sm.getString(
+                        "applicationFilterRegistration.nullInitParams",
+                                entry.getKey(), entry.getValue()));
+            }
+            if (getInitParameter(entry.getKey()) != null) {
+                conflicts.add(entry.getKey());
+            }
+        }
+
+        // Have to add in a separate loop since spec requires no updates at all
+        // if there is an issue
+        for (Map.Entry<String, String> entry : initParameters.entrySet()) {
+            setInitParameter(entry.getKey(), entry.getValue());
+        }
+        
+        return conflicts;
+    }
+
+    @Override
+    public void setAsyncSupported(boolean asyncSupported) {
+        filterDef.setAsyncSupported(Boolean.valueOf(asyncSupported).toString());
+    }
+    
+}

Propchange: tomcat/trunk/java/org/apache/catalina/core/ApplicationFilterRegistration.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: tomcat/trunk/java/org/apache/catalina/core/ApplicationFilterRegistration.java
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision

Modified: tomcat/trunk/java/org/apache/catalina/core/LocalStrings.properties
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/core/LocalStrings.properties?rev=900088&r1=900087&r2=900088&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/core/LocalStrings.properties (original)
+++ tomcat/trunk/java/org/apache/catalina/core/LocalStrings.properties Sun Jan 17 10:37:17 2010
@@ -36,6 +36,8 @@
 applicationFilterConfig.jmxRegisterFail=JMX registration failed for filter of type [{0}] and name [{1}]
 applicationFilterConfig.jmxUnregister=JMX de-registration complete for filter of type [{0}] and name [{1}]
 applicationFilterConfig.jmxUnregisterFail=JMX de-registration failed for filter of type [{0}] and name [{1}]
+applicationFilterRegistration.nullInitParam=Unable to set initialisation parameter for filter due to null name and/or value. Name [{0}], Value [{1}]
+applicationFilterRegistration.nullInitParam=Unable to set initialisation parameters for filter due to null name and/or value. Name [{0}], Value [{1}]
 applicationRequest.badParent=Cannot locate parent Request implementation
 applicationRequest.badRequest=Request is not a javax.servlet.ServletRequestWrapper
 applicationResponse.badParent=Cannot locate parent Response implementation



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