org.opencms.monitor
Class CmsMemoryMonitor

java.lang.Object
  extended by org.opencms.monitor.CmsMemoryMonitor
All Implemented Interfaces:
I_CmsScheduledJob

public class CmsMemoryMonitor
extends java.lang.Object
implements I_CmsScheduledJob

Monitors OpenCms memory consumtion.

The memory monitor also provides all kind of caches used in the OpenCms core.

Since:
6.0.0
Version:
$Revision: 1.59 $
Author:
Carsten Weinholz, Michael Emmerich, Alexander Kandzior, Michael Moossen

Constructor Summary
CmsMemoryMonitor()
          Empty constructor, required by OpenCms scheduler.
 
Method Summary
 void cacheACL(java.lang.String key, CmsAccessControlList acl)
          Caches the given acl under the given cache key.
 void cacheContentDefinition(java.lang.String key, CmsXmlContentDefinition contentDefinition)
          Caches the given content definition under the given cache key.
 void cacheGroup(CmsGroup group)
          Caches the given group under its id AND fully qualified name.
 void cacheLocale(java.lang.String key, java.util.Locale locale)
          Caches the given locale under the given cache key.
 void cacheLock(CmsLock lock)
          Caches the given lock.
 void cacheMemObject(java.lang.String key, java.lang.Object obj)
          Caches the given object under the given cache key.
 void cacheOrgUnit(CmsOrganizationalUnit orgUnit)
          Caches the given organizational under its id AND the fully qualified name.
 void cachePermission(java.lang.String key, int permission)
          Caches the given permission check result under the given cache key.
 void cacheProject(CmsProject project)
          Caches the given project under its id AND the fully qualified name.
 void cacheProjectResources(java.lang.String key, java.util.List projectResources)
          Caches the given project resource list under the given cache key.
 void cacheProperty(java.lang.String key, CmsProperty property)
          Caches the given property under the given cache key.
 void cachePropertyList(java.lang.String key, java.util.List propertyList)
          Caches the given property list under the given cache key.
 void cachePublishJob(CmsPublishJobInfoBean publishJob)
          Caches the given publish job.
 void cachePublishJobInHistory(CmsPublishJobInfoBean publishJob)
          Caches the given publish job in the publish job history.
 void cacheResource(java.lang.String key, CmsResource resource)
          Caches the given resource under the given cache key.
 void cacheResourceList(java.lang.String key, java.util.List resourceList)
          Caches the given resource list under the given cache key.
 void cacheRole(java.lang.String key, boolean hasRole)
          Caches the given value under the given cache key.
 void cacheRoleList(java.lang.String key, java.util.List roles)
          Caches the given value under the given cache key.
 void cacheUser(CmsUser user)
          Caches the given user under its id AND the fully qualified name.
 void cacheUserGroups(java.lang.String key, java.util.List userGroups)
          Caches the given list of user groups under the given cache key.
 void cacheVfsObject(java.lang.String key, java.lang.Object obj)
          Caches the given vfs object under the given cache key.
 void cacheXmlPermanentEntity(java.lang.String systemId, byte[] content)
          Caches the given xml entity under the given system id.
 void cacheXmlTemporaryEntity(java.lang.String key, byte[] content)
          Caches the given xml entity under the given cache key.
 boolean enabled()
          Returns if monitoring is enabled.
 void flushACLs()
          Flushes the ACL cache.
 void flushContentDefinitions()
          Flushes the xml content definitions cache.
 void flushGroups()
          Flushes the group cache.
 void flushLocales()
          Flushes the locale cache.
 void flushLocks(java.util.Map newLocks)
          Flushes the locks cache.
 void flushMemObjects()
          Flushes the memory object cache.
 void flushOrgUnits()
          Flushes the organizational unit cache.
 void flushPermissions()
          Flushes the permission check result cache.
 void flushProjectResources()
          Flushes the project resources cache.
 void flushProjects()
          Flushes the project cache.
 void flushProperties()
          Flushes the property cache.
 void flushPropertyLists()
          Flushes the property list cache.
 void flushPublishJobHistory()
          Flushes the publish history.
 void flushPublishJobs()
          Flushes the publish queue.
 void flushResourceLists()
          Flushes the resource list cache.
 void flushResources()
          Flushes the resource cache.
 void flushRoleLists()
          Flushes the role lists cache.
 void flushRoles()
          Flushes the roles cache.
 void flushUserGroups()
          Flushes the user groups cache.
 void flushUsers()
          Flushes the users cache.
 void flushVfsObjects()
          Flushes the vfs object cache.
 void flushXmlPermanentEntities()
          Flushes the xml permanent entities cache.
 void flushXmlTemporaryEntities()
          Flushes the xml temporary entities cache.
 java.util.List getAllCachedLockPaths()
          Returns all cached lock root paths.
 java.util.List getAllCachedLocks()
          Returns all cached locks.
 java.util.List getAllCachedPublishJobs()
          Returns all cached publish jobs in the queue as ordered list.
 java.util.List getAllCachedPublishJobsInHistory()
          Returns all cached publish jobs in the history as ordered list.
 CmsAccessControlList getCachedACL(java.lang.String key)
          Returns the ACL cached with the given cache key or null if not found.
 CmsXmlContentDefinition getCachedContentDefinition(java.lang.String key)
          Returns the xml content definition cached with the given cache key or null if not found.
 CmsGroup getCachedGroup(java.lang.String key)
          Returns the group cached with the given cache key or null if not found.
 java.util.Locale getCachedLocale(java.lang.String key)
          Returns the locale cached with the given cache key or null if not found.
 CmsLock getCachedLock(java.lang.String rootPath)
          Returns the lock cached with the given root path or null if not found.
 java.lang.Object getCachedMemObject(java.lang.String key)
          Returns the memory object cached with the given cache key or null if not found.
 CmsOrganizationalUnit getCachedOrgUnit(java.lang.String key)
          Returns the organizational unit cached with the given cache key or null if not found.
 java.lang.Integer getCachedPermission(java.lang.String key)
          Returns the permission check result cached with the given cache key or null if not found.
 CmsProject getCachedProject(java.lang.String key)
          Returns the project cached with the given cache key or null if not found.
 java.util.List getCachedProjectResources(java.lang.String key)
          Returns the project resources list cached with the given cache key or null if not found.
 CmsProperty getCachedProperty(java.lang.String key)
          Returns the property cached with the given cache key or null if not found.
 java.util.List getCachedPropertyList(java.lang.String key)
          Returns the property list cached with the given cache key or null if not found.
 CmsPublishJobInfoBean getCachedPublishJob(java.lang.String key)
          Returns the publish job with the given cache key or null if not found.
 CmsPublishJobInfoBean getCachedPublishJobInHistory(java.lang.String key)
          Returns the publish job from the history with the given cache key or null if not found.
 CmsResource getCachedResource(java.lang.String key)
          Returns the resource cached with the given cache key or null if not found.
 java.util.List getCachedResourceList(java.lang.String key)
          Returns the resource list cached with the given cache key or null if not found.
 java.lang.Boolean getCachedRole(java.lang.String key)
          Returns the value cached with the given cache key or null if not found.
 java.util.List getCachedRoleList(java.lang.String key)
          Returns the value cached with the given cache key or null if not found.
 CmsUser getCachedUser(java.lang.String key)
          Returns the user cached with the given cache key or null if not found.
 java.util.List getCachedUserGroups(java.lang.String key)
          Returns the user groups list cached with the given cache key or null if not found.
 java.lang.Object getCachedVfsObject(java.lang.String key)
          Returns the vfs object cached with the given cache key or null if not found.
 byte[] getCachedXmlPermanentEntity(java.lang.String systemId)
          Returns the xml permanent entity content cached with the given systemId or null if not found.
 byte[] getCachedXmlTemporaryEntity(java.lang.String key)
          Returns the xml temporary entity content cached with the given cache key or null if not found.
 CmsMemoryMonitorConfiguration getConfiguration()
          Returns the configuration.
 CmsPublishJobInfoBean getFirstCachedPublishJob()
          Returns the next publish job from the publish job queue.
 int getLogCount()
          Returns the log count.
