CmsMemoryMonitor

java.lang.Object
- org.opencms.monitor.CmsMemoryMonitor

所有已实现的接口:

I_CmsScheduledJob
```
public class CmsMemoryMonitor
extends java.lang.Object
implements I_CmsScheduledJob
```
Monitors OpenCms memory consumption.
The memory monitor also provides all kind of caches used in the OpenCms core.

从以下版本开始:

6.0.0

属性概要

属性
类型属性和说明

boolean isCache
已过时。
use isEnabled(CacheType) instead

属性
类型	属性和说明
`boolean`	`isCache` 已过时。 use `isEnabled(CacheType)` instead

嵌套类概要

嵌套类
限定符和类型类和说明

static class CmsMemoryMonitor.CacheType
Cache types.

嵌套类
限定符和类型	类和说明
`static class`	`CmsMemoryMonitor.CacheType` Cache types.

构造器概要

构造器
构造器和说明

CmsMemoryMonitor()
Empty constructor, required by OpenCms scheduler.

构造器
构造器和说明
`CmsMemoryMonitor()` Empty constructor, required by OpenCms scheduler.

方法概要

方法
限定符和类型	方法和说明
`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, I_CmsPermissionHandler.CmsPermissionCheckResult 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<CmsResource> 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<CmsProperty> propertyList)` Caches the given property list under the given cache key.
`void`	`cachePublishedResources(java.lang.String cacheKey, java.util.List<CmsPublishedResource> publishedResources)` Caches the given published resources 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<CmsResource> 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<CmsRole> 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<CmsGroup> userGroups)` Caches the given list of user groups under the given cache key.
`void`	`cacheUserList(java.lang.String key, java.util.List<CmsUser> userList)` Caches the given list of users 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.
`void`	`clearAccessControlListCache()` Clears the access control list cache when access control entries are changed.
`void`	`clearCache()` Clears almost all internal caches.
`protected void`	`clearCaches()` Clears the OpenCms caches.
`void`	`clearPrincipalsCache()` Clears all internal principal-related caches.
`void`	`clearResourceCache()` Clears all the depending caches when a resource was changed.
`void`	`clearUserCache(CmsUser user)` Clears the user cache for the given user.
`void`	`disableCache(CmsMemoryMonitor.CacheType... types)` Disables the given cache.
`void`	`enableCache(CmsMemoryMonitor.CacheType... types)` Enables the given cache.
`boolean`	`enabled()` Returns if monitoring is enabled.
`void`	`flushACLs()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushCache(CmsMemoryMonitor.CacheType... types)` Flushes the given cache.
`void`	`flushContentDefinitions()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushGroups()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushLocales()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushLocks(java.util.Map<java.lang.String,CmsLock> newLocks)` Flushes the locks cache.
`void`	`flushMemObjects()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushOrgUnits()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushPermissions()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushProjectResources()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushProjects()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushProperties()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushPropertyLists()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushPublishedResources()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushPublishJobHistory()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushPublishJobs()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushResourceLists()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushResources()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushRoleLists()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushRoles()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushUserGroups()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushUsers()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushVfsObjects()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushXmlPermanentEntities()` 已过时。 use `flushCache(CacheType[])` instead
`void`	`flushXmlTemporaryEntities()` 已过时。 use `flushCache(CacheType[])` instead
`java.util.List<java.lang.String>`	`getAllCachedLockPaths()` Returns all cached lock root paths.
`java.util.List<CmsLock>`	`getAllCachedLocks()` Returns all cached locks.
`java.util.List<CmsPublishJobInfoBean>`	`getAllCachedPublishJobs()` Returns all cached publish jobs in the queue as ordered list.
`java.util.List<CmsPublishJobInfoBean>`	`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.
`I_CmsPermissionHandler.CmsPermissionCheckResult`	`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<CmsResource>`	`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<CmsProperty>`	`getCachedPropertyList(java.lang.String key)` Returns the property list cached with the given cache key or `null` if not found.
`java.util.List<CmsPublishedResource>`	`getCachedPublishedResources(java.lang.String cacheKey)` Returns the published resources 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<CmsResource>`	`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<CmsRole>`	`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<CmsGroup>`	`getCachedUserGroups(java.lang.String key)` Returns the user groups list cached with the given cache key or `null` if not found.
`java.util.List<CmsUser>`	`getCachedUserList(java.lang.String key)` Returns the user 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.
`protected long`	`getCosts(java.lang.Object obj)` Returns the cache costs of a monitored object.
`CmsPublishJobInfoBean`	`getFirstCachedPublishJob()` Returns the next publish job from the publish job queue.
`protected java.lang.String`	`getItems(java.lang.Object obj)` Returns the number of items within a monitored object.
`protected long`	`getKeySize(java.util.Map<?,?> map, int depth)` Returns the total size of key strings within a monitored map.
`protected long`	`getKeySize(java.lang.Object obj)` Returns the total size of key strings within a monitored object.
`protected java.lang.String`	`getLimit(java.lang.Object obj)` Returns the max costs for all items within a monitored object.
`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`.
`CmsMemoryStatus`	`getMemoryStatus()` Returns the current memory status.
`static long`	`getValueSize(java.util.List<?> listValue, int depth)` Returns the total value size of a list object.
`static long`	`getValueSize(java.util.Map<?,?> mapValue, int depth)` Returns the total value size of a map object.
`static long`	`getValueSize(java.lang.Object obj)` Returns the value sizes of value objects within the monitored object.
`void`	`initialize(CmsSystemConfiguration configuration)` Initializes the monitor with the provided configuration.
`boolean`	`isCacheProperty()` 已过时。 use `isEnabled(CacheType)` instead
`boolean`	`isCachePropertyList()` 已过时。 use `isEnabled(CacheType)` instead
`boolean`	`isCacheResource()` 已过时。 use `isEnabled(CacheType)` instead
`boolean`	`isCacheResourceList()` 已过时。 use `isEnabled(CacheType)` instead
`boolean`	`isEnabled(CmsMemoryMonitor.CacheType type)` Checks if the given cache is enabled.
`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<java.lang.String,java.lang.String> parameters)` This method will be called when this scheduled job is executed.
`boolean`	`lowMemory()` Returns true if the system runs low on memory.
`protected void`	`monitorSendEmail(boolean warning)` Sends a warning or status email with OpenCms Memory information.
`protected void`	`monitorWriteLog(boolean warning)` Write a warning or status log entry with OpenCms Memory information.
`void`	`register(java.lang.String objectName, java.lang.Object object)` Adds a new object to the monitor.
`boolean`	`requiresPersistency()` Checks if some kind of persistence is required.
`void`	`setCacheProperty(boolean cacheProperty)` 已过时。 use `enableCache(CacheType[])` or `disableCache(CacheType[])` instead
`void`	`setCachePropertyList(boolean cachePropertyList)` 已过时。 use `enableCache(CacheType[])` or `disableCache(CacheType[])` instead
`void`	`setCacheResource(boolean cacheResource)` 已过时。 use `enableCache(CacheType[])` or `disableCache(CacheType[])` instead
`void`	`setCacheResourceList(boolean cacheResourceList)` 已过时。 use `enableCache(CacheType[])` or `disableCache(CacheType[])` instead
`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.
`protected void`	`updateStatus()` Updates the memory information of the memory monitor.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 属性详细信息
  - isCache
    
    Checks if the property cache is enabled.
    
    返回:
    true if the property cache is enabled
