com.flexive.shared.mbeans
Interface FxCacheMBean

All Superinterfaces:
FxBackingCache
All Known Implementing Classes:
FxCacheProxy

public interface FxCacheMBean
extends FxBackingCache

Tree cache interface

Author:
UCS

Field Summary
static int STREAMING_PORT
          Port of the streaming server
 
Fields inherited from interface com.flexive.shared.cache.FxBackingCache
SYSTEM_UP_KEY
 
Method Summary
 void create()
          Creates and starts up the cache
 void destroy()
          Shutdown
 java.lang.String getDeploymentId()
          Return the Id of this deployment of flexive (used to check existance of running mbean server on redeployment)
 long getNodeStartTime()
          Returns the time this node was started up.
 long getSystemStartTime()
          Returns the time the system was started up.
 boolean globalExists(java.lang.String path, java.lang.Object key)
          A global exists
 java.lang.Object globalGet(java.lang.String path, java.lang.Object key)
          A global get
 java.util.Set globalGetKeys(java.lang.String path)
          A global getKeys
 void globalPut(java.lang.String path, java.lang.Object key, java.lang.Object value)
          A global put
 void globalRemove(java.lang.String path)
          A global remove
 void globalRemove(java.lang.String path, java.lang.Object key)
          A global remove
 void reloadEnvironment(java.lang.Integer divisionId)
          Force a reload for given division
 void setEvictionStrategy(java.lang.Integer divisionId, java.lang.String path, java.lang.Integer maxContents, java.lang.Integer timeToIdle, java.lang.Integer timeToLive)
          Set the eviction strategy for a path (if the backing cache supports this)
 void setEvictionStrategy(java.lang.Integer divisionId, java.lang.String path, java.lang.Integer maxContents, java.lang.Integer timeToIdle, java.lang.Integer timeToLive, java.lang.Boolean overwrite)
          Set the eviction strategy for a path (if the backing cache supports this)
 
Methods inherited from interface com.flexive.shared.cache.FxBackingCache
exists, get, getCache, getChildrenNames, getKeys, put, remove, remove
 

Field Detail

STREAMING_PORT

static final int STREAMING_PORT
Port of the streaming server

See Also:
Constant Field Values
Method Detail

create

void create()
            throws java.lang.Exception
Creates and starts up the cache

Throws:
java.lang.Exception - on errors

destroy

void destroy()
             throws java.lang.Exception
Shutdown

Throws:
java.lang.Exception - on errors

getSystemStartTime

long getSystemStartTime()
Returns the time the system was started up.

Returns:
the time the system was started up.

getNodeStartTime

long getNodeStartTime()
Returns the time this node was started up.

Returns:
the time this node was started

getDeploymentId

java.lang.String getDeploymentId()
Return the Id of this deployment of flexive (used to check existance of running mbean server on redeployment)

Returns:
deployment id

globalGetKeys

java.util.Set globalGetKeys(java.lang.String path)
                            throws FxCacheException
A global getKeys

Parameters:
path - path
Returns:
key set
Throws:
FxCacheException - on errors
See Also:
FxBackingCache.getKeys(String)

globalGet

java.lang.Object globalGet(java.lang.String path,
                           java.lang.Object key)
                           throws FxCacheException
A global get

Parameters:
path - path
key - key
Returns:
value
Throws:
FxCacheException - on errors
See Also:
FxBackingCache.get(String,Object)

globalExists

boolean globalExists(java.lang.String path,
                     java.lang.Object key)
                     throws FxCacheException
A global exists

Parameters:
path - path
key - key
Returns:
exists
Throws:
FxCacheException - on errors
See Also:
FxBackingCache.exists(String,Object)

globalPut

void globalPut(java.lang.String path,
               java.lang.Object key,
               java.lang.Object value)
               throws FxCacheException
A global put

Parameters:
path - path
key - key
value - value
Throws:
FxCacheException - on errors
See Also:
FxBackingCache.put(String,Object,Object)

globalRemove

void globalRemove(java.lang.String path)
                  throws FxCacheException
A global remove

Parameters:
path - path
Throws:
FxCacheException - on errors
See Also:
FxBackingCache.remove(String)

globalRemove

void globalRemove(java.lang.String path,
                  java.lang.Object key)
                  throws FxCacheException
A global remove

Parameters:
path - path
key - key
Throws:
FxCacheException - on errors
See Also:
FxBackingCache.remove(String,Object)

reloadEnvironment

void reloadEnvironment(java.lang.Integer divisionId)
                       throws java.lang.Exception
Force a reload for given division

Parameters:
divisionId - division
Throws:
java.lang.Exception - on errors

setEvictionStrategy

void setEvictionStrategy(java.lang.Integer divisionId,
                         java.lang.String path,
                         java.lang.Integer maxContents,
                         java.lang.Integer timeToIdle,
                         java.lang.Integer timeToLive)
                         throws FxCacheException
Set the eviction strategy for a path (if the backing cache supports this)

Parameters:
divisionId - division
path - path
maxContents - max. number of entries to allow (0=unlimited)
timeToIdle - time a value has to be idle to be evicted (0=forever)
timeToLive - time to live (0=forever)
Throws:
FxCacheException - on cache errors

setEvictionStrategy

void setEvictionStrategy(java.lang.Integer divisionId,
                         java.lang.String path,
                         java.lang.Integer maxContents,
                         java.lang.Integer timeToIdle,
                         java.lang.Integer timeToLive,
                         java.lang.Boolean overwrite)
                         throws FxCacheException
Set the eviction strategy for a path (if the backing cache supports this)

Parameters:
divisionId - division
path - path
maxContents - max. number of entries to allow (0=unlimited)
timeToIdle - time a value has to be idle to be evicted (0=forever)
timeToLive - time to live (0=forever)
overwrite - if an existing policy should be overwritten
Throws:
FxCacheException - on cache errors
Since:
3.0.2