org.opencms.workplace.explorer
Class CmsExplorerTypeAccess

java.lang.Object
  extended byorg.opencms.workplace.explorer.CmsExplorerTypeAccess

public class CmsExplorerTypeAccess
extends java.lang.Object

Explorer type access object, encapsulates access control entries and lists of a explorer type.

Since:
6.0.0
Version:
$Revision: 1.17 $
Author:
Michael Emmerich

Field Summary
static java.lang.String PRINCIPAL_DEFAULT
          Principal key name for the default permission settings.
 
Constructor Summary
CmsExplorerTypeAccess()
          Constructor, creates an empty, CmsExplorerTypeAccess object.
 
Method Summary
 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.
 CmsAccessControlList getAccessControlList()
          Returns the computed access Control List.
 java.util.Map 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
 

Field Detail

PRINCIPAL_DEFAULT

public static final java.lang.String PRINCIPAL_DEFAULT
Principal key name for the default permission settings.

See Also:
Constant Field Values
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

getAccessControlList

public CmsAccessControlList getAccessControlList()
Returns the computed access Control List.

Returns:
the computed access Control List

getAccessEntries

public java.util.Map 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