- 构造器详细资料
  - CmsMemoryMonitor
```
public CmsMemoryMonitor()
```
    Empty constructor, required by OpenCms scheduler.
- 方法详细资料
  - 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.
    
    参数:
    obj - the object
    
    返回:
    the size of the object
  - getValueSize
```
public static long getValueSize(java.util.List<?> listValue,
                int depth)
```
    Returns the total value size of a list object.
    
    参数:
    listValue - the list object
    depth - the max recursion depth for calculation the size
    
    返回:
    the size of the list object
  - getValueSize
```
public static long getValueSize(java.util.Map<?,?> mapValue,
                int depth)
```
    Returns the total value size of a map object.
    
    参数:
    mapValue - the map object
    depth - the max recursion depth for calculation the size
    
    返回:
    the size of the map object
  - getValueSize
```
public static long getValueSize(java.lang.Object obj)
```
    Returns the value sizes of value objects within the monitored object.
    
    参数:
    obj - the object
    
    返回:
    the value sizes of value objects or "-"-fields
  - cacheACL
```
public void cacheACL(java.lang.String key,
            CmsAccessControlList acl)
```
    Caches the given acl under the given cache key.
    
    参数:
    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.
    
    参数:
    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.
    
    参数:
    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.
    
    参数:
    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.
    
    参数:
    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.
    
    参数:
    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.
    
    参数:
    orgUnit - the organizational unit to cache
  - cachePermission
