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.spi;
20  
21  import java.util.Map;
22  import javax.faces.context.FacesContext;
23  
24  /**
25   * 
26   * 
27   * TODO: (Optional) provide something to cleanup the session when a view
28   * is discarded.
29   * 
30   * @author Leonardo Uribe
31   */
32  public abstract class ViewScopeProvider 
33  {
34      public abstract void onSessionDestroyed();
35      
36      public abstract String generateViewScopeId(FacesContext facesContext);
37      
38      public abstract Map<String, Object> createViewScopeMap(FacesContext facesContext, String viewScopeId);
39      
40      public abstract Map<String, Object> restoreViewScopeMap(FacesContext facesContext, String viewScopeId);
41      
42      public abstract void destroyViewScopeMap(FacesContext facesContext, String viewScopeId);
43  
44  }