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

Method Summary

String	getCacheKeyForGroupUsers(String prefix, CmsDbContext context, CmsGroup group) Returns the cache key for the group users cache.
String	getCacheKeyForUserGroups(String prefix, CmsDbContext context, CmsUser user) Returns the cache key for the user groups cache.
String	getCacheKeyForUserPermissions(String prefix, CmsDbContext context, CmsResource resource, CmsPermissionSet requiredPermissions) Returns the cache key for the permission cache.

Method Detail

getCacheKeyForGroupUsers

String getCacheKeyForGroupUsers(String prefix,
                                CmsDbContext context,
                                CmsGroup group)

Returns the cache key for the group users cache.

Parameters:

prefix - to distinguish keys additionally

context - the context

group - the group

Returns:

a cache key that is unique for the set of parameters

getCacheKeyForUserGroups

String getCacheKeyForUserGroups(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 user

Returns:

a cache key that is unique for the set of parameters

getCacheKeyForUserPermissions

String getCacheKeyForUserPermissions(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