|
| |
|
| org.apache.turbine.services.TurbineBaseService
 org.apache.turbine.services.cache.TurbineGlobalCacheService
| TurbineGlobalCacheService | | public class TurbineGlobalCacheService extends TurbineBaseService implements GlobalCacheService,Runnable(Code) | | This Service functions as a Global Cache. A global cache is a good
place to store items that you may need to access often but don't
necessarily need (or want) to fetch from the database everytime. A
good example would be a look up table of States that you store in a
database and use throughout your application. Since information
about States doesn't change very often, you could store this
information in the Global Cache and decrease the overhead of
hitting the database everytime you need State information.
The following properties are needed to configure this service:
services.GlobalCacheService.classname=org.apache.turbine.services.cache.TurbineGlobalCacheService
services.GlobalCacheService.cache.initial.size=20
services.GlobalCacheService.cache.check.frequency=5000
- classname
- the classname of this service
- cache.initial.size
- Initial size of hash table use to store cached
objects. If this property is not present, the default value is 20
- cache.check.frequency
- Cache check frequency in Millis (1000
Millis = 1 second). If this property is not present, the default value is 5000
author:
Dave Bryson
author:
Jon S. Stevens
author:
John Thorhauer
author:
Henning P. Schmiedehausen
version:
$Id: TurbineGlobalCacheService.java 534527 2007-05-02 16:10:59Z tv $ |
| CACHE_CHECK_FREQUENCY | | final public static String CACHE_CHECK_FREQUENCY(Code) | | The property for the Cache check frequency
|
| DEFAULT_CACHE_CHECK_FREQUENCY | | final public static long DEFAULT_CACHE_CHECK_FREQUENCY(Code) | | Cache check frequency in Millis (1000 Millis = 1 second).
Value must be > 0.
Default = 5 seconds
|
| DEFAULT_INITIAL_CACHE_SIZE | | final public static int DEFAULT_INITIAL_CACHE_SIZE(Code) | | Initial size of hash table
Value must be > 0.
Default = 20
|
| INITIAL_CACHE_SIZE | | final public static String INITIAL_CACHE_SIZE(Code) | | The property for the InitalCacheSize
|
| TurbineGlobalCacheService | | public TurbineGlobalCacheService()(Code) | | Constructor.
|
| addObject | | public void addObject(String id, CachedObject o)(Code) | | Adds an object to the cache.
Parameters:
id - The key to store the object by.
Parameters:
o - The object to cache. |
| clearCache | | public void clearCache()(Code) | | Iterate through the cache and remove or refresh stale objects.
|
| flushCache | | public void flushCache()(Code) | | Flush the cache of all objects.
|
| getCacheSize | | public int getCacheSize() throws IOException(Code) | | Returns the current size of the cache.
int representing current cache size in number of bytes |
| getNumberOfObjects | | public int getNumberOfObjects()(Code) | | Returns the number of objects currently stored in the cache
int number of object in the cache |
| getObject | | public CachedObject getObject(String id) throws ObjectExpiredException(Code) | | Returns an item from the cache. RefreshableCachedObject will be
refreshed if it is expired and not untouched.
Parameters:
id - The key of the stored object. The object from the cache.
exception:
ObjectExpiredException - when either the object isnot in the cache or it has expired. |
| removeObject | | public void removeObject(String id)(Code) | | Removes an object from the cache.
Parameters:
id - The String id for the object. |
| run | | public void run()(Code) | | Circle through the cache and remove stale objects. Frequency
is determined by the cacheCheckFrequency property.
|
|
|
|