static int getMemorySize(java.lang.Object obj)
          Returns the size of objects that are instances of byte[], String, CmsFile,I_CmsLruCacheObject.
 void initialize(CmsSystemConfiguration configuration)
          Initializes the monitor with the provided configuration.
 boolean isMonitoring(java.lang.String key)
          Checks if there is a registered monitored object with the given key.
 java.lang.String launch(CmsObject cms, java.util.Map parameters)
          This method will be called when this scheduled job is executed.
 boolean lowMemory()
          Returns true if the system runs low on memory.
 void register(java.lang.String objectName, java.lang.Object object)
          Adds a new object to the monitor.
 boolean requiresPersistency()
          Checks if some kind of persistency is required.
 void shutdown()
          Flushes all cached objects.
 void uncacheContentDefinition(java.lang.String key)
          Removes the given xml content definition from the cache.
 void uncacheGroup(CmsGroup group)
          Removes the given group from the cache.
 void uncacheLock(java.lang.String rootPath)
          Removes the cached lock for the given root path from the cache.
 void uncacheOrgUnit(CmsOrganizationalUnit orgUnit)
          Removes the given organizational unit from the cache.
 void uncacheProject(CmsProject project)
          Removes the given project from the cache.
 void uncachePublishJob(CmsPublishJobInfoBean publishJob)
          Removes the given publish job from the cache.
 void uncachePublishJobInHistory(CmsPublishJobInfoBean publishJob)
          Removes the given publish job from the history.
 void uncacheUser(CmsUser user)
          Removes the given user from the cache.
 void uncacheVfsObject(java.lang.String key)
          Removes the given vfs object from the cache.
 void uncacheXmlTemporaryEntity(java.lang.String key)
          Removes the given xml temporary entity from the cache.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmsMemoryMonitor

