You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by ma...@apache.org on 2011/05/06 20:08:07 UTC

svn commit: r1100307 - in /myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified: ResolverBuilderBase.java ResolverBuilderForFaces.java ResolverBuilderForJSP.java

Author: martinkoci
Date: Fri May  6 18:08:06 2011
New Revision: 1100307

URL: http://svn.apache.org/viewvc?rev=1100307&view=rev
Log:
MYFACES-3075 Allow ELResolvers filtering

Modified:
    myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java
    myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderForFaces.java
    myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderForJSP.java

Modified: myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java?rev=1100307&r1=1100306&r2=1100307&view=diff
==============================================================================
--- myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java (original)
+++ myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java Fri May  6 18:08:06 2011
@@ -31,10 +31,13 @@ import javax.faces.context.FacesContext;
 import javax.faces.el.PropertyResolver;
 import javax.faces.el.VariableResolver;
 
+import org.apache.commons.collections.CollectionUtils;
+import org.apache.commons.collections.Predicate;
 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFWebConfigParam;
 import org.apache.myfaces.config.RuntimeConfig;
 import org.apache.myfaces.el.convert.PropertyResolverToELResolver;
 import org.apache.myfaces.el.convert.VariableResolverToELResolver;
+import org.apache.myfaces.el.unified.resolver.FacesCompositeELResolver.Scope;
 import org.apache.myfaces.shared_impl.util.ClassUtils;
 
 /**
@@ -51,6 +54,12 @@ public class ResolverBuilderBase
             desc = "The Class of an Comparator<ELResolver> implementation.")
     public static final String EL_RESOLVER_COMPARATOR = "org.apache.myfaces.EL_RESOLVER_COMPARATOR";
     
+    @JSFWebConfigParam(since = "2.1.0",
+            desc="The Class of an org.apache.commons.collections.Predicate<ELResolver> implementation." +
+            "If used and returns true for a ELResolver instance, such resolver will not be installed in ELResolvers chain." +
+            "Use with caution - can break functionality defined in JSF specification 'ELResolver Instances Provided by Faces'")
+    public static final String EL_RESOLVER_PREDICATE = "org.apache.myfaces.EL_RESOLVER_PREDICATE";
+    
     private final RuntimeConfig _config;
 
     public ResolverBuilderBase(RuntimeConfig config)
@@ -105,50 +114,99 @@ public class ResolverBuilderBase
     /**
      * Sort the ELResolvers with a custom Comparator provided by the user.
      * @param resolvers
+     * @param scope scope of ELResolvers (Faces,JSP)  
      * @since 1.2.10, 2.0.2
      */
     @SuppressWarnings("unchecked")
-    protected void sortELResolvers(List<ELResolver> resolvers)
+    protected void sortELResolvers(List<ELResolver> resolvers, Scope scope)
+    {
+        Comparator<ELResolver> comparator = (Comparator<ELResolver>) getAplicationScopedObject(
+                FacesContext.getCurrentInstance(), EL_RESOLVER_COMPARATOR);
+        if (comparator != null)
+        {
+            try
+            {
+                // sort the resolvers
+                Collections.sort(resolvers, comparator);
+                
+                if (log.isLoggable(Level.INFO)) {
+                    log.log(Level.INFO, "Chain of EL resolvers for {0} sorted with: {1} and the result order is {2}", 
+                            new Object [] {scope, comparator, resolvers});
+                }
+            }
+            catch (Exception e)
+            {
+                log.log(Level.WARNING, 
+                        "Could not sort ELResolvers with custom Comparator", e);
+            }
+        }
+    }
+    
+    /**
+     * Filters the ELResolvers  with a custom Predicate provided by the user.
+     * @param resolvers list of ELResolvers
+     * @param scope scope of ELResolvers (Faces,JSP)
+     * @return Iterable instance of Iterable containing filtered ELResolvers 
+     */
+    protected Iterable<ELResolver> filterELResolvers(List<ELResolver> resolvers, Scope scope)
     {
-        ExternalContext externalContext 
-                = FacesContext.getCurrentInstance().getExternalContext();
-        
-        String comparatorClass = externalContext
-                .getInitParameter(EL_RESOLVER_COMPARATOR);
         
-        if (comparatorClass != null && !"".equals(comparatorClass))
+        Predicate predicate = (Predicate) getAplicationScopedObject(
+                FacesContext.getCurrentInstance(), EL_RESOLVER_PREDICATE);
+        if (predicate != null) {
+            try
+            {
+                // filter the resolvers
+                CollectionUtils.filter(resolvers, predicate);
+                
+                if (log.isLoggable(Level.INFO)) {
+                    log.log(Level.INFO, "Chain of EL resolvers for {0} filtered with: {1} and the result is {2}", 
+                            new Object [] {scope, predicate, resolvers});
+                }
+            }
+            catch (Exception e)
+            {
+                log.log(Level.WARNING, 
+                        "Could not filter ELResolvers with custom Predicate", e);
+            }
+        }
+        return resolvers;
+    }
+    
+    // TODO this is very common logic, move to Utils? 
+    protected Object getAplicationScopedObject(FacesContext facesContext, String initParameterName)
+    {
+        ExternalContext externalContext = facesContext.getExternalContext();
+        String className = externalContext.getInitParameter(initParameterName);
+
+        Object applicationScopedObject = null;
+        if (className != null && !"".equals(className))
         {
-            // the user provided the parameter.
-            
             // if we already have a cached instance, use it
-            Comparator<ELResolver> comparator 
-                    = (Comparator<ELResolver>) externalContext.
-                        getApplicationMap().get(EL_RESOLVER_COMPARATOR);
+            applicationScopedObject = externalContext. getApplicationMap().get(initParameterName);
             try
             {
-                if (comparator == null)
+                if (applicationScopedObject == null)
                 {
-                    // get the comparator class
-                    Class<Comparator<ELResolver>> clazz 
-                             = ClassUtils.classForName(comparatorClass);
-                    
+                    // get the  class
+                    Class<?> clazz = ClassUtils.classForName(className);
+
                     // create the instance
-                    comparator = clazz.newInstance();
-                    
+                    applicationScopedObject = clazz.newInstance();
+
                     // cache the instance, because it will be used at least two times
                     externalContext.getApplicationMap()
-                            .put(EL_RESOLVER_COMPARATOR, comparator);
+                    .put(initParameterName, applicationScopedObject);
                 }
-                
-                // sort the resolvers
-                Collections.sort(resolvers, comparator);
             }
             catch (Exception e)
             {
                 log.log(Level.WARNING, 
-                        "Could not sort ELResolvers with custom Comparator", e);
+                        "Could not create instance of " + className + " for context-param " + initParameterName, e);
             }
-        }
+        }    
+
+        return applicationScopedObject;
     }
 
     protected ELResolver createELResolver(VariableResolver resolver)

