KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > whirlycott > cache > CacheMaintenancePolicy


1 /*
2 Copyright 2004 Philip Jacob <phil@whirlycott.com>
3                     Seth Fitzsimmons <seth@note.amherst.edu>
4
5 Licensed under the Apache License, Version 2.0 (the "License");
6 you may not use this file except in compliance with the License.
7 You may obtain a copy of the License at
8
9     http://www.apache.org/licenses/LICENSE-2.0
10
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS" BASIS,
13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 See the License for the specific language governing permissions and
15 limitations under the License.
16 */
17
18 package com.whirlycott.cache;
19
20
21
22 /**
23  * This interface defines the operations in a cache maintenance policy. A cache
24  * maintenance policy defines the set of rules that are used to automatically
25  * expire items that are stored in a particular cache.
26  *
27  * All policies must implement this interface and be configured in the
28  * whirlycache.xml configuration file.
29  *
30  * Each Cache has its own independent policy.
31  *
32  * @author Phil Jacob
33  */
34 public interface CacheMaintenancePolicy {
35     
36     /**
37      * Set the ManagedCache instance to which this policy applies.
38      * @param _cache ManagedCache instance.
39      */
40     public void setCache(ManagedCache _cache);
41     
42     /**
43      * Provide a configuration for this policy.
44      * @param _configuration Configuration to use for this policy.
45      */
46     public void setConfiguration(CacheConfiguration _configuration);
47     
48     /**
49      * Performs housekeeping on the associated ManagedCache instance (typically
50      * removes Items based on varying criteria).
51      */
52     public void performMaintenance();
53 }
54
Popular Tags