public CmsMemoryMonitor()
Empty constructor, required by OpenCms scheduler.

Method Detail

getMemorySize

public static int getMemorySize(java.lang.Object obj)
Returns the size of objects that are instances of byte[], String, CmsFile,I_CmsLruCacheObject.

For other objects, a size of 0 is returned.

Parameters:
obj - the object
Returns:
the size of the object

cacheACL

public void cacheACL(java.lang.String key,
                     CmsAccessControlList acl)
Caches the given acl under the given cache key.

Parameters:
key - the cache key
acl - the acl to cache

cacheContentDefinition

public void cacheContentDefinition(java.lang.String key,
                                   CmsXmlContentDefinition contentDefinition)
Caches the given content definition under the given cache key.

Parameters:
key - the cache key
contentDefinition - the content definition to cache

cacheGroup

public void cacheGroup(CmsGroup group)
Caches the given group under its id AND fully qualified name.

Parameters:
group - the group to cache

cacheLocale

public void cacheLocale(java.lang.String key,
                        java.util.Locale locale)
Caches the given locale under the given cache key.

Parameters:
key - the cache key
locale - the locale to cache

cacheLock

public void cacheLock(CmsLock lock)
Caches the given lock.

The lock is cached by it resource's root path.

Parameters:
lock - the lock to cache

cacheMemObject

public void cacheMemObject(java.lang.String key,
                           java.lang.Object obj)
Caches the given object under the given cache key.

Parameters:
key - the cache key
obj - the object to cache

cacheOrgUnit

public void cacheOrgUnit(CmsOrganizationalUnit orgUnit)
Caches the given organizational under its id AND the fully qualified name.

Parameters:
orgUnit - the organizational unit to cache

cachePermission

public void cachePermission(java.lang.String key,
                            int permission)
Caches the given permission check result under the given cache key.

Parameters:
key - the cache key
permission - the permission check result to cache

cacheProject

public void cacheProject(CmsProject project)
Caches the given project under its id AND the fully qualified name.

Parameters:
project - the project to cache

cacheProjectResources

public void cacheProjectResources(java.lang.String key,
                                  java.util.List projectResources)
Caches the given project resource list under the given cache key.

Parameters:
key - the cache key
projectResources - the project resources to cache

cacheProperty

public void cacheProperty(java.lang.String key,
                          CmsProperty property)
Caches the given property under the given cache key.

Parameters:
key - the cache key
property - the property to cache

cachePropertyList

public void cachePropertyList(java.lang.String key,
                              java.util.List propertyList)
Caches the given property list under the given cache key.

Parameters:
key - the cache key
propertyList - the property list to cache

cachePublishJob

