com.ibm.jaggr.core.cache

Interface ICache

All Superinterfaces:

Serializable

All Known Implementing Classes:

CacheImpl

public interface ICache
extends Serializable

The aggregator cache is the repository for cached module builds and layers.

Method Summary

Methods

Modifier and Type	Method and Description
void	dump(Writer writer, Pattern filter) Outputs a string representation of this cache object.
IGenericCache	getCache(String key) Returns the named generic cache.
long	getCreated() Returns the date and time that this cache object was created.
IGzipCache	getGzipCache() Returns the cache of gzipped modules
ILayerCache	getLayers() Returns the cache of layer build cache entries.
IModuleCache	getModules() Returns the cache of module build cache entries
IGenericCache	putIfAbsent(String key, IGenericCache cache) Adds the named cache object to the Aggregator cache.
boolean	remove(String key) Removes the named cache object with the specified key.
void	setAggregator(IAggregator aggregator) Called for newly created (or de-serialized) caches to set the aggregator instance for the cache.

Method Detail

getLayers

ILayerCache getLayers()

Returns the cache of layer build cache entries.

Returns:

The layer build cache entries

getModules

IModuleCache getModules()

Returns the cache of module build cache entries

Returns:

The module build cache entries

getGzipCache

IGzipCache getGzipCache()

Returns the cache of gzipped modules

Returns:

the gzip module cache

getCache

IGenericCache getCache(String key)

Returns the named generic cache. The named cache must have been added using putIfAbsent(String, IGenericCache).

Parameters:

key - the cache name

Returns:

the generic cache or null if it does not exist

putIfAbsent

IGenericCache putIfAbsent(String key,
                        IGenericCache cache)

Adds the named cache object to the Aggregator cache. Implements the same semantics as ConcurrentMap.putIfAbsent(Object, Object). Once a generic cache object is added, it persists across server restarts. When the Aggregator cache is cleared, the IGenericCache.newInstance() method is called to create a new cache object for the updated cache.

Parameters:

key - the cache name

cache - the new cache object

Returns:

null, if an entry with the specified key did not already exist in the cache and the specified cache was added, else the previously existing entry.

remove

boolean remove(String key)

Removes the named cache object with the specified key.

Parameters:

key - name of the cache object to remove

Returns:

true if the specified cache object existed and was removed.

getCreated

long getCreated()

Returns the date and time that this cache object was created.

Returns:

The creation date of this cache

dump

void dump(Writer writer,
        Pattern filter)
          throws IOException

Outputs a string representation of this cache object. The filter string is just passed along to the module and layer caches and is not otherwise used by this method.

Parameters:

writer - The writer object to output the cache dump to

filter - A regular expression to filter the output. Passed along to the module and layer cache object toString() methods.

Throws:

IOException

setAggregator

void setAggregator(IAggregator aggregator)

Called for newly created (or de-serialized) caches to set the aggregator instance for the cache. Note that the aggregator may not be fully initialized at the time that this method is called and some aggregator methods (like IAggregator.getConfig() may return null if called from within this method.

Parameters:

aggregator - The aggregator instance for this cache object