Index: AbstractDiskPersistenceListener.java
===================================================================
RCS file: /cvs/oscache/src/plugins/diskpersistence/java/com/opensymphony/oscache/plugins/diskpersistence/AbstractDiskPersistenceListener.java,v
retrieving revision 1.1
diff -r1.1 AbstractDiskPersistenceListener.java
33c33,38
<     protected final static String CACHE_PATH_KEY = "cache.path";
---
>     /**
>      * Cache directory key for the configuration.
>      * This is the directory on disk where caches will be stored by the AbstractDiskPersistenceListener.
>      * It will be created if it doesn't already exist.
>      */
>     public final static String CACHE_PATH_KEY = "cache.path";
36,37c41,42
<  * File extension for disk cache file
<  */
---
>     * File extension for disk cache file
>     */
41,42c46,47
<  * The directory that cache groups are stored under
<  */
---
>     * The directory that cache groups are stored under
>     */
46,47c51,52
<  * Sub path name for application cache
<  */
---
>     * Sub path name for application cache
>     */
51,52c56,57
<  * Sub path name for session cache
<  */
---
>     * Sub path name for session cache
>     */
56,57c61,62
<  * Property to get the temporary working directory of the servlet container.
<  */
---
>     * Property to get the temporary working directory of the servlet container.
>     */
62,63c67,68
<  * Base path where the disk cache reside.
<  */
---
>     * Base path where the disk cache reside.
>     */
68,69c73,74
<  * Root path for disk cache
<  */
---
>     * Root path for disk cache
>     */
73,76c78,81
<  *        Get the physical cache path on disk.
<  *
<  *        @return        A file representing the physical cache location.
<  */
---
>     *        Get the physical cache path on disk.
>     *
>     *        @return        A file representing the physical cache location.
>     */
82,86c87,91
<    *        Get the root directory for persisting the cache on disk.
<    *        This path includes scope and sessionId, if any.
<    *
<    *        @return        A String representing the root directory.
<    */
---
>     *        Get the root directory for persisting the cache on disk.
>     *        This path includes scope and sessionId, if any.
>     *
>     *        @return        A String representing the root directory.
>     */
92,95c97,100
<  *        Get the servlet context tmp directory.
<  *
<  *        @return        A file representing the servlet context tmp directory.
<  */
---
>     *        Get the servlet context tmp directory.
>     *
>     *        @return        A file representing the servlet context tmp directory.
>     */
101,106c106,111
<  * Verify if a group exists in the cache
<  *
<  * @param group The group name to check
<  * @return True if it exists
<  * @throws CachePersistenceException
<  */
---
>     * Verify if a group exists in the cache
>     *
>     * @param group The group name to check
>     * @return True if it exists
>     * @throws CachePersistenceException
>     */
118,123c123,128
<  * Verify if an object is currently stored in the cache
<  *
<  * @param key The object key
<  * @return True if it exists
<  * @throws CachePersistenceException
<  */
---
>     * Verify if an object is currently stored in the cache
>     *
>     * @param key The object key
>     * @return True if it exists
>     * @throws CachePersistenceException
>     */
135,138c140,143
<  * Clears the whole cache directory, starting from the root
<  *
<  * @throws CachePersistenceException
<  */
---
>     * Clears the whole cache directory, starting from the root
>     *
>     * @throws CachePersistenceException
>     */
144,148c149,153
<  * Initialises this <tt>BasicDiskPersistenceListener</tt> using the supplied
<  * configuration.
<  *
<  * @param config The OSCache configuration
<  */
---
>     * Initialises this <tt>BasicDiskPersistenceListener</tt> using the supplied
>     * configuration.
>     *
>     * @param config The OSCache configuration
>     */
178,182c183,187
<  * Delete a single cache entry.
<  *
<  * @param key The object key to delete
<  * @throws CachePersistenceException
<  */
---
>     * Delete a single cache entry.
>     *
>     * @param key The object key to delete
>     * @throws CachePersistenceException
>     */
189,193c194,198
<  * Deletes an entire group from the cache.
<  *
<  * @param groupName The name of the group to delete
<  * @throws CachePersistenceException
<  */
---
>     * Deletes an entire group from the cache.
>     *
>     * @param groupName The name of the group to delete
>     * @throws CachePersistenceException
>     */
200,205c205,210
<  * Retrieve an object from the disk
<  *
<  * @param key The object key
<  * @return The retrieved object
<  * @throws CachePersistenceException
<  */
---
>     * Retrieve an object from the disk
>     *
>     * @param key The object key
>     * @return The retrieved object
>     * @throws CachePersistenceException
>     */
211,218c216,223
<  * Retrieves a group from the cache, or <code>null</code> if the group
<  * file could not be found.
<  *
<  * @param groupName The name of the group to retrieve.
<  * @return A <code>Set</code> containing keys of all of the cache
<  * entries that belong to this group.
<  * @throws CachePersistenceException
<  */
---
>     * Retrieves a group from the cache, or <code>null</code> if the group
>     * file could not be found.
>     *
>     * @param groupName The name of the group to retrieve.
>     * @return A <code>Set</code> containing keys of all of the cache
>     * entries that belong to this group.
>     * @throws CachePersistenceException
>     */
230,235c235,240
<  * Stores an object in cache
<  *
<  * @param key The object's key
<  * @param obj The object to store
<  * @throws CachePersistenceException
<  */
---
>     * Stores an object in cache
>     *
>     * @param key The object's key
>     * @param obj The object to store
>     * @throws CachePersistenceException
>     */
242,244c247,249
<  * Stores a group in the persistent cache. This will overwrite any existing
<  * group with the same name
<  */
---
>     * Stores a group in the persistent cache. This will overwrite any existing
>     * group with the same name
>     */
251,256c256,261
<  * Allows to translate to the temp dir of the servlet container if cachePathStr
<  * is javax.servlet.context.tempdir.
<  *
<  * @param cachePathStr  Cache path read from the properties file.
<  * @return Adjusted cache path
<  */
---
>     * Allows to translate to the temp dir of the servlet container if cachePathStr
>     * is javax.servlet.context.tempdir.
>     *
>     * @param cachePathStr  Cache path read from the properties file.
>     * @return Adjusted cache path
>     */
266,269c271,274
<  *        Set caching to file on or off.
<  *  If the <code>cache.path</code> property exists, we assume file caching is turned on.
<  *        By the same token, to turn off file caching just remove this property.
<  */
---
>     *        Set caching to file on or off.
>     *  If the <code>cache.path</code> property exists, we assume file caching is turned on.
>     *        By the same token, to turn off file caching just remove this property.
>     */
314,319c319,324
<  * Stores an object using the supplied file object
<  *
<  * @param file The file to use for storing the object
<  * @param obj the object to store
<  * @throws CachePersistenceException
<  */
---
>     * Stores an object using the supplied file object
>     *
>     * @param file The file to use for storing the object
>     * @param obj the object to store
>     * @throws CachePersistenceException
>     */
365,369c370,374
<  * Build fully qualified cache file for the specified cache entry key.
<  *
<  * @param key   Cache Entry Key.
<  * @return File reference.
<  */
---
>     * Build fully qualified cache file for the specified cache entry key.
>     *
>     * @param key   Cache Entry Key.
>     * @return File reference.
>     */
379,383c384,388
<  * Build cache file name for the specified cache entry key.
<  *
<  * @param key   Cache Entry Key.
<  * @return char[] file name.
<  */
---
>     * Build cache file name for the specified cache entry key.
>     *
>     * @param key   Cache Entry Key.
>     * @return char[] file name.
>     */
387,391c392,396
<  * Builds a fully qualified file name that specifies a cache group entry.
<  *
<  * @param group The name of the group
<  * @return A File reference
<  */
---
>     * Builds a fully qualified file name that specifies a cache group entry.
>     *
>     * @param group The name of the group
>     * @return A File reference
>     */
409,414c414,419
<  * This allows to persist different scopes in different path in the case of
<  * file caching.
<  *
<  * @param scope   Cache scope.
<  * @return The scope subpath
<  */
---
>     * This allows to persist different scopes in different path in the case of
>     * file caching.
>     *
>     * @param scope   Cache scope.
>     * @return The scope subpath
>     */
424,429c429,434
<  * Clears a whole directory, starting from the specified
<  * directory
<  *
<  * @param baseDirName The root directory to delete
<  * @throws CachePersistenceException
<  */
---
>     * Clears a whole directory, starting from the specified
>     * directory
>     *
>     * @param baseDirName The root directory to delete
>     * @throws CachePersistenceException
>     */
456,462c461,467
<  * Retrives a serialized object from the supplied file, or returns
<  * <code>null</code> if the file does not exist.
<  *
<  * @param file The file to deserialize
<  * @return The deserialized object
<  * @throws CachePersistenceException
<  */
---
>     * Retrives a serialized object from the supplied file, or returns
>     * <code>null</code> if the file does not exist.
>     *
>     * @param file The file to deserialize
>     * @return The deserialized object
>     * @throws CachePersistenceException
>     */