You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by lu...@apache.org on 2013/06/11 18:21:23 UTC

svn commit: r1491863 - in /myfaces/core/trunk: api/src/main/java/javax/faces/application/ impl/src/main/java/org/apache/myfaces/application/viewstate/ impl/src/main/java/org/apache/myfaces/view/facelets/ impl/src/main/java/org/apache/myfaces/view/facel...

Author: lu4242
Date: Tue Jun 11 16:21:23 2013
New Revision: 1491863

URL: http://svn.apache.org/r1491863
Log:
move some web config parameters definitions to StateManager / ViewHandler as described in the spec

Modified:
    myfaces/core/trunk/api/src/main/java/javax/faces/application/StateManager.java
    myfaces/core/trunk/api/src/main/java/javax/faces/application/ViewHandler.java
    myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/application/viewstate/ServerSideStateCacheImpl.java
    myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/view/facelets/FaceletViewDeclarationLanguage.java
    myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/view/facelets/impl/FaceletCacheFactoryImpl.java
    myfaces/core/trunk/impl/src/test/java/org/apache/myfaces/application/viewstate/ServerSideStateCacheTest.java

Modified: myfaces/core/trunk/api/src/main/java/javax/faces/application/StateManager.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/java/javax/faces/application/StateManager.java?rev=1491863&r1=1491862&r2=1491863&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/java/javax/faces/application/StateManager.java (original)
+++ myfaces/core/trunk/api/src/main/java/javax/faces/application/StateManager.java Tue Jun 11 16:21:23 2013
@@ -108,7 +108,8 @@ public abstract class StateManager
     
     public static final String IS_SAVING_STATE = "javax.faces.IS_SAVING_STATE";
     
-    @JSFWebConfigParam(since="2.2")
+    @JSFWebConfigParam(since="2.2", group="state", tags="performance", 
+            defaultValue="false", expectedValues="true,false")
     public static final java.lang.String SERIALIZE_SERVER_STATE_PARAM_NAME = "javax.faces.SERIALIZE_SERVER_STATE";
     
     /**

Modified: myfaces/core/trunk/api/src/main/java/javax/faces/application/ViewHandler.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/java/javax/faces/application/ViewHandler.java?rev=1491863&r1=1491862&r2=1491863&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/java/javax/faces/application/ViewHandler.java (original)
+++ myfaces/core/trunk/api/src/main/java/javax/faces/application/ViewHandler.java Tue Jun 11 16:21:23 2013
@@ -102,19 +102,44 @@ public abstract class ViewHandler
     public static final java.lang.String DISABLE_FACELET_JSF_VIEWHANDLER_PARAM_NAME = 
         "DISABLE_FACELET_JSF_VIEWHANDLER";
     
-    @JSFWebConfigParam(since="2.2")
+    /**
+     * Define the default buffer size value passed to ExternalContext.setResponseBufferResponse() and in a
+     * servlet environment to HttpServletResponse.setBufferSize().
+     */
+    @JSFWebConfigParam(since = "2.0", alias = "facelets.BUFFER_SIZE", classType = "java.lang.Integer",
+            tags = "performance",
+            desc = "Define the default buffer size value passed to ExternalContext.setResponseBufferResponse() and in "
+                   + "a servlet environment to HttpServletResponse.setBufferSize()")
     public static final java.lang.String FACELETS_BUFFER_SIZE_PARAM_NAME = "javax.faces.FACELETS_BUFFER_SIZE";
     
-    @JSFWebConfigParam(since="2.2")
+    /**
+     * Set of class names, separated by ';', implementing TagDecorator interface, used to transform
+     * a view definition in a facelet abstract syntax tree, that is used later to generate a component tree.
+     */
+    @JSFWebConfigParam(since = "2.0", alias = "facelets.DECORATORS")
     public static final java.lang.String FACELETS_DECORATORS_PARAM_NAME = "javax.faces.FACELETS_DECORATORS";
     
-    @JSFWebConfigParam(since="2.2")
+    /**
+     * Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.
+     */
+    @JSFWebConfigParam(since = "2.0",
+            desc = "Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.",
+            alias = "facelets.LIBRARIES")
     public static final java.lang.String FACELETS_LIBRARIES_PARAM_NAME = "javax.faces.FACELETS_LIBRARIES";
     