public void cachePublishJob(CmsPublishJobInfoBean publishJob)
Caches the given publish job.

Parameters:
publishJob - the publish job

cachePublishJobInHistory

public void cachePublishJobInHistory(CmsPublishJobInfoBean publishJob)
Caches the given publish job in the publish job history.

Parameters:
publishJob - the publish job

cacheResource

public void cacheResource(java.lang.String key,
                          CmsResource resource)
Caches the given resource under the given cache key.

Parameters:
key - the cache key
resource - the resource to cache

cacheResourceList

public void cacheResourceList(java.lang.String key,
                              java.util.List resourceList)
Caches the given resource list under the given cache key.

Parameters:
key - the cache key
resourceList - the resource list to cache

cacheRole

public void cacheRole(java.lang.String key,
                      boolean hasRole)
Caches the given value under the given cache key.

Parameters:
key - the cache key
hasRole - if the user has the given role

cacheRoleList

public void cacheRoleList(java.lang.String key,
                          java.util.List roles)
Caches the given value under the given cache key.

Parameters:
key - the cache key
roles - the roles of the user

cacheUser

public void cacheUser(CmsUser user)
Caches the given user under its id AND the fully qualified name.

Parameters:
user - the user to cache

cacheUserGroups

public void cacheUserGroups(java.lang.String key,
                            java.util.List userGroups)
Caches the given list of user groups under the given cache key.

Parameters:
key - the cache key
userGroups - the list of user groups to cache

cacheVfsObject

public void cacheVfsObject(java.lang.String key,
                           java.lang.Object obj)
Caches the given vfs object under the given cache key.

Parameters:
key - the cache key
obj - the vfs object to cache

cacheXmlPermanentEntity

public void cacheXmlPermanentEntity(java.lang.String systemId,
                                    byte[] content)
Caches the given xml entity under the given system id.

Parameters:
systemId - the cache key
content - the content to cache

cacheXmlTemporaryEntity

public void cacheXmlTemporaryEntity(java.lang.String key,
                                    byte[] content)
Caches the given xml entity under the given cache key.

Parameters:
key - the cache key
content - the content to cache

enabled

public boolean enabled()
Returns if monitoring is enabled.

Returns:
true if monitoring is enabled

flushACLs

public void flushACLs()
Flushes the ACL cache.


flushContentDefinitions

public void flushContentDefinitions()
Flushes the xml content definitions cache.


flushGroups

public void flushGroups()
Flushes the group cache.


flushLocales

public void flushLocales()
Flushes the locale cache.


flushLocks

public void flushLocks(java.util.Map newLocks)
Flushes the locks cache.

Parameters:
newLocks - if not null the lock cache is replaced by the given map

flushMemObjects

public void flushMemObjects()
Flushes the memory object cache.


flushOrgUnits

public void flushOrgUnits()
Flushes the organizational unit cache.


flushPermissions

public void flushPermissions()
Flushes the permission check result cache.


flushProjectResources

public void flushProjectResources()
Flushes the project resources cache.


flushProjects

public void flushProjects()
Flushes the project cache.


flushProperties

public void flushProperties()
Flushes the property cache.


flushPropertyLists

public void flushPropertyLists()
Flushes the property list cache.


flushPublishJobHistory

public void flushPublishJobHistory()
Flushes the publish history.


flushPublishJobs

public void flushPublishJobs()
Flushes the publish queue.


flushResourceLists

public void flushResourceLists()
Flushes the resource list cache.


flushResources

public void flushResources()
Flushes the resource cache.


flushRoleLists

public void flushRoleLists()
Flushes the role lists cache.


flushRoles

public void flushRoles()
Flushes the roles cache.


flushUserGroups

public void flushUserGroups()
Flushes the user groups cache.


flushUsers

public void flushUsers()
Flushes the users cache.


flushVfsObjects

public void flushVfsObjects()
Flushes the vfs object cache.


flushXmlPermanentEntities

public void flushXmlPermanentEntities()
Flushes the xml permanent entities cache.


flushXmlTemporaryEntities

public void flushXmlTemporaryEntities()
Flushes the xml temporary entities cache.


getAllCachedLockPaths

public java.util.List getAllCachedLockPaths()
Returns all cached lock root paths.

