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.application.viewstate;
20  
21  import javax.faces.context.FacesContext;
22  
23  /**
24   *
25   */
26  abstract class KeyFactory<K, V>
27  {
28  
29      /**
30       * Generates a unique key per session
31       *
32       * @param facesContext
33       * @return
34       */
35      public abstract K generateKey(FacesContext facesContext);
36  
37      /**
38       * Encode a Key into a value that will be used as view state session token
39       *
40       * @param key
41       * @return
42       */
43      public abstract V encode(K key);
44  
45      /**
46       * Decode a view state session token into a key
47       *
48       * @param value
49       * @return
50       */
51      public abstract K decode(V value);
52      
53  }