```
public void cachePermission(java.lang.String key,
                   I_CmsPermissionHandler.CmsPermissionCheckResult permission)
```
    Caches the given permission check result under the given cache key.
    
    参数:
    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.
    
    参数:
    project - the project to cache
  - cacheProjectResources
```
public void cacheProjectResources(java.lang.String key,
                         java.util.List<CmsResource> projectResources)
```
    Caches the given project resource list under the given cache key.
    
    参数:
    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.
    
    参数:
    key - the cache key
    property - the property to cache
  - cachePropertyList
```
public void cachePropertyList(java.lang.String key,
                     java.util.List<CmsProperty> propertyList)
```
    Caches the given property list under the given cache key.
    
    参数:
    key - the cache key
    propertyList - the property list to cache
  - cachePublishedResources
```
public void cachePublishedResources(java.lang.String cacheKey,
                           java.util.List<CmsPublishedResource> publishedResources)
```
    Caches the given published resources list under the given cache key.
    
    参数:
    cacheKey - the cache key
    publishedResources - the published resources list to cache
  - cachePublishJob
```
public void cachePublishJob(CmsPublishJobInfoBean publishJob)
```
    Caches the given publish job.
    
    参数:
    publishJob - the publish job
  - cachePublishJobInHistory
```
public void cachePublishJobInHistory(CmsPublishJobInfoBean publishJob)
```
    Caches the given publish job in the publish job history.
    
    参数:
    publishJob - the publish job
  - cacheResource
```
public void cacheResource(java.lang.String key,
                 CmsResource resource)
```
    Caches the given resource under the given cache key.
    
    参数:
    key - the cache key
    resource - the resource to cache
  - cacheResourceList
```
public void cacheResourceList(java.lang.String key,
                     java.util.List<CmsResource> resourceList)
```
    Caches the given resource list under the given cache key.
    
    参数:
    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.
    
    参数:
    key - the cache key
    hasRole - if the user has the given role
  - cacheRoleList
```
public void cacheRoleList(java.lang.String key,
                 java.util.List<CmsRole> roles)
```
    Caches the given value under the given cache key.
    
    参数:
    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.
    
    参数:
    user - the user to cache
  - cacheUserGroups
```
public void cacheUserGroups(java.lang.String key,
                   java.util.List<CmsGroup> userGroups)
```
    Caches the given list of user groups under the given cache key.
    
    参数:
    key - the cache key
    userGroups - the list of user groups to cache
  - cacheUserList
```
public void cacheUserList(java.lang.String key,
                 java.util.List<CmsUser> userList)
```
    Caches the given list of users under the given cache key.
    
    参数:
    key - the cache key
    userList - the list of users to cache
  - cacheVfsObject
```
public void cacheVfsObject(java.lang.String key,
                  java.lang.Object obj)
```
    Caches the given vfs object under the given cache key.
    
    参数:
    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.
    
    参数:
    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.
    
    参数:
    key - the cache key
    content - the content to cache
  - clearAccessControlListCache
```
public void clearAccessControlListCache()
```
    Clears the access control list cache when access control entries are changed.
  - clearCache
```
public void clearCache()
```
    Clears almost all internal caches.
  - clearPrincipalsCache
```
public void clearPrincipalsCache()
```
    Clears all internal principal-related caches.
  - clearResourceCache
```
public void clearResourceCache()
```
    Clears all the depending caches when a resource was changed.
  - clearUserCache
```
public void clearUserCache(CmsUser user)
```
    Clears the user cache for the given user.
    
    参数:
    user - the user
  - disableCache
