OsCacheFactory (Castor JavaDoc)

java.lang.Object
- org.castor.cache.distributed.OsCacheFactory

All Implemented Interfaces:

CacheFactory
```
public final class OsCacheFactory
extends java.lang.Object
implements CacheFactory
```
Implements CacheFactory for the OsCache implementation of Cache.

Since:

1.0

Version:

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

Author:

Werner Guttmann, Ralf Joachim

Constructor Summary

Constructors
Constructor Description

OsCacheFactory()

Constructors
Constructor	Description
`OsCacheFactory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Cache`	`getCache(java.lang.ClassLoader classLoader)`	Instantiates an instance of the cache implementation this factory is responsible for using the given classloader.
`Cache`	`getCache(java.lang.String implementation, java.lang.ClassLoader classLoader)`	Normally called to initialize OsCache.
`java.lang.String`	`getCacheClassName()`	Returns the full class name of the underlying cache implementation.
`java.lang.String`	`getCacheType()`	Returns the short alias cache type for this factory instance.
`void`	`shutdown()`	Allows for cache-specific shutdown operations and resource cleanup.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OsCacheFactory
```
public OsCacheFactory()
```
- Method Detail
  - getCache
```
public Cache getCache(java.lang.ClassLoader classLoader)
               throws CacheAcquireException
```
    Instantiates an instance of the cache implementation this factory is responsible for using the given classloader.
    
    Specified by:
    
    getCache in interface CacheFactory
    
    Parameters:
    
    classLoader - A ClassLoader instance.
    
    Returns:
    
    A Cache instance.
    
    Throws:
    
    CacheAcquireException - Problem instantiating a cache instance.
  - getCache
```
public Cache getCache(java.lang.String implementation,
                      java.lang.ClassLoader classLoader)
               throws CacheAcquireException
```
    Normally called to initialize OsCache. To be able to test the method without having com.opensymphony.oscache.general.GeneralCacheAdministrator implementation, it can also be called with a test implementations classname.
    
    Parameters:
    
    implementation - Cache implementation classname to initialize.
    
    classLoader - A ClassLoader instance.
    
    Returns:
    
    A Cache instance.
    
    Throws:
    
    CacheAcquireException - Problem instantiating a cache instance.
  - getCacheType
```
public java.lang.String getCacheType()
```
    Returns the short alias cache type for this factory instance.
    
    Specified by:
    
    getCacheType in interface CacheFactory
    
    Returns:
    
    The short alias cache type.
  - getCacheClassName
```
public java.lang.String getCacheClassName()
```
    Returns the full class name of the underlying cache implementation.
    
    Specified by:
    
    getCacheClassName in interface CacheFactory
    
    Returns:
    
    The full cache class name.
  - shutdown
```
public void shutdown()
```
    Allows for cache-specific shutdown operations and resource cleanup.
    
    Specified by:
    
    shutdown in interface CacheFactory

Class OsCacheFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OsCacheFactory

Method Detail

getCache

getCache

getCacheType

getCacheClassName

shutdown