content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   * Lesser General Public License for more details.
   *
   * For further information about Alkacon Software GmbH & Co. KG, please see the
   * company website: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://www.opencms.org
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  
  package org.opencms.db;
  
  import org.opencms.file.CmsGroup;
  import org.opencms.file.CmsResource;
  import org.opencms.file.CmsUser;
  import org.opencms.security.CmsPermissionSet;
  
  /**
   * Describes the cache key generating methods.<p>
   *
   * @since 6.0.0
   */
  public interface I_CmsCacheKey {
  
      /**
       * Returns the cache key for the group users cache.<p>
       *
       * @param prefix to distinguish keys additionally
       * @param context the context
       * @param group the group
       *
       * @return a cache key that is unique for the set of parameters
       */
      String getCacheKeyForGroupUsers(String prefix, CmsDbContext context, CmsGroup group);
  
      /**
       * Returns the cache key for the user groups cache.<p>
       *
       * @param prefix to distinguish keys additionally
       * @param context the context
       * @param user the user
       *
       * @return a cache key that is unique for the set of parameters
       */
      String getCacheKeyForUserGroups(String prefix, CmsDbContext context, CmsUser user);
  
      /**
       * Returns the cache key for the permission cache.<p>
       *
       * @param prefix to distinguish keys additionally
       * @param context the context
       * @param resource the resource
       * @param requiredPermissions the permissions to check
       *
       * @return a cache key that is unique for the set of parameters
       */
      String getCacheKeyForUserPermissions(
          String prefix,
          CmsDbContext context,
          CmsResource resource,
          CmsPermissionSet requiredPermissions);
  }
  