```
public void disableCache(CmsMemoryMonitor.CacheType... types)
```
    Disables the given cache.
    
    参数:
    types - the cache type to disable
  - enableCache
```
public void enableCache(CmsMemoryMonitor.CacheType... types)
```
    Enables the given cache.
    
    参数:
    types - the cache type to disable
  - enabled
```
public boolean enabled()
```
    Returns if monitoring is enabled.
    
    返回:
    true if monitoring is enabled
  - flushACLs
```
@Deprecated
public void flushACLs()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the ACL cache.
  - flushCache
```
public void flushCache(CmsMemoryMonitor.CacheType... types)
```
    Flushes the given cache.
    
    参数:
    types - the cache types to flush
  - flushContentDefinitions
```
@Deprecated
public void flushContentDefinitions()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the xml content definitions cache.
  - flushGroups
```
@Deprecated
public void flushGroups()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the group cache.
  - flushLocales
```
@Deprecated
public void flushLocales()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the locale cache.
  - flushLocks
```
public void flushLocks(java.util.Map<java.lang.String,CmsLock> newLocks)
```
    Flushes the locks cache.
    
    参数:
    newLocks - if not null the lock cache is replaced by the given map
  - flushMemObjects
```
@Deprecated
public void flushMemObjects()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the memory object cache.
  - flushOrgUnits
```
@Deprecated
public void flushOrgUnits()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the organizational unit cache.
  - flushPermissions
```
@Deprecated
public void flushPermissions()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the permission check result cache.
  - flushProjectResources
```
@Deprecated
public void flushProjectResources()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the project resources cache.
  - flushProjects
```
@Deprecated
public void flushProjects()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the project cache.
  - flushProperties
```
@Deprecated
public void flushProperties()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the property cache.
  - flushPropertyLists
```
@Deprecated
public void flushPropertyLists()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the property list cache.
  - flushPublishedResources
```
@Deprecated
public void flushPublishedResources()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the published resources cache.
  - flushPublishJobHistory
```
@Deprecated
public void flushPublishJobHistory()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the publish history.
  - flushPublishJobs
```
@Deprecated
public void flushPublishJobs()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the publish queue.
  - flushResourceLists
```
@Deprecated
public void flushResourceLists()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the resource list cache.
  - flushResources
```
@Deprecated
public void flushResources()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the resource cache.
  - flushRoleLists
```
@Deprecated
public void flushRoleLists()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the role lists cache.
  - flushRoles
```
@Deprecated
public void flushRoles()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the roles cache.
  - flushUserGroups
```
@Deprecated
public void flushUserGroups()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the user groups cache.
  - flushUsers
```
@Deprecated
public void flushUsers()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the users cache.
  - flushVfsObjects
```
@Deprecated
public void flushVfsObjects()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the vfs object cache.
  - flushXmlPermanentEntities
```
@Deprecated
public void flushXmlPermanentEntities()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the xml permanent entities cache.
  - flushXmlTemporaryEntities
```
@Deprecated
public void flushXmlTemporaryEntities()
```
    已过时。 use flushCache(CacheType[]) instead
    
    Flushes the xml temporary entities cache.
  - getAllCachedLockPaths
```
public java.util.List<java.lang.String> getAllCachedLockPaths()
```
    Returns all cached lock root paths.
    
    返回:
    a list of String objects
  - getAllCachedLocks
```
public java.util.List<CmsLock> getAllCachedLocks()
```
    Returns all cached locks.
    
    返回:
    a list of CmsLock objects
  - getAllCachedPublishJobs
```
public java.util.List<CmsPublishJobInfoBean> getAllCachedPublishJobs()
```
    Returns all cached publish jobs in the queue as ordered list.
    
    返回:
    all cached publish jobs
  - getAllCachedPublishJobsInHistory
