com.flexive.shared.cache
Interface FxBackingCache

All Known Subinterfaces:
FxCacheMBean
All Known Implementing Classes:
AbstractJBossTreeCacheWrapper, FxCacheProxy, FxJBossTreeCacheMBeanWrapper, FxJBossTreeCacheWrapper

public interface FxBackingCache

Backing Cache for storing environment and contents

Author:
Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)

Field Summary
static java.lang.String SYSTEM_UP_KEY
          Cache key for the system up time
 
Method Summary
 boolean exists(java.lang.String path, java.lang.Object key)
          Checks if the given key exists under the given path.
 java.lang.Object get(java.lang.String path, java.lang.Object key)
          Reads a entry from the division cache that the current request is in.
 org.jboss.cache.Cache<java.lang.Object,java.lang.Object> getCache()
          Get the wrapped cache
 java.util.Set getChildrenNames(java.lang.String path)
          Get all child nodes for a path
 java.util.Set getKeys(java.lang.String path)
          Get all keys for a path
 void put(java.lang.String path, java.lang.Object key, java.lang.Object value)
          Puts a entry into the cache of the division the current request is in.
 void remove(java.lang.String path)
          Removes from the cache of the division the current request is in.
 void remove(java.lang.String path, java.lang.Object key)
          Removes a entry from the cache of the division the current request is in.
 

Field Detail

SYSTEM_UP_KEY

static final java.lang.String SYSTEM_UP_KEY
Cache key for the system up time

See Also:
Constant Field Values
Method Detail

get

java.lang.Object get(java.lang.String path,
                     java.lang.Object key)
                     throws FxCacheException
Reads a entry from the division cache that the current request is in.

Parameters:
path - path
key - key
Returns:
entry
Throws:
FxCacheException - on errors

exists

boolean exists(java.lang.String path,
               java.lang.Object key)
               throws FxCacheException
Checks if the given key exists under the given path.

Parameters:
path - path
key - key
Returns:
entry
Throws:
FxCacheException - on errors

put

void put(java.lang.String path,
         java.lang.Object key,
         java.lang.Object value)
         throws FxCacheException
Puts a entry into the cache of the division the current request is in.

Parameters:
path - path
key - key
value - value
Throws:
FxCacheException - on errors

remove

void remove(java.lang.String path)
            throws FxCacheException
Removes from the cache of the division the current request is in.

Parameters:
path - path
Throws:
FxCacheException - on errors

remove

void remove(java.lang.String path,
            java.lang.Object key)
            throws FxCacheException
Removes a entry from the cache of the division the current request is in.

Parameters:
path - path
key - key
Throws:
FxCacheException - on errors

getKeys

java.util.Set getKeys(java.lang.String path)
                      throws FxCacheException
Get all keys for a path

Parameters:
path - path
Returns:
set of keys
Throws:
FxCacheException - on errors

getChildrenNames

java.util.Set getChildrenNames(java.lang.String path)
                               throws FxCacheException
Get all child nodes for a path

Parameters:
path - path
Returns:
set of child names
Throws:
FxCacheException - on errors

getCache

org.jboss.cache.Cache<java.lang.Object,java.lang.Object> getCache()
                                                                  throws FxCacheException
Get the wrapped cache

Returns:
TreeCache
Throws:
FxCacheException - on errors