org.castor.cache

Interface CacheFactory

All Known Implementing Classes:

AbstractCacheFactory, CoherenceCacheFactory, CountLimitedFactory, EHCacheFactory, FIFOHashbeltFactory, FKCacheFactory, GigaspacesCacheFactory, JCacheFactory, JcsCacheFactory, LRUHashbeltFactory, NoCacheFactory, OsCacheFactory, TimeLimitedFactory, UnlimitedFactory

public interface CacheFactory

A factory for instantiating Cache implementations. To provide an implementation for a specific cache type, please implement this interface. When providing your own cache instance as explained in the JavaDocs for this package, please make sure that you provide valid values for the name and className properties.

Since:

1.0

Version:

$Revision: 6907 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $

Author:

Werner Guttmann, Ralf Joachim

Method Summary

Methods

Modifier and Type	Method and Description
Cache	getCache(ClassLoader classLoader) Instantiates an instance of the cache implementation this factory is responsible for using the given classloader.
String	getCacheClassName() Returns the full class name of the underlying cache implementation.
String	getCacheType() Returns the short alias cache type for this factory instance.
void	shutdown() Allows for cache-specific shutdown operations and resource cleanup.

Method Detail

getCache

Cache getCache(ClassLoader classLoader)
               throws CacheAcquireException

Instantiates an instance of the cache implementation this factory is responsible for using the given classloader.

Parameters:

classLoader - A ClassLoader instance.

Returns:

A Cache instance.

Throws:

CacheAcquireException - Problem instantiating a cache instance.

getCacheType

String getCacheType()

Returns the short alias cache type for this factory instance.

Returns:

The short alias cache type.

getCacheClassName

String getCacheClassName()

Returns the full class name of the underlying cache implementation.

Returns:

The full cache class name.

shutdown

void shutdown()

Allows for cache-specific shutdown operations and resource cleanup.