01: /***************************************************************
02: * This file is part of the [fleXive](R) project.
03: *
04: * Copyright (c) 1999-2008
05: * UCS - unique computing solutions gmbh (http://www.ucs.at)
06: * All rights reserved
07: *
08: * The [fleXive](R) project is free software; you can redistribute
09: * it and/or modify it under the terms of the GNU General Public
10: * License as published by the Free Software Foundation;
11: * either version 2 of the License, or (at your option) any
12: * later version.
13: *
14: * The GNU General Public License can be found at
15: * http://www.gnu.org/copyleft/gpl.html.
16: * A copy is found in the textfile GPL.txt and important notices to the
17: * license from the author are found in LICENSE.txt distributed with
18: * these libraries.
19: *
20: * This library is distributed in the hope that it will be useful,
21: * but WITHOUT ANY WARRANTY; without even the implied warranty of
22: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23: * GNU General Public License for more details.
24: *
25: * For further information about UCS - unique computing solutions gmbh,
26: * please see the company website: http://www.ucs.at
27: *
28: * For further information about [fleXive](R), please see the
29: * project website: http://www.flexive.org
30: *
31: *
32: * This copyright notice MUST APPEAR in all copies of the file!
33: ***************************************************************/package com.flexive.shared.cache;
34:
35: /**
36: * A FxBackingCache Provider
37: *
38: * @author Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
39: */
40: public interface FxBackingCacheProvider {
41:
42: /**
43: * Get a description of the provider
44: *
45: * @return description of the provider
46: */
47: public String getDescription();
48:
49: /**
50: * Initialize the provider
51: *
52: * @throws FxCacheException on errors
53: */
54: public void init() throws FxCacheException;
55:
56: /**
57: * Shutdown the provider
58: *
59: * @throws FxCacheException on errors
60: */
61: public void shutdown() throws FxCacheException;
62:
63: /**
64: * Get the cache instance
65: *
66: * @return cache instance
67: * @throws FxCacheException on errors
68: */
69: public FxBackingCache getInstance() throws FxCacheException;
70:
71: /**
72: * Set the eviction strategy for a path (if the backing cache supports this)
73: *
74: * @param path path
75: * @param maxContents max. number of entries to allow (0=unlimited)
76: * @param timeToIdle time a value has to be idle to be evicted (0=forever)
77: * @param timeToLive time to live (0=forever)
78: * @throws FxCacheException on cache errors
79: */
80: public void setEvictionStrategy(String path, int maxContents,
81: int timeToIdle, int timeToLive) throws FxCacheException;
82: }
|