01: /* ***** BEGIN LICENSE BLOCK *****
02: * Version: MPL 1.1
03: * The contents of this file are subject to the Mozilla Public License Version
04: * 1.1 (the "License"); you may not use this file except in compliance with
05: * the License. You may obtain a copy of the License at
06: * http://www.mozilla.org/MPL/
07: *
08: * Software distributed under the License is distributed on an "AS IS" basis,
09: * 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: * Controllers that want their output to be cached must implement this
32: * interface.
33: */
34: public interface CacheableController extends Controller {
35:
36: public static final long CACHE_ETERNALLY = -1L;
37:
38: /**
39: * returns the key that is used to look up a previously cached version.
40: * The key must include all values that govern the output, such as the
41: * requested URL, parameters, attributes, cookie values or the name of the
42: * controller. The key itself is not interpreted in any way and thus can
43: * have an arbitrary format.
44: */
45: public String getCacheKey(HttpServletRequest request);
46:
47: /**
48: * Returns the time in milliseconds that has to be elapsed since the last
49: * up-to-date check before another check is performed. Implementors may
50: * return {@link #CACHE_ETERNALLY} to indicate that the content should be
51: * cached eternally.
52: */
53: public long getTimeToLive();
54:
55: /**
56: * Returns the date (as timestamp) when the content was modified for the
57: * last time. The controller will not be executed unless this date is newer
58: * than the timestamp of the cached version.
59: */
60: public long getLastModified(HttpServletRequest request)
61: throws Exception;
62:
63: }
|