```
public java.util.List<CmsPublishJobInfoBean> getAllCachedPublishJobsInHistory()
```
    Returns all cached publish jobs in the history as ordered list.
    
    返回:
    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.
    
    参数:
    key - the cache key to look for
    
    返回:
    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.
    
    参数:
    key - the cache key to look for
    
    返回:
    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.
    
    参数:
    key - the cache key to look for, this may be the group's uuid or the fqn
    
    返回:
    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.
    
    参数:
    key - the cache key to look for
    
    返回:
    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.
    
    参数:
    rootPath - the root path to look for
    
    返回:
    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.
    
    参数:
    key - the cache key to look for
    
    返回:
    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.
    
    参数:
    key - the cache key to look for, this may be the organizational unit's uuid or the fqn
    
    返回:
    the organizational unit cached with the given cache key
  - getCachedPermission
```
public I_CmsPermissionHandler.CmsPermissionCheckResult getCachedPermission(java.lang.String key)
```
    Returns the permission check result cached with the given cache key or null if not found.
    
    参数:
    key - the cache key to look for
    
    返回:
    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.
    
    参数:
    key - the cache key to look for, this may be the project's uuid or the fqn
    
    返回:
    the project cached with the given cache key
  - getCachedProjectResources
```
public java.util.List<CmsResource> getCachedProjectResources(java.lang.String key)
```
    Returns the project resources list cached with the given cache key or null if not found.
    
    参数:
    key - the cache key to look for
    
    返回:
    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.
    
    参数:
    key - the cache key to look for
    
    返回:
    the property cached with the given cache key
  - getCachedPropertyList
```
public java.util.List<CmsProperty> getCachedPropertyList(java.lang.String key)
```
    Returns the property list cached with the given cache key or null if not found.
    
    参数:
    key - the cache key to look for
    
    返回:
    the property list cached with the given cache key
  - getCachedPublishedResources
```
public java.util.List<CmsPublishedResource> getCachedPublishedResources(java.lang.String cacheKey)
```
    Returns the published resources list cached with the given cache key or null if not found.
    
    参数:
    cacheKey - the cache key to look for
    
    返回:
    the published resources 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.
    
    参数:
    key - the cache key to look for
    
    返回:
    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.
    
    参数:
    key - the cache key to look for
    
    返回:
    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.
    
    参数:
    key - the cache key to look for
    
    返回:
    the resource cached with the given cache key
  - getCachedResourceList
```
public java.util.List<CmsResource> getCachedResourceList(java.lang.String key)
```
    Returns the resource list cached with the given cache key or null if not found.
    
    参数:
    key - the cache key to look for
    
    返回:
    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.
    
    参数:
    key - the cache key to look for
    
    返回:
    if the user has the given role
  - getCachedRoleList
```
public java.util.List<CmsRole> getCachedRoleList(java.lang.String key)
```
    Returns the value cached with the given cache key or null if not found.
    
    参数:
    key - the cache key to look for
    
    返回:
    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.
    
    参数:
    key - the cache key to look for, this may be the user's uuid or the fqn
    
    返回:
    the user cached with the given cache key
  - getCachedUserGroups
```
public java.util.List<CmsGroup> getCachedUserGroups(java.lang.String key)
```
    Returns the user groups list cached with the given cache key or null if not found.
    
    参数:
    key - the cache key to look for
    
    返回:
    the user groups list cached with the given cache key
  - getCachedUserList
```
public java.util.List<CmsUser> getCachedUserList(java.lang.String key)
```
    Returns the user list cached with the given cache key or null if not found.
    
    参数:
    key - the cache key to look for
    
    返回:
    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.
    
    参数:
    key - the cache key to look for
    
    返回:
    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.
    
    参数:
    systemId - the cache key to look for
    
    返回:
    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.
    
    参数:
    key - the cache key to look for
    
    返回:
    the xml temporary entity content cached with the given cache key
  - getConfiguration
```
public CmsMemoryMonitorConfiguration getConfiguration()
```
    Returns the configuration.
    
    返回:
    the configuration
  - getFirstCachedPublishJob
```
public CmsPublishJobInfoBean getFirstCachedPublishJob()
```
    Returns the next publish job from the publish job queue.
    
    返回:
    the next publish job
  - getLogCount
```
public int getLogCount()
```
    Returns the log count.
    
    返回:
    the log count
  - getMemoryStatus
```
public CmsMemoryStatus getMemoryStatus()
```
    Returns the current memory status.
    
    返回:
    the memory status
  - initialize
