KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > db > CmsCacheKey


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/db/CmsCacheKey.java,v $
3  * Date : $Date: 2005/06/27 23:22:10 $
4  * Version: $Revision: 1.15 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 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.CmsResource;
35 import org.opencms.file.CmsUser;
36 import org.opencms.security.CmsPermissionSet;
37
38 /**
39  * Generates the cache keys for the user and permission caches.<p>
40  *
41  * @author Carsten Weinholz
42  *
43  */
44 public class CmsCacheKey implements I_CmsCacheKey {
45
46     /** Cache key for a list of sub-resources (files and folders) of a folder. */
47     public static final String JavaDoc CACHE_KEY_SUBALL = "_all_";
48
49     /** Cache key for a list of sub-files of a folder. */
50     public static final String JavaDoc CACHE_KEY_SUBFILES = "_files_";
51
52     /** Cache key for a list of sub-folders of a folder. */
53     public static final String JavaDoc CACHE_KEY_SUBFOLDERS = "_folders_";
54
55     /**
56      * Constructor to create a new instance of CmsCacheKey.<p>
57      */
58     public CmsCacheKey() {
59
60         // empty
61 }
62
63     /**
64      * @see org.opencms.db.I_CmsCacheKey#getCacheKeyForUserGroups(java.lang.String, org.opencms.db.CmsDbContext, org.opencms.file.CmsUser)
65      */
66     public String JavaDoc getCacheKeyForUserGroups(String JavaDoc prefix, CmsDbContext context, CmsUser user) {
67
68         StringBuffer JavaDoc cacheBuffer = new StringBuffer JavaDoc(64);
69         cacheBuffer.append(prefix);
70         cacheBuffer.append('_');
71         cacheBuffer.append(user.getName());
72         return cacheBuffer.toString();
73     }
74
75     /**
76      * @see org.opencms.db.I_CmsCacheKey#getCacheKeyForUserPermissions(java.lang.String, org.opencms.db.CmsDbContext, org.opencms.file.CmsResource, org.opencms.security.CmsPermissionSet)
77      */
78     public String JavaDoc getCacheKeyForUserPermissions(
79         String JavaDoc prefix,
80         CmsDbContext context,
81         CmsResource resource,
82         CmsPermissionSet requiredPermissions) {
83
84         StringBuffer JavaDoc cacheBuffer = new StringBuffer JavaDoc(64);
85         cacheBuffer.append(prefix);
86         cacheBuffer.append('_');
87         cacheBuffer.append(context.currentUser().getName());
88         cacheBuffer.append(context.currentProject().isOnlineProject() ? "_0_" : "_1_");
89         cacheBuffer.append(requiredPermissions.getPermissionString());
90         cacheBuffer.append('_');
91         cacheBuffer.append(resource.getStructureId().toString());
92         return cacheBuffer.toString();
93     }
94 }
Popular Tags