-    @JSFWebConfigParam(since="2.2")
+    /**
+     * Define the period used to refresh the facelet abstract syntax tree from the view definition file. 
+     *
+     * <p>By default is infinite (no active).</p>
+     */
+    @JSFWebConfigParam(since = "2.0", defaultValue = "-1", alias = "facelets.REFRESH_PERIOD",
+            classType = "java.lang.Long", tags = "performance")
     public static final java.lang.String FACELETS_REFRESH_PERIOD_PARAM_NAME = "javax.faces.FACELETS_REFRESH_PERIOD";
 
-    @JSFWebConfigParam(since="2.2")
+    /**
+     * Skip comments found on a facelet file.
+     */
+    @JSFWebConfigParam(since = "2.0", alias = "facelets.SKIP_COMMENTS")
     public static final java.lang.String FACELETS_SKIP_COMMENTS_PARAM_NAME = "javax.faces.FACELETS_SKIP_COMMENTS";
     
     /**

Modified: myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/application/viewstate/ServerSideStateCacheImpl.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/application/viewstate/ServerSideStateCacheImpl.java?rev=1491863&r1=1491862&r2=1491863&view=diff
==============================================================================
--- myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/application/viewstate/ServerSideStateCacheImpl.java (original)
+++ myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/application/viewstate/ServerSideStateCacheImpl.java Tue Jun 11 16:21:23 2013
@@ -33,6 +33,7 @@ import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.zip.GZIPInputStream;
 import java.util.zip.GZIPOutputStream;
+import javax.faces.application.StateManager;
 
 import javax.faces.context.ExternalContext;
 import javax.faces.context.FacesContext;
@@ -97,7 +98,7 @@ class ServerSideStateCacheImpl extends S
      * If <code>false</code> the state will not be serialized to a byte stream.
      * </p>
      */
-    @JSFWebConfigParam(defaultValue="true",since="1.1", expectedValues="true,false", group="state", tags="performance")
+    @JSFWebConfigParam(defaultValue="false",since="1.1", expectedValues="true,false", group="state", tags="performance")
     public static final String SERIALIZE_STATE_IN_SESSION_PARAM = "org.apache.myfaces.SERIALIZE_STATE_IN_SESSION";
 
     /**
@@ -117,9 +118,10 @@ class ServerSideStateCacheImpl extends S
     public static final boolean DEFAULT_COMPRESS_SERVER_STATE_PARAM = true;
 
     /**
-     * Default value for <code>org.apache.myfaces.SERIALIZE_STATE_IN_SESSION</code> context parameter.
+     * Default value for <code>javax.faces.SERIALIZE_SERVER_STATE and 
+     * org.apache.myfaces.SERIALIZE_STATE_IN_SESSION</code> context parameter.
      */
-    public static final boolean DEFAULT_SERIALIZE_STATE_IN_SESSION = true;
+    public static final boolean DEFAULT_SERIALIZE_STATE_IN_SESSION = false;
 
     /**
      * Define the way of handle old view references(views removed from session), making possible to
@@ -462,10 +464,20 @@ class ServerSideStateCacheImpl extends S
     protected boolean isSerializeStateInSession(FacesContext context)
     {
         String value = context.getExternalContext().getInitParameter(
-                SERIALIZE_STATE_IN_SESSION_PARAM);
+                StateManager.SERIALIZE_SERVER_STATE_PARAM_NAME);
+        
         boolean serialize = DEFAULT_SERIALIZE_STATE_IN_SESSION;
         if (value != null)
         {
+            serialize = value.toLowerCase().equals("true");
+            return serialize;
+        }
+        
+        // Fallback old parameter.
+        value = context.getExternalContext().getInitParameter(
+                SERIALIZE_STATE_IN_SESSION_PARAM);
+        if (value != null)
+        {
            serialize = Boolean.valueOf(value);
         }
         return serialize;

Modified: myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/view/facelets/FaceletViewDeclarationLanguage.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/view/facelets/FaceletViewDeclarationLanguage.java?rev=1491863&r1=1491862&r2=1491863&view=diff
==============================================================================
--- myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/view/facelets/FaceletViewDeclarationLanguage.java (original)
+++ myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/view/facelets/FaceletViewDeclarationLanguage.java Tue Jun 11 16:21:23 2013
@@ -171,18 +171,6 @@ public class FaceletViewDeclarationLangu
 
     public final static String DEFAULT_CHARACTER_ENCODING = "UTF-8";
 
-    //public final static String PARAM_BUFFER_SIZE = "javax.faces.FACELETS_BUFFER_SIZE";
-
-    /**
-     * Define the default buffer size value passed to ExternalContext.setResponseBufferResponse() and in a
-     * servlet environment to HttpServletResponse.setBufferSize().
-     */
-    @JSFWebConfigParam(since = "2.0", alias = "facelets.BUFFER_SIZE", classType = "java.lang.Integer",
-            tags = "performance",
-            desc = "Define the default buffer size value passed to ExternalContext.setResponseBufferResponse() and in "
-                   + "a servlet environment to HttpServletResponse.setBufferSize()")
-    public final static String PARAM_BUFFER_SIZE = "javax.faces.FACELETS_BUFFER_SIZE";
-
     /**
      * Define the default buffer size value passed to ExternalContext.setResponseBufferResponse() and in a
      * servlet environment to HttpServletResponse.setBufferSize().
@@ -190,7 +178,8 @@ public class FaceletViewDeclarationLangu
     @JSFWebConfigParam(since = "2.0", deprecated = true, classType = "java.lang.Integer")
     private final static String PARAM_BUFFER_SIZE_DEPRECATED = "facelets.BUFFER_SIZE";
 
-    private final static String[] PARAMS_BUFFER_SIZE = {PARAM_BUFFER_SIZE, PARAM_BUFFER_SIZE_DEPRECATED};
+    private final static String[] PARAMS_BUFFER_SIZE = {ViewHandler.FACELETS_BUFFER_SIZE_PARAM_NAME,
+        PARAM_BUFFER_SIZE_DEPRECATED};
 
     //private final static String PARAM_BUILD_BEFORE_RESTORE = "facelets.BUILD_BEFORE_RESTORE";
 
@@ -198,17 +187,11 @@ public class FaceletViewDeclarationLangu
      * Set of class names, separated by ';', implementing TagDecorator interface, used to transform
      * a view definition in a facelet abstract syntax tree, that is used later to generate a component tree.
      */