```
public void initialize(CmsSystemConfiguration configuration)
```
    Initializes the monitor with the provided configuration.
    
    参数:
    configuration - the configuration to use
  - isCacheProperty
```
@Deprecated
public boolean isCacheProperty()
```
    已过时。 use isEnabled(CacheType) instead
    
    Checks if the property cache is enabled.
    
    返回:
    true if the property cache is enabled
  - isCachePropertyList
```
@Deprecated
public boolean isCachePropertyList()
```
    已过时。 use isEnabled(CacheType) instead
    
    Checks if the property list cache is enabled.
    
    返回:
    true if the property list cache is enabled
  - isCacheResource
```
@Deprecated
public boolean isCacheResource()
```
    已过时。 use isEnabled(CacheType) instead
    
    Checks if the resource cache is enabled.
    
    返回:
    true if the resource cache is enabled
  - isCacheResourceList
```
@Deprecated
public boolean isCacheResourceList()
```
    已过时。 use isEnabled(CacheType) instead
    
    Checks if the resource list cache is enabled.
    
    返回:
    true if the resource list cache is enabled
  - isEnabled
```
public boolean isEnabled(CmsMemoryMonitor.CacheType type)
```
    Checks if the given cache is enabled.
    
    参数:
    type - the cache type to check
    
    返回:
    true if the given cache is enabled
  - isMonitoring
```
public boolean isMonitoring(java.lang.String key)
```
    Checks if there is a registered monitored object with the given key.
    
    参数:
    key - the key to look for
    
    返回:
    true if there is a registered monitored object with the given key
  - launch
```
public java.lang.String launch(CmsObject cms,
                      java.util.Map<java.lang.String,java.lang.String> parameters)
                        throws java.lang.Exception
```
    从接口复制的说明: 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 instantiated 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.
    
    指定者:
    
    launch 在接口中 I_CmsScheduledJob
    
    参数:
    cms - will be initialized with the configured users cms context
    parameters - the configured parameters
    
    返回:
    a String that will be written to the OpenCms logfile
    
    抛出:
    
    java.lang.Exception - if something goes wrong
    另请参阅:
    I_CmsScheduledJob.launch(CmsObject, Map)
  - lowMemory
```
public boolean lowMemory()
```
    Returns true if the system runs low on memory.
    
    返回:
    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.
    
    参数:
    objectName - name of the object
    object - the object for monitoring
  - requiresPersistency
```
public boolean requiresPersistency()
```
    Checks if some kind of persistence is required.
    This could be overwritten in a distributed environment.
    
    返回:
    true if some kind of persistence is required
  - setCacheProperty
```
@Deprecated
public void setCacheProperty(boolean cacheProperty)
```
    已过时。 use enableCache(CacheType[]) or disableCache(CacheType[]) instead
    
    Sets if the property cache is enabled.
    
    参数:
    cacheProperty - if the property cache is enabled
  - setCachePropertyList
```
@Deprecated
public void setCachePropertyList(boolean cachePropertyList)
```
    已过时。 use enableCache(CacheType[]) or disableCache(CacheType[]) instead
    
    Sets if the property list cache is enabled.
    
    参数:
    cachePropertyList - if the property list cache is enabled
  - setCacheResource
```
@Deprecated
public void setCacheResource(boolean cacheResource)
```
    已过时。 use enableCache(CacheType[]) or disableCache(CacheType[]) instead
    
    Sets if the resource cache is enabled.
    
    参数:
    cacheResource - if the resource cache is enabled
  - setCacheResourceList
```
@Deprecated
public void setCacheResourceList(boolean cacheResourceList)
```
    已过时。 use enableCache(CacheType[]) or disableCache(CacheType[]) instead
    
    Sets if the resource list cache is enabled.
    
    参数:
    cacheResourceList - if the resource list cache is enabled
  - shutdown
```
public void shutdown()
              throws java.lang.Exception
```
    Flushes all cached objects.
    
    抛出:
    
    java.lang.Exception - if something goes wrong
  - uncacheContentDefinition
```
public void uncacheContentDefinition(java.lang.String key)
```
    Removes the given xml content definition from the cache.
    
    参数:
    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.
    
    参数:
    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.
    
    参数:
    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.
    
    参数:
    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.
    
    参数:
    project - the project to remove from cache
  - uncachePublishJob
