| Home >> All >> com >> opensymphony >> oscache >> [ base Javadoc ] |
| • | com.opensymphony.oscache.base.algorithm.* (10) | • | com.opensymphony.oscache.base.events.* (19) |
| • | com.opensymphony.oscache.base.persistence.* (2) |
• com.opensymphony.oscache.base: Javadoc index of package com.opensymphony.oscache.base.
Package Samples:
• com.opensymphony.oscache.base.algorithm: Provides the base classes and interfaces that make up the core of OSCache.
• com.opensymphony.oscache.base.persistence: Provides the base classes and interfaces that make up the core of OSCache.
• com.opensymphony.oscache.base.events
Classes:
• AbstractConcurrentReadCache: A version of Hashtable that supports mostly-concurrent reading, but exclusive writing. Because reads are not limited to periods without writes, a concurrent reader policy is weaker than a classic reader/writer policy, but is generally faster and allows more concurrency. This class is a good choice especially for tables that are mainly created by one thread during the start-up phase of a program, and from then on, are mainly read (with perhaps occasional additions or removals) in many threads. If you also need concurrency among writes, consider instead using ConcurrentHashMap. Successful retrievals ...
• LRUCache: LRU (Least Recently Used) algorithm for the cache. Since release 2.3 this class requires Java 1.4 to use the LinkedHashSet . Use prior OSCache release which require the Jakarta commons-collections SequencedHashMap class or the LinkedList class if neither of the above classes are available. No synchronization is required in this class since the AbstractConcurrentReadCache already takes care of any synchronization requirements.
• NeedsRefreshException: This exception is thrown when retrieving an item from cache and it is expired. Note that for fault tolerance purposes, it is possible to retrieve the current cached object from the exception. January, 2004 - The OSCache developers are aware of the fact that throwing an exception for a perfect valid situation (cache miss) is design smell. This will be removed in the near future, and other means of refreshing the cache will be provided.
• TestAbstractCacheAdministrator: Test class for the AbstractCacheAdministrator class. It tests some of the public methods of the admin. Some others cannot be tested since they are linked to the property file used for the tests, and since this file will change, the value of some parameters cannot be asserted $Id: TestAbstractCacheAdministrator.java,v 1.1 2005/06/17 05:06:47 dres Exp $
• CacheEntryEventType: This is all the possible events that may occur on a cache entry or collection of cache entries. There is a corresponding interface CacheEntryEventListener for handling these events.
• TestLRUCache: Test class for the LRUCache class. It only tests that the algorithm reacts as expected when entries are removed. All the other tests related to the LRU algorithm are in the TestNonQueueCache class, since those tests are shared with the TestUnlimitedCache class. $Id: TestLRUCache.java,v 1.1 2005/06/17 05:07:08 dres Exp $
• TestUnlimitedCache: Test class for the Unlimited cache algorithm. Most of the tests are done in the TestNonQueueCache class, so only algorithm specific tests are done here. Since this is an unlimited cache, there's not much to test about the algorithm. $Id: TestUnlimitedCache.java,v 1.2 2006/06/15 16:27:17 ltorunski Exp $
• AbstractCacheAdministrator: An AbstractCacheAdministrator defines an abstract cache administrator, implementing all the basic operations related to the configuration of a cache, including assigning any configured event handlers to cache objects. Extend this class to implement a custom cache administrator.
• CacheEntryEventListener: This is the interface to listen to cache entry events. There is a method for each event type. These methods are called via a dispatcher. If you want to be notified when an event occurs on an entry, group or across a pattern, register a listener and implement this interface.
• TestCompleteAlgorithm: Test class for the com.opensymphony.oscache.base.algorithm package. It invokes all the test suites of all the other classes of the package, except abstract ones because they are tested via final ones. $Id: TestCompleteAlgorithm.java,v 1.1 2005/06/17 05:07:08 dres Exp $
• CacheEntry: A CacheEntry instance represents one entry in the cache. It holds the object that is being cached, along with a host of information about that entry such as the cache key, the time it was cached, whether the entry has been flushed or not and the groups it belongs to.
• PersistenceListener: Defines the methods that are required to persist cache data. To provide a custom persistence mechanism you should implement this interface and supply the fully-qualified classname to the cache via the cache.persistence.class configuration property.
• Cache: Provides an interface to the cache itself. Creating an instance of this class will create a cache that behaves according to its construction parameters. The public API provides methods to manage objects in the cache and configure any cache event listeners.
• LifecycleAware: Event handlers implement this so they can be notified when a cache is created and also when it is destroyed. This allows event handlers to load any configuration and/or resources they need on startup and then release them again when the cache is shut down.
• EntryRefreshPolicy: Interface that allows custom code to be called when checking to see if a cache entry has expired. This is useful when the rules that determine when content needs refreshing are beyond the base funtionality offered by OSCache.
• TestAbstractCache: Test class for the AbstractCache class. It tests all public methods of the AbstractCache and assert the results. It is design to run under JUnit. $Id: TestAbstractCache.java,v 1.3 2006/06/17 08:02:28 ltorunski Exp $
• FIFOCache: FIFO (First In First Out) based queue algorithm for the cache. No synchronization is required in this class since the AbstractConcurrentReadCache already takes care of any synchronization requirements.
• TestQueueCache: Test class for the QueueCache class, which is the base class for FIFO and LIFO algorithm classes. All the public methods of QueueCache are tested here. $Id: TestQueueCache.java,v 1.1 2005/06/17 05:07:07 dres Exp $
• TestCompleteEvents: Test class for the com.opensymphony.oscache.base.events package. It invokes all the test suites of all the other classes of the package. $Id: TestCompleteEvents.java,v 1.1 2005/06/17 05:07:00 dres Exp $
• InitializationException: Thrown by LifecycleAware listeners that are not able to initialize themselves.
• FinalizationException: Thrown by LifecycleAware listeners that are not able to finalize themselves.
• TestCompleteBase: Test class for the com.opensymphony.oscache.base package. It invokes all the test suites of all the other classes of the package. $Id: TestCompleteBase.java,v 1.1 2005/06/17 05:06:48 dres Exp $
• CacheMapAccessEvent: Cache map access event. This is the object created when an event occurs on a cache map (cache Hit, cache miss). It contains the entry that was referenced by the event and the event type.
• TestCacheMapAccessEvent: This is the test class for the CacheMapAccessEvent class. It checks that the public methods are working properly $Id: TestCacheMapAccessEvent.java,v 1.1 2005/06/17 05:07:00 dres Exp $
• TestCacheEntryEvent: This is the test class for the CacheEntryEvent class. It checks that the public methods are working properly $Id: TestCacheEntryEvent.java,v 1.1 2005/06/17 05:07:00 dres Exp $
| Home | Contact Us | Privacy Policy | Terms of Service |