-    @JSFWebConfigParam(since = "2.0", alias = "facelets.DECORATORS")
-    public final static String PARAM_DECORATORS = "javax.faces.FACELETS_DECORATORS";
-
-    /**
-     * Set of class names, separated by ';', implementing TagDecorator interface, used to transform
-     * a view definition in a facelet abstract syntax tree, that is used later to generate a component tree.
-     */
     @JSFWebConfigParam(since = "2.0", deprecated = true)
     private final static String PARAM_DECORATORS_DEPRECATED = "facelets.DECORATORS";
 
-    private final static String[] PARAMS_DECORATORS = {PARAM_DECORATORS, PARAM_DECORATORS_DEPRECATED};
+    private final static String[] PARAMS_DECORATORS = {ViewHandler.FACELETS_DECORATORS_PARAM_NAME, 
+        PARAM_DECORATORS_DEPRECATED};
 
     /**
      * Constant used by EncodingHandler to indicate the current encoding of the page being built,
@@ -221,27 +204,11 @@ public class FaceletViewDeclarationLangu
      */
     @JSFWebConfigParam(since = "2.0",
             desc = "Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.",
-            alias = "facelets.LIBRARIES")
-    public final static String PARAM_LIBRARIES = "javax.faces.FACELETS_LIBRARIES";
-
-    /**
-     * Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.
-     */
-    @JSFWebConfigParam(since = "2.0",
-            desc = "Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.",
             deprecated = true)
     private final static String PARAM_LIBRARIES_DEPRECATED = "facelets.LIBRARIES";
 
-    private final static String[] PARAMS_LIBRARIES = {PARAM_LIBRARIES, PARAM_LIBRARIES_DEPRECATED};
-
-    /**
-     * Define the period used to refresh the facelet abstract syntax tree from the view definition file. 
-     *
-     * <p>By default is infinite (no active).</p>
-     */
-    @JSFWebConfigParam(since = "2.0", defaultValue = "-1", alias = "facelets.REFRESH_PERIOD",
-            classType = "java.lang.Long", tags = "performance")
-    public final static String PARAM_REFRESH_PERIOD = "javax.faces.FACELETS_REFRESH_PERIOD";
+    private final static String[] PARAMS_LIBRARIES = {ViewHandler.FACELETS_LIBRARIES_PARAM_NAME,
+        PARAM_LIBRARIES_DEPRECATED};
 
     /**
      * Define the period used to refresh the facelet abstract syntax tree from the view definition file. 
@@ -251,7 +218,8 @@ public class FaceletViewDeclarationLangu
     @JSFWebConfigParam(since = "2.0", defaultValue = "-1", deprecated = true)
     private final static String PARAM_REFRESH_PERIOD_DEPRECATED = "facelets.REFRESH_PERIOD";
 
-    private final static String[] PARAMS_REFRESH_PERIOD = {PARAM_REFRESH_PERIOD, PARAM_REFRESH_PERIOD_DEPRECATED};
+    private final static String[] PARAMS_REFRESH_PERIOD = {ViewHandler.FACELETS_REFRESH_PERIOD_PARAM_NAME,
+        PARAM_REFRESH_PERIOD_DEPRECATED};
 
     /**
      * Class implementing ResourceResolver interface used to locate facelet resources. 
@@ -271,12 +239,6 @@ public class FaceletViewDeclarationLangu
     /**
      * Skip comments found on a facelet file.
      */
