com.ibm.jaggr.core.cache

Interface ICacheManager

All Known Implementing Classes:

CacheManagerImpl

public interface ICacheManager

The cache manager for the aggregator service.

• Implements functionality used by console commands for dumping and clearing the cache
• Provides a thread executor service for the module builders
• Provides utility methods for asynchronously creating and deleting cache files
• Provides access to the ICache object

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ICacheManager.CreateCompletionCallback

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCache() Clears the cache
void	createCacheFileAsync(String fileNamePrefix, InputStream content, ICacheManager.CreateCompletionCallback callback) Utility method to create a cache file on an asynchronous thread.
void	createCacheFileAsync(String fileNamePrefix, Reader content, ICacheManager.CreateCompletionCallback callback) Utility method to create a cache file on an asynchronous thread.
void	createNamedCacheFileAsync(String fileName, InputStream content, ICacheManager.CreateCompletionCallback callback) Utility method to create a cache file on an asynchronous thread.
void	createNamedCacheFileAsync(String filename, Reader content, ICacheManager.CreateCompletionCallback callback) Utility method to create a cache file on an asynchronous thread.
void	deleteFileDelayed(String filename) Utility method to asynchronously delete cache files after a delay period specified by IOptions.getDeleteDelay().
void	dumpCache(Writer writer, Pattern filter) Outputs the string representation of the cache to the specified writer, filtered using the specified regular expression pattern
void	externalizeCacheObjectAsync(String filename, Object object, ICacheManager.CreateCompletionCallback callback) Utility method to externalize an object on an asynchronous thread.
ICache	getCache() Returns the current cache object
File	getCacheDir() Returns the File object for the cache directory.
void	serializeCache() Synchronously serializes the cache object to dish.

Method Detail

clearCache

void clearCache()

Clears the cache

dumpCache

void dumpCache(Writer writer,
             Pattern filter)
               throws IOException

Outputs the string representation of the cache to the specified writer, filtered using the specified regular expression pattern

Parameters:

writer - The writer object to output to

filter - The regular expression filter, or null

Throws:

IOException

getCache

ICache getCache()

Returns the current cache object

Returns:

The cache object

createNamedCacheFileAsync

void createNamedCacheFileAsync(String fileName,
                             InputStream content,
                             ICacheManager.CreateCompletionCallback callback)

Utility method to create a cache file on an asynchronous thread.

Parameters:

fileName - The filename of the cache file. The cache file with the specified name will be created in the cache directory. The filename may not include a path component

content - The InputStream to read the file contents from

callback - The completion callback

createCacheFileAsync

void createCacheFileAsync(String fileNamePrefix,
                        InputStream content,
                        ICacheManager.CreateCompletionCallback callback)

Utility method to create a cache file on an asynchronous thread.

Parameters:

fileNamePrefix - The prefix to use for the generated file name

content - The InputStream to read the file contents from

callback - The completion callback

createNamedCacheFileAsync

void createNamedCacheFileAsync(String filename,
                             Reader content,
                             ICacheManager.CreateCompletionCallback callback)

Utility method to create a cache file on an asynchronous thread.

Parameters:

filename - The filename of the cache file. The cache file with the specified name will be created in the cache directory. The filename may not include a path component

content - The Reader to read the file contents from

callback - The completion callback

createCacheFileAsync

void createCacheFileAsync(String fileNamePrefix,
                        Reader content,
                        ICacheManager.CreateCompletionCallback callback)

Utility method to create a cache file on an asynchronous thread.

Parameters:

fileNamePrefix - The prefix to use for the generated file name

content - The Reader to read the file contents from

callback - The completion callback

externalizeCacheObjectAsync

void externalizeCacheObjectAsync(String filename,
                               Object object,
                               ICacheManager.CreateCompletionCallback callback)

Utility method to externalize an object on an asynchronous thread.

Parameters:

filename - The prefix to use for the generated file name

object - The object to externalize

callback - The completion callback

deleteFileDelayed

void deleteFileDelayed(String filename)

Utility method to asynchronously delete cache files after a delay period specified by IOptions.getDeleteDelay(). The idea is to delay deleting the cache file long enough so that any threads which may be using the file at the time this method is called have finished with it and no longer need it. Note that the file may be deleted before the delay time has expired if the aggregator is shutdown before the delay time has expired

Parameters:

filename - The name of the cache file to delete.

getCacheDir

File getCacheDir()

Returns the File object for the cache directory.

Returns:

The cache directory

serializeCache

void serializeCache()

Synchronously serializes the cache object to dish.