org.opencms.db
Interface I_CmsCacheKey

All Known Implementing Classes:
CmsCacheKey

public interface I_CmsCacheKey

Describes the cache key generating methods.

Since:
6.0.0
Version:
$Revision: 1.9 $
Author:
Carsten Weinholz

Method Summary
 java.lang.String getCacheKeyForUserGroups(java.lang.String prefix, CmsDbContext context, CmsUser user)
          Returns the cache key for the user groups cache.
 java.lang.String getCacheKeyForUserPermissions(java.lang.String prefix, CmsDbContext context, CmsResource resource, CmsPermissionSet requiredPermissions)
          Returns the cache key for the permission cache.
 

Method Detail

getCacheKeyForUserGroups

public java.lang.String getCacheKeyForUserGroups(java.lang.String prefix,
                                                 CmsDbContext context,
                                                 CmsUser user)
Returns the cache key for the user groups cache.

Parameters:
prefix - to distinguish keys additionally
context - the context
user - the resource
Returns:
a cache key that is unique for the set of parameters

getCacheKeyForUserPermissions

public java.lang.String getCacheKeyForUserPermissions(java.lang.String prefix,
                                                      CmsDbContext context,
                                                      CmsResource resource,
                                                      CmsPermissionSet requiredPermissions)
Returns the cache key for the permission cache.

Parameters:
prefix - to distinguish keys additionally
context - the context
resource - the resource
requiredPermissions - the permissions to check
Returns:
a cache key that is unique for the set of parameters