Modified: myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderForFaces.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderForFaces.java?rev=1100307&r1=1100306&r2=1100307&view=diff
==============================================================================
--- myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderForFaces.java (original)
+++ myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderForFaces.java Fri May  6 18:08:06 2011
@@ -32,6 +32,7 @@ import javax.el.ResourceBundleELResolver
 import org.apache.myfaces.config.RuntimeConfig;
 import org.apache.myfaces.el.FlashELResolver;
 import org.apache.myfaces.el.unified.resolver.CompositeComponentELResolver;
+import org.apache.myfaces.el.unified.resolver.FacesCompositeELResolver.Scope;
 import org.apache.myfaces.el.unified.resolver.ManagedBeanResolver;
 import org.apache.myfaces.el.unified.resolver.ResourceBundleResolver;
 import org.apache.myfaces.el.unified.resolver.ResourceResolver;
@@ -74,10 +75,13 @@ public class ResolverBuilderForFaces ext
         list.add(new BeanELResolver());
         
         // give the user a chance to sort the resolvers
-        sortELResolvers(list);
+        sortELResolvers(list, Scope.Faces);
+        
+        // give the user a chance to filter the resolvers
+        Iterable<ELResolver> filteredELResolvers = filterELResolvers(list, Scope.Faces);
         
         // add the resolvers from the list to the CompositeELResolver
-        for (ELResolver resolver : list)
+        for (ELResolver resolver : filteredELResolvers)
         {
             compositeElResolver.add(resolver);
         }

Modified: myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderForJSP.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderForJSP.java?rev=1100307&r1=1100306&r2=1100307&view=diff
==============================================================================
--- myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderForJSP.java (original)
+++ myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderForJSP.java Fri May  6 18:08:06 2011
@@ -26,6 +26,7 @@ import javax.el.ELResolver;
 
 import org.apache.myfaces.config.RuntimeConfig;
 import org.apache.myfaces.el.FlashELResolver;
+import org.apache.myfaces.el.unified.resolver.FacesCompositeELResolver.Scope;
 import org.apache.myfaces.el.unified.resolver.ManagedBeanResolver;
 import org.apache.myfaces.el.unified.resolver.ResourceBundleResolver;
 import org.apache.myfaces.el.unified.resolver.ResourceResolver;
@@ -60,10 +61,13 @@ public class ResolverBuilderForJSP exten
         addFromRuntimeConfig(list);
         
         // give the user a chance to sort the resolvers
-        sortELResolvers(list);
+        sortELResolvers(list, Scope.JSP);
+        
+        // give the user a chance to filter the resolvers
+        Iterable<ELResolver> filteredELResolvers = filterELResolvers(list, Scope.JSP);
         
         // add the resolvers from the list to the CompositeELResolver
-        for (ELResolver resolver : list)
+        for (ELResolver resolver : filteredELResolvers)
         {
             compositeElResolver.add(resolver);
         }