01: /*
02: * Copyright (c) 2002-2003 by OpenSymphony
03: * All rights reserved.
04: */
05: package com.opensymphony.oscache.web;
06:
07: import com.opensymphony.oscache.base.EntryRefreshPolicy;
08:
09: /**
10: * Interface to implement an entry refresh policy.
11: * Specify the name of the implementing class using the refreshpolicyclass
12: * attribute of the cache tag. If any additional parameters are required,
13: * they should be supplied using the refreshpolicyparam attribute.<p>
14: *
15: * For example:
16: * <pre>
17: * <cache:cache key="mykey"
18: * refreshpolicyclass="com.mycompany.cache.policy.MyRefreshPolicy"
19: * refreshpolicyparam="...additional data...">
20: My cached content
21: * </cache:cache>
22: * </pre>
23: *
24: * @version $Revision: 254 $
25: * @author <a href="mailto:fbeauregard@pyxis-tech.com">Francois Beauregard</a>
26: */
27: public interface WebEntryRefreshPolicy extends EntryRefreshPolicy {
28: /**
29: * Initializes the refresh policy.
30: *
31: * @param key The cache key that is being checked.
32: * @param param Any optional parameters that were supplied
33: */
34: public void init(String key, String param);
35: }
|