|
|||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
ICacheKeyProvider.java | - | - | - | - |
|
1 | /* | |
2 | * Copyright (c) 2002-2003 by OpenSymphony | |
3 | * All rights reserved. | |
4 | */ | |
5 | package com.opensymphony.oscache.web.filter; | |
6 | ||
7 | import javax.servlet.http.HttpServletRequest; | |
8 | ||
9 | import com.opensymphony.oscache.base.Cache; | |
10 | import com.opensymphony.oscache.web.ServletCacheAdministrator; | |
11 | ||
12 | /** | |
13 | * Provider interface for cache key creation. A developer can implement a method which provides | |
14 | * cache keys based on the request, the servlet cache administrator and cache. | |
15 | * | |
16 | * JIRA issue: http://jira.opensymphony.com/browse/CACHE-179 | |
17 | * | |
18 | * @author <a href="mailto:ltorunski@t-online.de">Lars Torunski</a> | |
19 | * @version $Revision: 276 $ | |
20 | */ | |
21 | public interface ICacheKeyProvider { | |
22 | ||
23 | /** | |
24 | * Creates the cache key for the CacheFilter. | |
25 | * | |
26 | * @param httpRequest the http request. | |
27 | * @param scAdmin the ServletCacheAdministrator of the cache | |
28 | * @param cache the cache of the ServletCacheAdministrator | |
29 | * @return the cache key | |
30 | */ | |
31 | public String createCacheKey(HttpServletRequest httpRequest, ServletCacheAdministrator scAdmin, Cache cache); | |
32 | ||
33 | } |
|