```
public void uncachePublishJob(CmsPublishJobInfoBean publishJob)
```
    Removes the given publish job from the cache.
    
    参数:
    publishJob - the publish job to remove
  - uncachePublishJobInHistory
```
public void uncachePublishJobInHistory(CmsPublishJobInfoBean publishJob)
```
    Removes the given publish job from the history.
    
    参数:
    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.
    
    参数:
    user - the user to remove from cache
  - uncacheVfsObject
```
public void uncacheVfsObject(java.lang.String key)
```
    Removes the given vfs object from the cache.
    
    参数:
    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.
    
    参数:
    key - the cache key to remove from cache
  - clearCaches
```
protected void clearCaches()
```
    Clears the OpenCms caches.
  - getCosts
```
protected long getCosts(java.lang.Object obj)
```
    Returns the cache costs of a monitored object.
    obj must be of type CmsLruCache.
    
    参数:
    obj - the object
    
    返回:
    the cache costs or "-"
  - getItems
```
protected java.lang.String getItems(java.lang.Object obj)
```
    Returns the number of items within a monitored object.
    obj must be of type CmsLruCache or Map.
    
    参数:
    obj - the object
    
    返回:
    the number of items or "-"
  - getKeySize
```
protected long getKeySize(java.util.Map<?,?> map,
              int depth)
```
    Returns the total size of key strings within a monitored map.
    The keys must be of type String.
    
    参数:
    map - the map
    depth - the max recursion depth for calculation the size
    
    返回:
    total size of key strings
  - getKeySize
```
protected long getKeySize(java.lang.Object obj)
```
    Returns the total size of key strings within a monitored object.
    obj must be of type Map, the keys must be of type String.
    
    参数:
    obj - the object
    
    返回:
    the total size of key strings
  - getLimit
```
protected java.lang.String getLimit(java.lang.Object obj)
```
    Returns the max costs for all items within a monitored object.
    obj must be of type CmsLruCache or LRUMap.
    
    参数:
    obj - the object
    
    返回:
    max cost limit or "-"
  - monitorSendEmail
```
protected void monitorSendEmail(boolean warning)
```
    Sends a warning or status email with OpenCms Memory information.
    
    参数:
    warning - if true, send a memory warning email
  - monitorWriteLog
```
protected void monitorWriteLog(boolean warning)
```
    Write a warning or status log entry with OpenCms Memory information.
    
    参数:
    warning - if true, write a memory warning log entry
  - updateStatus
```
protected void updateStatus()
```
    Updates the memory information of the memory monitor.

类 CmsMemoryMonitor

属性概要

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

属性详细信息

isCache

构造器详细资料

CmsMemoryMonitor

方法详细资料

getMemorySize

getValueSize

getValueSize

getValueSize

cacheACL

cacheContentDefinition

cacheGroup

cacheLocale

cacheLock

cacheMemObject

cacheOrgUnit

cachePermission

cacheProject

cacheProjectResources

cacheProperty

cachePropertyList

cachePublishedResources

cachePublishJob

cachePublishJobInHistory

cacheResource

cacheResourceList

cacheRole

cacheRoleList

cacheUser

cacheUserGroups

cacheUserList

cacheVfsObject

cacheXmlPermanentEntity

cacheXmlTemporaryEntity

clearAccessControlListCache

clearCache

clearPrincipalsCache

clearResourceCache

clearUserCache

disableCache

enableCache

enabled

flushACLs

flushCache

flushContentDefinitions

flushGroups

flushLocales

flushLocks

flushMemObjects

flushOrgUnits

flushPermissions

flushProjectResources

flushProjects

flushProperties

flushPropertyLists

flushPublishedResources

flushPublishJobHistory

flushPublishJobs

flushResourceLists

flushResources

flushRoleLists

flushRoles

flushUserGroups

flushUsers

flushVfsObjects

flushXmlPermanentEntities

flushXmlTemporaryEntities

getAllCachedLockPaths

getAllCachedLocks

getAllCachedPublishJobs

getAllCachedPublishJobsInHistory

getCachedACL

getCachedContentDefinition

getCachedGroup