Package org.opencms.cache

Class CmsVfsCache

java.lang.Object

org.opencms.cache.CmsVfsCache

All Implemented Interfaces:

I_CmsEventListener

Direct Known Subclasses:

CmsADECache, CmsVfsMemoryObjectCache

public abstract class CmsVfsCache
extends Object
implements I_CmsEventListener

Configurable VFS based cache, for caching objects related to offline/online resources.

Since:

7.6

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CmsVfsCache()	Initializes the cache.

Method Summary

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.
protected abstract void	flush(boolean online)	Flushes the caches.
protected void	registerEventListener()	Adds this instance as an event listener to the CMS event manager.
void	shutdown()	Clean up at shutdown time.
protected abstract void	uncacheResource(CmsResource resource)	Removes a cached resource from the cache.
protected void	uncacheResources(List<CmsResource> resources)	Removes a bunch of cached resources from the cache.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsVfsCache

protected CmsVfsCache()

Initializes the cache. Only intended to be called during startup.

Method Details

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 interface I_CmsEventListener

Parameters:

event - CmsEvent that has occurred

See Also:

• I_CmsEventListener.cmsEvent(org.opencms.main.CmsEvent)

shutdown

public void shutdown()

Clean up at shutdown time. Only intended to be called at system shutdown.

See Also:

• OpenCmsCore.shutDown()

flush

protected abstract void flush(boolean online)

Flushes the caches.

Parameters:

online - if to flush the online or offline caches

registerEventListener

protected void registerEventListener()

Adds this instance as an event listener to the CMS event manager.

uncacheResource

protected abstract void uncacheResource(CmsResource resource)

Removes a cached resource from the cache.

Parameters:

resource - the resource

uncacheResources

protected void uncacheResources(List<CmsResource> resources)

Removes a bunch of cached resources from the cache.

Parameters:

resources - a list of resources

See Also:

• uncacheResource(CmsResource)