Returns:
a list of String objects

getAllCachedLocks

public java.util.List getAllCachedLocks()
Returns all cached locks.

Returns:
a list of CmsLock objects

getAllCachedPublishJobs

public java.util.List getAllCachedPublishJobs()
Returns all cached publish jobs in the queue as ordered list.

Returns:
all cached publish jobs

getAllCachedPublishJobsInHistory

public java.util.List getAllCachedPublishJobsInHistory()
Returns all cached publish jobs in the history as ordered list.

Returns:
all cached publish jobs

getCachedACL

public CmsAccessControlList getCachedACL(java.lang.String key)
Returns the ACL cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the ACL cached with the given cache key

getCachedContentDefinition

public CmsXmlContentDefinition getCachedContentDefinition(java.lang.String key)
Returns the xml content definition cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the xml content definition cached with the given cache key

getCachedGroup

public CmsGroup getCachedGroup(java.lang.String key)
Returns the group cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for, this may be the group's uuid or the fqn
Returns:
the group cached with the given cache key

getCachedLocale

public java.util.Locale getCachedLocale(java.lang.String key)
Returns the locale cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the locale cached with the given cache key

getCachedLock

public CmsLock getCachedLock(java.lang.String rootPath)
Returns the lock cached with the given root path or null if not found.

Parameters:
rootPath - the root path to look for
Returns:
the lock cached with the given root path

getCachedMemObject

public java.lang.Object getCachedMemObject(java.lang.String key)
Returns the memory object cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the memory object cached with the given cache key

getCachedOrgUnit

public CmsOrganizationalUnit getCachedOrgUnit(java.lang.String key)
Returns the organizational unit cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for, this may be the organizational unit's uuid or the fqn
Returns:
the organizational unit cached with the given cache key

getCachedPermission

public java.lang.Integer getCachedPermission(java.lang.String key)
Returns the permission check result cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the permission check result cached with the given cache key

getCachedProject

public CmsProject getCachedProject(java.lang.String key)
Returns the project cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for, this may be the project's uuid or the fqn
Returns:
the project cached with the given cache key

getCachedProjectResources

public java.util.List getCachedProjectResources(java.lang.String key)
Returns the project resources list cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the project resources list cached with the given cache key

getCachedProperty

public CmsProperty getCachedProperty(java.lang.String key)
Returns the property cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the property cached with the given cache key

getCachedPropertyList

public java.util.List getCachedPropertyList(java.lang.String key)
Returns the property list cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the property list cached with the given cache key

getCachedPublishJob

public CmsPublishJobInfoBean getCachedPublishJob(java.lang.String key)
Returns the publish job with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the publish job with the given cache key

getCachedPublishJobInHistory

public CmsPublishJobInfoBean getCachedPublishJobInHistory(java.lang.String key)
Returns the publish job from the history with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the publish job with the given cache key

getCachedResource

public CmsResource getCachedResource(java.lang.String key)
Returns the resource cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the resource cached with the given cache key

getCachedResourceList

public java.util.List getCachedResourceList(java.lang.String key)
Returns the resource list cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the resource list cached with the given cache key

getCachedRole

public java.lang.Boolean getCachedRole(java.lang.String key)
Returns the value cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
if the user has the given role

getCachedRoleList

public java.util.List getCachedRoleList(java.lang.String key)
Returns the value cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
list of roles

getCachedUser

public CmsUser getCachedUser(java.lang.String key)
Returns the user cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for, this may be the user's uuid or the fqn
Returns:
the user cached with the given cache key

getCachedUserGroups

public java.util.List getCachedUserGroups(java.lang.String key)
Returns the user groups list cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the user groups list cached with the given cache key

getCachedVfsObject

public java.lang.Object getCachedVfsObject(java.lang.String key)
Returns the vfs object cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the vfs object cached with the given cache key

getCachedXmlPermanentEntity

public byte[] getCachedXmlPermanentEntity(java.lang.String systemId)
Returns the xml permanent entity content cached with the given systemId or null if not found.

Parameters:
systemId - the cache key to look for
Returns:
the xml permanent entity content cached with the given cache key

getCachedXmlTemporaryEntity

public byte[] getCachedXmlTemporaryEntity(java.lang.String key)
Returns the xml temporary entity content cached with the given cache key or null if not found.

