|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.gentics.api.lib.cache.PortalCache
public abstract class PortalCache
interface for various portal caches
Field Summary | |
---|---|
protected static boolean |
allowSetCacheClass
remember if the cacheClass has already been set to prevent re-initialisation |
protected static java.lang.Class |
cacheClass
|
protected static java.lang.reflect.Constructor |
cacheClassConstructor
|
protected static boolean |
disableCache
Defines if cache is disabled. |
protected java.lang.String |
region
|
Constructor Summary | |
---|---|
PortalCache(java.lang.String region)
create an instance for the given region |
Method Summary | |
---|---|
abstract void |
clear()
clears the whole cache |
abstract void |
clearGroup(java.lang.String groupName)
clears the a group in the cache |
abstract java.lang.Object |
get(java.lang.Object key)
retrieve an object from the cache |
static PortalCache |
getCache(java.lang.String region)
retrieve a PortalCache instance |
abstract PortalCacheAttributes |
getCacheAttributes(java.lang.Object key)
get the cache attributes for a cached entry. |
abstract PortalCacheAttributes |
getCacheAttributes(java.lang.String groupName,
java.lang.Object key)
get the cache attributes for a cached entry in a group. |
abstract java.lang.Object |
getFromGroup(java.lang.String groupName,
java.lang.Object key)
Retrieven an object from the group in the cache |
abstract void |
put(java.lang.Object key,
java.lang.Object object)
put an object into the cache |
abstract void |
put(java.lang.Object key,
java.lang.Object object,
PortalCacheAttributes attribs)
put an object into the cache, using some attributes to define caching methods. |
abstract void |
putIntoGroup(java.lang.String groupName,
java.lang.Object key,
java.lang.Object object)
Put an object into a group of the cache |
abstract void |
putIntoGroup(java.lang.String groupName,
java.lang.Object key,
java.lang.Object object,
PortalCacheAttributes attribs)
put an object into the a group in the cache, using some attributes to define caching methods. |
abstract void |
remove(java.lang.Object key)
remove an object from the cache |
abstract void |
removeFromGroup(java.lang.String groupName,
java.lang.Object key)
remove an object from a group in the cache |
static void |
setCacheClass(java.lang.String cacheClass)
sets the cache class to be used |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static java.lang.reflect.Constructor cacheClassConstructor
protected java.lang.String region
protected static boolean disableCache
protected static java.lang.Class cacheClass
protected static boolean allowSetCacheClass
Constructor Detail |
---|
public PortalCache(java.lang.String region)
region
- cache regionMethod Detail |
---|
public static PortalCache getCache(java.lang.String region) throws PortalCacheException
region
- cache region
PortalCacheException
public static void setCacheClass(java.lang.String cacheClass) throws PortalCacheException
cacheClass
- to be used, null for default implementation
PortalCacheException
public abstract java.lang.Object get(java.lang.Object key) throws PortalCacheException
key
- of the object
PortalCacheException
public abstract java.lang.Object getFromGroup(java.lang.String groupName, java.lang.Object key) throws PortalCacheException
groupName
- group namekey
- key of the object
PortalCacheException
public abstract void put(java.lang.Object key, java.lang.Object object) throws PortalCacheException
key
- of the objectobject
- to put inside the cache
PortalCacheException
public abstract void putIntoGroup(java.lang.String groupName, java.lang.Object key, java.lang.Object object) throws PortalCacheException
groupName
- name of the groupkey
- key of the objectobject
- from the cache or null
PortalCacheException
public abstract void put(java.lang.Object key, java.lang.Object object, PortalCacheAttributes attribs) throws PortalCacheException
key
- the key of the entry.object
- the object to put inside the cache.attribs
- the cache element attributes for the object.
PortalCacheException
public abstract void putIntoGroup(java.lang.String groupName, java.lang.Object key, java.lang.Object object, PortalCacheAttributes attribs) throws PortalCacheException
groupName
- group namekey
- the key of the entry.object
- the object to put inside the cache.attribs
- the cache element attributes for the object.
PortalCacheException
public abstract PortalCacheAttributes getCacheAttributes(java.lang.Object key) throws PortalCacheException
key
- the key of the entry.
PortalCacheException
public abstract PortalCacheAttributes getCacheAttributes(java.lang.String groupName, java.lang.Object key) throws PortalCacheException
groupName
- group namekey
- the key of the entry.
PortalCacheException
public abstract void remove(java.lang.Object key) throws PortalCacheException
key
- of object to be removed
PortalCacheException
public abstract void removeFromGroup(java.lang.String groupName, java.lang.Object key) throws PortalCacheException
groupName
- group namekey
- of object to be removed
PortalCacheException
public abstract void clear() throws PortalCacheException
PortalCacheException
public abstract void clearGroup(java.lang.String groupName) throws PortalCacheException
groupName
- group name
PortalCacheException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |