01: /*
02: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/db/I_CmsCacheKey.java,v $
03: * Date : $Date: 2008-02-27 12:05:43 $
04: * Version: $Revision: 1.12 $
05: *
06: * This library is part of OpenCms -
07: * the Open Source Content Management System
08: *
09: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
10: *
11: * This library is free software; you can redistribute it and/or
12: * modify it under the terms of the GNU Lesser General Public
13: * License as published by the Free Software Foundation; either
14: * version 2.1 of the License, or (at your option) any later version.
15: *
16: * This library is distributed in the hope that it will be useful,
17: * but WITHOUT ANY WARRANTY; without even the implied warranty of
18: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19: * Lesser General Public License for more details.
20: *
21: * For further information about Alkacon Software GmbH, please see the
22: * company website: http://www.alkacon.com
23: *
24: * For further information about OpenCms, please see the
25: * project website: http://www.opencms.org
26: *
27: * You should have received a copy of the GNU Lesser General Public
28: * License along with this library; if not, write to the Free Software
29: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30: */
31:
32: package org.opencms.db;
33:
34: import org.opencms.file.CmsGroup;
35: import org.opencms.file.CmsResource;
36: import org.opencms.file.CmsUser;
37: import org.opencms.security.CmsPermissionSet;
38:
39: /**
40: * Describes the cache key generating methods.<p>
41: *
42: * @author Carsten Weinholz
43: *
44: * @version $Revision: 1.12 $
45: *
46: * @since 6.0.0
47: */
48: public interface I_CmsCacheKey {
49:
50: /**
51: * Returns the cache key for the group users cache.<p>
52: *
53: * @param prefix to distinguish keys additionally
54: * @param context the context
55: * @param group the group
56: *
57: * @return a cache key that is unique for the set of parameters
58: */
59: String getCacheKeyForGroupUsers(String prefix,
60: CmsDbContext context, CmsGroup group);
61:
62: /**
63: * Returns the cache key for the user groups cache.<p>
64: *
65: * @param prefix to distinguish keys additionally
66: * @param context the context
67: * @param user the user
68: *
69: * @return a cache key that is unique for the set of parameters
70: */
71: String getCacheKeyForUserGroups(String prefix,
72: CmsDbContext context, CmsUser user);
73:
74: /**
75: * Returns the cache key for the permission cache.<p>
76: *
77: * @param prefix to distinguish keys additionally
78: * @param context the context
79: * @param resource the resource
80: * @param requiredPermissions the permissions to check
81: *
82: * @return a cache key that is unique for the set of parameters
83: */
84: String getCacheKeyForUserPermissions(String prefix,
85: CmsDbContext context, CmsResource resource,
86: CmsPermissionSet requiredPermissions);
87: }
|