Parameters:
key - the cache key to look for
Returns:
the xml temporary entity content cached with the given cache key

getConfiguration

public CmsMemoryMonitorConfiguration getConfiguration()
Returns the configuration.

Returns:
the configuration

getFirstCachedPublishJob

public CmsPublishJobInfoBean getFirstCachedPublishJob()
Returns the next publish job from the publish job queue.

Returns:
the next publish job

getLogCount

public int getLogCount()
Returns the log count.

Returns:
the log count

initialize

public void initialize(CmsSystemConfiguration configuration)
Initializes the monitor with the provided configuration.

Parameters:
configuration - the configuration to use

isMonitoring

public boolean isMonitoring(java.lang.String key)
Checks if there is a registered monitored object with the given key.

Parameters:
key - the key to look for
Returns:
true if there is a registered monitored object with the given key

launch

public java.lang.String launch(CmsObject cms,
                               java.util.Map parameters)
                        throws java.lang.Exception
Description copied from interface: I_CmsScheduledJob
This method will be called when this scheduled job is executed.

Depending on the configuration of this job, a new instance of the configured class will be instanciated every time the job is launched, or a new instance will be generated only the first time the job is launched, and re-used afterwards.

The result String will be written to the OpenCms logfile in the org.opencms.scheduler.CmsScheduleManager channel, on INFO log level.

Specified by:
launch in interface I_CmsScheduledJob
Parameters:
cms - will be initialized with the configured users cms context
parameters - the configured parameters
Returns:
a String that will be written to the OpenCms logfile
Throws:
java.lang.Exception - if something goes wrong
See Also:
I_CmsScheduledJob.launch(CmsObject, Map)

lowMemory

public boolean lowMemory()
Returns true if the system runs low on memory.

Returns:
true if the system runs low on memory

register

public void register(java.lang.String objectName,
                     java.lang.Object object)
Adds a new object to the monitor.

Parameters:
objectName - name of the object
object - the object for monitoring

requiresPersistency

public boolean requiresPersistency()
Checks if some kind of persistency is required.

This could be overwritten in a distributed environment.

Returns:
true if some kind of persistency is required

shutdown

public void shutdown()
              throws java.lang.Exception
Flushes all cached objects.

Throws:
java.lang.Exception - if something goes wrong

uncacheContentDefinition

public void uncacheContentDefinition(java.lang.String key)
Removes the given xml content definition from the cache.

Parameters:
key - the cache key to remove from cache

uncacheGroup

public void uncacheGroup(CmsGroup group)
Removes the given group from the cache.

The group is removed by name AND also by uuid.

Parameters:
group - the group to remove from cache

uncacheLock

public void uncacheLock(java.lang.String rootPath)
Removes the cached lock for the given root path from the cache.

Parameters:
rootPath - the root path of the lock to remove from cache

uncacheOrgUnit

public void uncacheOrgUnit(CmsOrganizationalUnit orgUnit)
Removes the given organizational unit from the cache.

The organizational unit is removed by name AND also by uuid.

Parameters:
orgUnit - the organizational unit to remove from cache

uncacheProject

public void uncacheProject(CmsProject project)
Removes the given project from the cache.

The project is removed by name AND also by uuid.

Parameters:
project - the project to remove from cache

uncachePublishJob

public void uncachePublishJob(CmsPublishJobInfoBean publishJob)
Removes the given publish job from the cache.

Parameters:
publishJob - the publish job to remove

uncachePublishJobInHistory

public void uncachePublishJobInHistory(CmsPublishJobInfoBean publishJob)
Removes the given publish job from the history.

Parameters:
publishJob - the publish job to remove

uncacheUser

public void uncacheUser(CmsUser user)
Removes the given user from the cache.

The user is removed by name AND also by uuid.

Parameters:
user - the user to remove from cache

uncacheVfsObject

public void uncacheVfsObject(java.lang.String key)
Removes the given vfs object from the cache.

Parameters:
key - the cache key to remove from cache

uncacheXmlTemporaryEntity

public void uncacheXmlTemporaryEntity(java.lang.String key)
Removes the given xml temporary entity from the cache.

Parameters:
key - the cache key to remove from cache