CacheableController


1   /* ***** BEGIN LICENSE BLOCK *****
2    * Version: MPL 1.1
3    * The contents of this file are subject to the Mozilla Public License Version
4    * 1.1 (the "License"); you may not use this file except in compliance with
5    * the License. You may obtain a copy of the License at
6    * http://www.mozilla.org/MPL/
7    * 
8    * Software distributed under the License is distributed on an "AS IS" basis,
9    * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10   * for the specific language governing rights and limitations under the
11   * License.
12   * 
13   * The Original Code is Riot.
14   * 
15   * The Initial Developer of the Original Code is
16   * Neteye GmbH.
17   * Portions created by the Initial Developer are Copyright (C) 2006
18   * the Initial Developer. All Rights Reserved.
19   * 
20   * Contributor(s):
21   *   Felix Gnass [fgnass at neteye dot de]
22   * 
23   * ***** END LICENSE BLOCK ***** */
24  package org.riotfamily.cachius.spring;
25  
26  import javax.servlet.http.HttpServletRequest  ;
27  
28  import org.springframework.web.servlet.mvc.Controller;
29  
30  
31  /**
32   * Controllers that want their output to be cached must implement this
33   * interface.
34   */
35  public interface CacheableController extends Controller {
36      
37      public static final long CACHE_ETERNALLY = -1L;
38      
39      /**
40       * returns the key that is used to look up a previously cached version.
41       * The key must include all values that govern the output, such as the 
42       * requested URL, parameters, attributes, cookie values or the name of the 
43       * controller. The key itself is not interpreted in any way and thus can 
44       * have an arbitrary format.
45       */
46      public String   getCacheKey(HttpServletRequest   request);
47      
48      /**
49       * Returns the time in milliseconds that has to be elapsed since the last
50       * up-to-date check before another check is performed. Implementors may 
51       * return {@link #CACHE_ETERNALLY} to indicate that the content should be 
52       * cached eternally.
53       */
54      public long getTimeToLive();
55      
56      /**
57       * Returns the date (as timestamp) when the content was modified for the 
58       * last time. The controller will not be executed unless this date is newer 
59       * than the timestamp of the cached version.
60       */
61      public long getLastModified(HttpServletRequest   request) throws Exception  ;
62  
63  }
64
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags