I_CmsCacheKey


1   /*
2    * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/db/I_CmsCacheKey.java,v $
3    * Date   : $Date: 2005/06/23 11:11:24 $
4    * Version: $Revision: 1.9 $
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   * Describes the cache key generating methods.<p>
40   * 
41   * @author Carsten Weinholz 
42   * 
43   * @version $Revision: 1.9 $
44   * 
45   * @since 6.0.0
46   */
47  public interface I_CmsCacheKey {
48  
49      /**
50       * Returns the cache key for the user groups cache.<p>
51       * 
52       * @param prefix to distinguish keys additionally
53       * @param context the context
54       * @param user the resource
55       * @return a cache key that is unique for the set of parameters
56       */
57      String   getCacheKeyForUserGroups(String   prefix, CmsDbContext context, CmsUser user);
58  
59      /**
60       * Returns the cache key for the permission cache.<p>
61       * 
62       * @param prefix to distinguish keys additionally
63       * @param context the context
64       * @param resource the resource
65       * @param requiredPermissions the permissions to check
66       * @return a cache key that is unique for the set of parameters
67       */
68      String   getCacheKeyForUserPermissions(
69          String   prefix,
70          CmsDbContext context,
71          CmsResource resource,
72          CmsPermissionSet requiredPermissions);
73  }
74
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags