com.dotmarketing.business
Interface DotCacheAdministrator

All Known Implementing Classes:
DotGuavaCacheAdministratorImpl, DotJBCacheAdministratorImpl, DotJBCacheAdministratorLegacyImpl

public interface DotCacheAdministrator

Since:
1.6
Author:
Jason Tesser

Field Summary
static java.lang.String ROOT_GOUP
           
 
Method Summary
 void flushAll()
          Flush the entire cache immediately.
 void flushAlLocalOnlyl()
          Flushes all cache locally
 void flushGroup(java.lang.String group)
          Flushes all items that belong to the specified group.
 void flushGroupLocalOnly(java.lang.String group)
          Flushes all items that belong to the specified group on the local server only
 java.lang.Object get(java.lang.String key, java.lang.String group)
          Get an object from the cache
 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getCacheStatsList()
           
 java.lang.Class getImplementationClass()
           
 DotCacheAdministrator getImplementationObject()
           
 org.jgroups.JChannel getJGroupsChannel()
           
 java.util.Set<java.lang.String> getKeys(java.lang.String group)
          Returns all keys within the group
 void put(java.lang.String key, java.lang.Object content, java.lang.String group)
          Puts an object in a cache This will create journal entries for other servers in a clustered environment.
 void remove(java.lang.String key, java.lang.String group)
          Remove an object from the cache.
 void removeLocalOnly(java.lang.String key, java.lang.String group)
          Remove an object from the cache on the local server only
 void shutdown()
          Should be called on shutdown of the dotcms
 

Field Detail

ROOT_GOUP

static final java.lang.String ROOT_GOUP
See Also:
Constant Field Values
Method Detail

getKeys

java.util.Set<java.lang.String> getKeys(java.lang.String group)
Returns all keys within the group

Parameters:
group -
Returns:

flushAll

void flushAll()
Flush the entire cache immediately.


flushGroup

void flushGroup(java.lang.String group)
Flushes all items that belong to the specified group.

Parameters:
group -

flushAlLocalOnlyl

void flushAlLocalOnlyl()
Flushes all cache locally


flushGroupLocalOnly

void flushGroupLocalOnly(java.lang.String group)
Flushes all items that belong to the specified group on the local server only

Parameters:
group -

get

java.lang.Object get(java.lang.String key,
                     java.lang.String group)
                     throws DotCacheException
Get an object from the cache

Parameters:
key -
Returns:
Throws:
DotCacheException

put

void put(java.lang.String key,
         java.lang.Object content,
         java.lang.String group)
Puts an object in a cache This will create journal entries for other servers in a clustered environment.

Parameters:
key -
content -
groups -

remove

void remove(java.lang.String key,
            java.lang.String group)
Remove an object from the cache. This will create journal entries for other servers in a clustered environment.

Parameters:
key -

removeLocalOnly

void removeLocalOnly(java.lang.String key,
                     java.lang.String group)
Remove an object from the cache on the local server only

Parameters:
key -

shutdown

void shutdown()
Should be called on shutdown of the dotcms


getJGroupsChannel

org.jgroups.JChannel getJGroupsChannel()

getCacheStatsList

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getCacheStatsList()

getImplementationClass

java.lang.Class getImplementationClass()

getImplementationObject

DotCacheAdministrator getImplementationObject()


Copyright © 2013 dotCMS Inc. All Rights Reserved.