001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.db;
029
030import org.opencms.file.CmsGroup;
031import org.opencms.file.CmsResource;
032import org.opencms.file.CmsUser;
033import org.opencms.security.CmsPermissionSet;
034
035/**
036 * Describes the cache key generating methods.<p>
037 *
038 * @since 6.0.0
039 */
040public interface I_CmsCacheKey {
041
042    /**
043     * Returns the cache key for the group users cache.<p>
044     *
045     * @param prefix to distinguish keys additionally
046     * @param context the context
047     * @param group the group
048     *
049     * @return a cache key that is unique for the set of parameters
050     */
051    String getCacheKeyForGroupUsers(String prefix, CmsDbContext context, CmsGroup group);
052
053    /**
054     * Returns the cache key for the user groups cache.<p>
055     *
056     * @param prefix to distinguish keys additionally
057     * @param context the context
058     * @param user the user
059     *
060     * @return a cache key that is unique for the set of parameters
061     */
062    String getCacheKeyForUserGroups(String prefix, CmsDbContext context, CmsUser user);
063
064    /**
065     * Returns the cache key for the permission cache.<p>
066     *
067     * @param prefix to distinguish keys additionally
068     * @param context the context
069     * @param resource the resource
070     * @param requiredPermissions the permissions to check
071     *
072     * @return a cache key that is unique for the set of parameters
073     */
074    String getCacheKeyForUserPermissions(
075        String prefix,
076        CmsDbContext context,
077        CmsResource resource,
078        CmsPermissionSet requiredPermissions);
079}