View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.renderkit;
20  
21  import javax.faces.context.FacesContext;
22  import javax.faces.render.ResponseStateManager;
23  
24  /**
25   * @author Manfred Geiler (latest modification by $Author$)
26   * @version $Revision$ $Date$
27   * 
28   */
29  public abstract class MyfacesResponseStateManager extends ResponseStateManager
30  {
31  
32      /**
33       * Execute additional operations like save the state on a cache when server
34       * side state saving is used.
35       */
36      public void saveState(FacesContext facesContext, Object state)
37      {
38      }
39      
40      /**
41       * Indicates if the call to ResponseStateManager.writeState should be done after the view is fully rendered.
42       * Usually this is required for client side state saving, but it is not for server side state saving, because
43       * ResponseStateManager.writeState could render a just a marker and then StateManager.saveState could be called,
44       * preventing use an additional buffer. 
45       * 
46       * @param facesContext
47       * @return
48       */
49      public boolean isWriteStateAfterRenderViewRequired(FacesContext facesContext)
50      {
51          return true;
52      }
53  }