org.apache.openjpa.writebehind
Interface WriteBehindCacheManager

All Known Implementing Classes:
WriteBehindCacheManagerImpl

public interface WriteBehindCacheManager

Manages the system's WriteBehind cache(s). You can retrieve the data cache manager from the OpenJPAConfiguration.


Method Summary
 WriteBehindCache getSystemWriteBehindCache()
          Get the default WriteBehind cache.
 WriteBehindCache getWriteBehindCache(String name)
          Obtain a named WriteBehindCache.
 void initialize(OpenJPAConfiguration conf, ObjectValue writeBehindCache)
          Initialize the WriteBehindCacheManager
 

Method Detail

getSystemWriteBehindCache

WriteBehindCache getSystemWriteBehindCache()
Get the default WriteBehind cache.

Returns:
If WriteBehind mode is enabled the default WriteBehind cache will be returned. If WriteBehind is not enabled return null.

getWriteBehindCache

WriteBehindCache getWriteBehindCache(String name)
Obtain a named WriteBehindCache.

Parameters:
name - Name of the WriteBehindCache to obtain
Returns:
If WriteBehind mode is enabled a WriteBehindCache for 'name' will be returned (creating a new instance if needed). Otherwise return null.

initialize

void initialize(OpenJPAConfiguration conf,
                ObjectValue writeBehindCache)
Initialize the WriteBehindCacheManager

Parameters:
conf - OpenJPAConfiguration in use
writeBehindCache - The pluginvalue for WritBehindCache.


Copyright © 2006-2009 Apache Software Foundation. All Rights Reserved.