-    @JSFWebConfigParam(since = "2.0", alias = "facelets.SKIP_COMMENTS")
-    public final static String PARAM_SKIP_COMMENTS = "javax.faces.FACELETS_SKIP_COMMENTS";
-
-    /**
-     * Skip comments found on a facelet file.
-     */
     @JSFWebConfigParam(since = "2.0", deprecated = true)
     private final static String PARAM_SKIP_COMMENTS_DEPRECATED = "facelets.SKIP_COMMENTS";
 
@@ -284,8 +246,8 @@ public class FaceletViewDeclarationLangu
     private final static String PARAM_MARK_INITIAL_STATE_WHEN_APPLY_BUILD_VIEW
             = "org.apache.myfaces.MARK_INITIAL_STATE_WHEN_APPLY_BUILD_VIEW";
 
-    private final static String[] PARAMS_SKIP_COMMENTS = {PARAM_SKIP_COMMENTS, PARAM_SKIP_COMMENTS_DEPRECATED};
-
+    private final static String[] PARAMS_SKIP_COMMENTS = {ViewHandler.FACELETS_SKIP_COMMENTS_PARAM_NAME,
+        PARAM_SKIP_COMMENTS_DEPRECATED};
 
     public final static String FILLED_VIEW = "org.apache.myfaces.FILLED_VIEW";
 

Modified: myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/view/facelets/impl/FaceletCacheFactoryImpl.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/view/facelets/impl/FaceletCacheFactoryImpl.java?rev=1491863&r1=1491862&r2=1491863&view=diff
==============================================================================
--- myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/view/facelets/impl/FaceletCacheFactoryImpl.java (original)
+++ myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/view/facelets/impl/FaceletCacheFactoryImpl.java Tue Jun 11 16:21:23 2013
@@ -19,6 +19,7 @@
 package org.apache.myfaces.view.facelets.impl;
 
 import javax.faces.application.ProjectStage;
+import javax.faces.application.ViewHandler;
 import javax.faces.context.ExternalContext;
 import javax.faces.context.FacesContext;
 import javax.faces.view.facelets.FaceletCache;
@@ -39,7 +40,7 @@ public class FaceletCacheFactoryImpl ext
     private final static String PARAM_REFRESH_PERIOD_DEPRECATED = "facelets.REFRESH_PERIOD";
     
     private final static String[] PARAMS_REFRESH_PERIOD
-            = {FaceletViewDeclarationLanguage.PARAM_REFRESH_PERIOD, PARAM_REFRESH_PERIOD_DEPRECATED};
+            = {ViewHandler.FACELETS_REFRESH_PERIOD_PARAM_NAME, PARAM_REFRESH_PERIOD_DEPRECATED};
 
 
     @Override

Modified: myfaces/core/trunk/impl/src/test/java/org/apache/myfaces/application/viewstate/ServerSideStateCacheTest.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/test/java/org/apache/myfaces/application/viewstate/ServerSideStateCacheTest.java?rev=1491863&r1=1491862&r2=1491863&view=diff
==============================================================================
--- myfaces/core/trunk/impl/src/test/java/org/apache/myfaces/application/viewstate/ServerSideStateCacheTest.java (original)
+++ myfaces/core/trunk/impl/src/test/java/org/apache/myfaces/application/viewstate/ServerSideStateCacheTest.java Tue Jun 11 16:21:23 2013
@@ -40,6 +40,7 @@ public class ServerSideStateCacheTest ex
         servletContext.addInitParameter(StateManager.STATE_SAVING_METHOD_PARAM_NAME, StateManager.STATE_SAVING_METHOD_SERVER);
         servletContext.addInitParameter("org.apache.myfaces.NUMBER_OF_VIEWS_IN_SESSION", "5");
         servletContext.addInitParameter("org.apache.myfaces.NUMBER_OF_SEQUENTIAL_VIEWS_IN_SESSION", "2");
+        servletContext.addInitParameter(StateManager.SERIALIZE_SERVER_STATE_PARAM_NAME, "true");
 
         // Initialization
         setupRequest();