Package org.opencms.cache
Class CmsMemoryObjectCache
- java.lang.Object
-
- org.opencms.cache.CmsMemoryObjectCache
-
- All Implemented Interfaces:
I_CmsEventListener
public final class CmsMemoryObjectCache extends java.lang.Object implements I_CmsEventListener
A singleton memory cache, that stores objects related with keys.This cache listens to the
I_CmsEventListener.EVENT_CLEAR_CACHES
event only.- Since:
- 6.2.3
-
-
Field Summary
-
Fields inherited from interface org.opencms.main.I_CmsEventListener
EVENT_BEFORE_PUBLISH_PROJECT, EVENT_CLEAR_CACHES, EVENT_CLEAR_OFFLINE_CACHES, EVENT_CLEAR_ONLINE_CACHES, EVENT_CLEAR_PRINCIPAL_CACHES, EVENT_FLEX_CACHE_CLEAR, EVENT_FLEX_PURGE_JSP_REPOSITORY, EVENT_FULLSTATIC_EXPORT, EVENT_GROUP_MODIFIED, EVENT_LOGIN_USER, EVENT_OU_MODIFIED, EVENT_PROJECT_MODIFIED, EVENT_PROPERTY_DEFINITION_CREATED, EVENT_PROPERTY_DEFINITION_MODIFIED, EVENT_PROPERTY_MODIFIED, EVENT_PUBLISH_PROJECT, EVENT_REBUILD_SEARCHINDEXES, EVENT_REINDEX_OFFLINE, EVENT_REINDEX_ONLINE, EVENT_RESOURCE_AND_PROPERTIES_MODIFIED, EVENT_RESOURCE_COPIED, EVENT_RESOURCE_CREATED, EVENT_RESOURCE_DELETED, EVENT_RESOURCE_MODIFIED, EVENT_RESOURCE_MOVED, EVENT_RESOURCES_AND_PROPERTIES_MODIFIED, EVENT_RESOURCES_MODIFIED, EVENT_SITEMAP_CHANGED, EVENT_UPDATE_EXPORTS, EVENT_USER_MODIFIED, KEY_CHANGE, KEY_DBCONTEXT, KEY_GROUP_ID, KEY_GROUP_NAME, KEY_INDEX_NAMES, KEY_IS_ONLINE, KEY_OU_ID, KEY_OU_NAME, KEY_PROJECTID, KEY_PUBLISHID, KEY_PUBLISHLIST, KEY_REINDEX_RELATED, KEY_REPORT, KEY_RESOURCE, KEY_RESOURCES, KEY_SKIPINDEX, KEY_USER_ACTION, KEY_USER_CHANGES, KEY_USER_ID, KEY_USER_NAME, LISTENERS_FOR_ALL_EVENTS, VALUE_CREATE_SIBLING, VALUE_GROUP_MODIFIED_ACTION_CREATE, VALUE_GROUP_MODIFIED_ACTION_DELETE, VALUE_GROUP_MODIFIED_ACTION_WRITE, VALUE_OU_MODIFIED_ACTION_CREATE, VALUE_OU_MODIFIED_ACTION_DELETE, VALUE_USER_MODIFIED_ACTION_ADD_USER_TO_GROUP, VALUE_USER_MODIFIED_ACTION_CREATE_USER, VALUE_USER_MODIFIED_ACTION_DELETE_USER, VALUE_USER_MODIFIED_ACTION_REMOVE_USER_FROM_GROUP, VALUE_USER_MODIFIED_ACTION_RESET_PASSWORD, VALUE_USER_MODIFIED_ACTION_SET_OU, VALUE_USER_MODIFIED_ACTION_WRITE_USER
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
cmsEvent(CmsEvent event)
Acknowledge the occurrence of the specified event, implement this method to check for CmsEvents in your class.java.lang.Object
getCachedObject(java.lang.Class<?> owner, java.lang.String key)
Returns an object from the cache.static CmsMemoryObjectCache
getInstance()
Returns the singleton memory Object cache instance.void
putCachedObject(java.lang.Class<?> owner, java.lang.String key, java.lang.Object value)
Puts an object into the cache.protected void
registerEventListener()
Registers all required event listeners.
-
-
-
Method Detail
-
getInstance
public static CmsMemoryObjectCache getInstance()
Returns the singleton memory Object cache instance.- Returns:
- the singleton memory Object cache instance
-
cmsEvent
public void cmsEvent(CmsEvent event)
Description copied from interface:I_CmsEventListener
Acknowledge the occurrence of the specified event, implement this method to check for CmsEvents in your class.- Specified by:
cmsEvent
in interfaceI_CmsEventListener
- Parameters:
event
- CmsEvent that has occurred- See Also:
I_CmsEventListener.cmsEvent(org.opencms.main.CmsEvent)
-
getCachedObject
public java.lang.Object getCachedObject(java.lang.Class<?> owner, java.lang.String key)
Returns an object from the cache.- Parameters:
owner
- the owner class of the cached object (used to ensure keys don't overlap)key
- the key to lookup the object for- Returns:
- an object from the cache, or
null
if no object matches the given key
-
putCachedObject
public void putCachedObject(java.lang.Class<?> owner, java.lang.String key, java.lang.Object value)
Puts an object into the cache.- Parameters:
owner
- the owner class of the cached object (used to ensure keys don't overlap)key
- the key to store the object atvalue
- the object to store
-
registerEventListener
protected void registerEventListener()
Registers all required event listeners.
-
-