KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > opensymphony > oscache > web > WebEntryRefreshPolicy


1 /*
2  * Copyright (c) 2002-2003 by OpenSymphony
3  * All rights reserved.
4  */
5 package com.opensymphony.oscache.web;
6
7 import com.opensymphony.oscache.base.EntryRefreshPolicy;
8
9 /**
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  * &lt;cache:cache key="mykey"
18  * refreshpolicyclass="com.mycompany.cache.policy.MyRefreshPolicy"
19  * refreshpolicyparam="...additional data..."&gt;
20        My cached content
21  * &lt;/cache:cache&gt;
22  * </pre>
23  *
24  * @version $Revision: 1.1 $
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 JavaDoc key, String JavaDoc param);
35 }
36
Popular Tags