Class CmsExplorerTypeAccess

  • All Implemented Interfaces:
    java.io.Serializable

    public class CmsExplorerTypeAccess
    extends java.lang.Object
    implements java.io.Serializable
    Explorer type access object, encapsulates access control entries and lists of a explorer type.

    Since:
    6.0.0
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      CmsExplorerTypeAccess()
      Constructor, creates an empty, CmsExplorerTypeAccess object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addAccessEntry​(java.lang.String key, java.lang.String value)
      Adds a single access entry to the map of access entries of the explorer type setting.
      void createAccessControlList​(java.lang.String resourceType)
      Creates the access control list from the temporary map.
      protected void flushCache()
      Flushes the permission cache.
      CmsAccessControlList getAccessControlList()
      Returns the computed access Control List.
      java.util.Map<java.lang.String,​java.lang.String> getAccessEntries()
      Returns the map of access entries of the explorer type setting.
      CmsPermissionSet getPermissions​(CmsObject cms, CmsResource resource)
      Calculates the permissions for this explorer type settings for the user in the given OpenCms user context.
      boolean isEmpty()
      Tests if there are any access information stored.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CmsExplorerTypeAccess

        public CmsExplorerTypeAccess()
        Constructor, creates an empty, CmsExplorerTypeAccess object.

    • Method Detail

      • addAccessEntry

        public void addAccessEntry​(java.lang.String key,
                                   java.lang.String value)
        Adds a single access entry to the map of access entries of the explorer type setting.

        This stores the configuration data in a map which is used in the initialize process to create the access control list.

        Parameters:
        key - the principal of the ace
        value - the permissions for the principal
      • createAccessControlList

        public void createAccessControlList​(java.lang.String resourceType)
                                     throws CmsException
        Creates the access control list from the temporary map.

        Parameters:
        resourceType - the name of the resource type
        Throws:
        CmsException - if something goes wrong
      • getAccessEntries

        public java.util.Map<java.lang.String,​java.lang.String> getAccessEntries()
        Returns the map of access entries of the explorer type setting.

        Returns:
        the map of access entries of the explorer type setting
      • getPermissions

        public CmsPermissionSet getPermissions​(CmsObject cms,
                                               CmsResource resource)
        Calculates the permissions for this explorer type settings for the user in the given OpenCms user context.

        Parameters:
        cms - the OpenCms user context to calculate the permissions for
        resource - the resource to check the permissions for
        Returns:
        the permissions for this explorer type settings for the user in the given OpenCms user context
      • isEmpty

        public boolean isEmpty()
        Tests if there are any access information stored.

        Returns:
        true or false
      • flushCache

        protected void flushCache()
        Flushes the permission cache.