org.opencms.ade.configuration
Interface I_CmsGlobalConfigurationCache

All Known Implementing Classes:

CmsContainerConfigurationCache

public interface I_CmsGlobalConfigurationCache

This is interface is intended to be used in combination with the CmsGlobalConfigurationCacheEventHandler class.

It provides several method which allow the mentioned event handler class to update the cache object implementing this interface.

Method Summary

void	clear() Clears the cache.
void	remove(CmsPublishedResource pubRes) Removes a published resource from the cache.
void	remove(CmsResource resource) Removes a resource from the cache.
void	update(CmsPublishedResource pubRes) Updates the cache entry for the given published resource.
void	update(CmsResource resource) Updates the cache entry for the given resource.

Method Detail

clear

void clear()

Clears the cache.

remove

void remove(CmsPublishedResource pubRes)

Removes a published resource from the cache.

Parameters:

pubRes - the published resource

remove

void remove(CmsResource resource)

Removes a resource from the cache.

Parameters:

resource - the resource to remove

update

void update(CmsPublishedResource pubRes)

Updates the cache entry for the given published resource.

NOTE: Cache implementations should not directly read the updated resource in this method because it might interfere with other caches. Instead, the resource should be marked as updated and read the next time the cache is queried.

Parameters:

pubRes - a published resource

update

void update(CmsResource resource)

Updates the cache entry for the given resource.

NOTE: Cache implementations should not directly read the updated resource in this method because it might interfere with other caches. Instead, the resource should be marked as updated and read the next time the cache is queried.

Parameters:

resource - the resource for which the cache entry should be updated