Uses of Class
org.opencms.security.CmsRole

Packages that use CmsRole

Package	Description
org.opencms.db	Low-level database connection and access functionality.
org.opencms.db.generic	Generic (ANSI-SQL) implementation of the OpenCms database connector.
org.opencms.main	Provides the main OpenCms "operating system".
org.opencms.monitor	Contains functions to monitor the OpenCms system status.
org.opencms.security	Access control and security classes for the OpenCms ACL permission system.
org.opencms.ui.apps	Contains code for workplace apps
org.opencms.ui.apps.cacheadmin	Contains classes of the cache admin app.
org.opencms.ui.apps.dbmanager	Contains classes of the cache admin app.
org.opencms.ui.apps.dbmanager.sqlconsole
org.opencms.ui.apps.filehistory	Contains classes of the file history app.
org.opencms.ui.apps.git	This package contains the app classes for the git check in functionality.
org.opencms.ui.apps.lists	This package contains the app classes for the list configurations manager.
org.opencms.ui.apps.logfile	Contains classes of the site manager app.
org.opencms.ui.apps.modules	Contains classes of the module manager app.
org.opencms.ui.apps.projects	The project manager app classes
org.opencms.ui.apps.publishqueue	Contains classes of the publish queue app.
org.opencms.ui.apps.resourcetypes
org.opencms.ui.apps.scheduler	The scheduled jobs manager app classes
org.opencms.ui.apps.search	Contains classes of the source search app.
org.opencms.ui.apps.searchindex	Contains classes of the searchindex app.
org.opencms.ui.apps.sessions	Contains classes of the site manager app.
org.opencms.ui.apps.shell
org.opencms.ui.apps.sitemanager	Contains classes of the site manager app.
org.opencms.ui.apps.user	Contains classes of the user manager app.
org.opencms.widgets	Contains the widget implementations, these are GUI elements used in editors and dialogs of the OpenCms workplace.

Uses of CmsRole in org.opencms.db

Methods in org.opencms.db that return types with arguments of type CmsRole

Modifier and Type	Method and Description
java.util.List<CmsRole>	CmsDriverManager.getRolesForResource(CmsDbContext dbc, CmsUser user, CmsResource resource) Returns all roles the given user has for the given resource.
java.util.List<CmsRole>	CmsSecurityManager.getRolesForResource(CmsRequestContext context, CmsUser user, CmsResource resource) Returns all roles the given user has for the given resource.
java.util.List<CmsRole>	CmsDriverManager.getRolesForUser(CmsDbContext dbc, CmsUser user) Returns all roles the given user has independent of the resource.

Methods in org.opencms.db with parameters of type CmsRole

Modifier and Type	Method and Description
void	CmsSecurityManager.checkRole(CmsDbContext dbc, CmsRole role) Checks if the user of the current database context has permissions to impersonate the given role in the given organizational unit.
void	CmsSecurityManager.checkRole(CmsRequestContext context, CmsRole role) Checks if the user of the current context has permissions to impersonate the given role.
void	CmsSecurityManager.checkRoleForResource(CmsDbContext dbc, CmsRole role, CmsResource resource) Checks if the user of the current database context has permissions to impersonate the given role for the given resource.
void	CmsSecurityManager.checkRoleForResource(CmsRequestContext context, CmsRole role, CmsResource resource) Checks if the user of the current context has permissions to impersonate the given role for the given resource.
protected void	CmsSecurityManager.checkRoleForUserModification(CmsDbContext dbc, java.lang.String username, CmsRole role) Checks that the current user has enough permissions to modify the given user.
protected java.util.List<CmsResource>	CmsSecurityManager.getManageableResources(CmsDbContext dbc, CmsRole role) Returns all resources of organizational units for which the current user has the given role role.
java.util.List<CmsResource>	CmsSecurityManager.getManageableResources(CmsRequestContext context, CmsRole role) Returns all resources of organizational units for which the current user has the given role role.
java.util.List<CmsOrganizationalUnit>	CmsDriverManager.getOrgUnitsForRole(CmsDbContext dbc, CmsRole role, boolean includeSubOus) Returns all the organizational units for which the current user has the given role.
java.util.List<CmsOrganizationalUnit>	CmsSecurityManager.getOrgUnitsForRole(CmsRequestContext requestContext, CmsRole role, boolean includeSubOus) Returns all the organizational units for which the current user has the given role.
java.util.Set<CmsGroup>	CmsSecurityManager.getRoleGroups(CmsRequestContext context, CmsRole role, boolean directUsersOnly) Gets the groups which constitute a given role.
boolean	CmsSecurityManager.hasRole(CmsDbContext dbc, CmsUser user, CmsRole role) Checks if the given user has the given role in the given organizational unit.
boolean	CmsSecurityManager.hasRole(CmsRequestContext context, CmsUser user, CmsRole role) Checks if the given user has the given role in the given organizational unit.
protected boolean	CmsSecurityManager.hasRole(CmsRole role, java.util.List<CmsGroup> roles) Returns true if at least one of the given group names is equal to a group name of the given role in the given organizational unit.
boolean	CmsSecurityManager.hasRoleForResource(CmsDbContext dbc, CmsUser user, CmsRole role, CmsResource resource) Checks if the given user has the given role for the given resource.
boolean	CmsSecurityManager.hasRoleForResource(CmsRequestContext context, CmsUser user, CmsRole role, CmsResource resource) Checks if the given user has the given role for the given resource.

Uses of CmsRole in org.opencms.db.generic

Methods in org.opencms.db.generic with parameters of type CmsRole

Modifier and Type	Method and Description
protected void	CmsUserDriver.internalUpdateRoleGroup(CmsDbContext dbc, java.lang.String groupName, CmsRole role) Updates a group to a virtual group.

Uses of CmsRole in org.opencms.main

Methods in org.opencms.main that return types with arguments of type CmsRole

Modifier and Type	Method and Description
static java.util.List<CmsRole>	OpenCms.getSystemRoles() Returns the list of system defined roles (instances of CmsRole).

Methods in org.opencms.main with parameters of type CmsRole

Modifier and Type	Method and Description
boolean	CmsShell.validateUser(java.lang.String userName, java.lang.String password, CmsRole requiredRole) Validates the given user and password and checks if the user has the requested role.

Uses of CmsRole in org.opencms.monitor

Methods in org.opencms.monitor that return types with arguments of type CmsRole

Modifier and Type	Method and Description
java.util.List<CmsRole>	CmsMemoryMonitor.getCachedRoleList(java.lang.String key) Returns the value cached with the given cache key or null if not found.

Method parameters in org.opencms.monitor with type arguments of type CmsRole

Modifier and Type	Method and Description
void	CmsMemoryMonitor.cacheRoleList(java.lang.String key, java.util.List<CmsRole> roles) Caches the given value under the given cache key.

Uses of CmsRole in org.opencms.security

Fields in org.opencms.security declared as CmsRole

Modifier and Type	Field and Description
static CmsRole	CmsRole.ACCOUNT_MANAGER The "ACCOUNT_MANAGER" role.
static CmsRole	CmsRole.ADMINISTRATOR The "ADMINISTRATOR" role, which is a parent to all organizational unit roles.
static CmsRole	CmsRole.CATEGORY_EDITOR The "CATEGORY_EDITOR" role.
static CmsRole	CmsRole.DATABASE_MANAGER The "EXPORT_DATABASE" role.
static CmsRole	CmsRole.DEVELOPER The "DEVELOPER" role.
static CmsRole	CmsRole.EDITOR The "EDITOR" role.
static CmsRole	CmsRole.ELEMENT_AUTHOR The "ELEMENT_AUTHOR" role.
static CmsRole	CmsRole.GALLERY_EDITOR The "GALLERY_EDITOR" role.
static CmsRole	CmsRole.LIST_EDITOR The "LIST_EDITOR" role.
static CmsRole	CmsRole.PROJECT_MANAGER The "PROJECT_MANAGER" role.
static CmsRole	CmsRole.ROOT_ADMIN The "ROOT_ADMIN" role, which is a parent to all other roles.
static CmsRole	CmsRole.VFS_MANAGER The "VFS_MANAGER" role.
static CmsRole	CmsRole.WORKPLACE_MANAGER The "WORKPLACE_MANAGER" role.
static CmsRole	CmsRole.WORKPLACE_USER The "WORKPLACE_USER" role.

Methods in org.opencms.security that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsRole.forOrgUnit(java.lang.String ouFqn) Creates a new role based on this one for the given organizational unit.
CmsRole	CmsRole.getParentRole() Returns the parent role of this role.
static CmsRole	CmsRole.valueOf(CmsGroup group) Returns the role for the given group.
static CmsRole	CmsRole.valueOfGroupName(java.lang.String groupName) Returns the role for the given group name.
static CmsRole	CmsRole.valueOfId(CmsUUID roleId) Returns the role for the given id.
static CmsRole	CmsRole.valueOfRoleName(java.lang.String roleName) Returns the role for the given role name.

Methods in org.opencms.security that return types with arguments of type CmsRole

Modifier and Type	Method and Description
java.util.List<CmsRole>	CmsRole.getChildren(boolean recursive) Returns a list of all sub roles.
java.util.List<CmsRole>	CmsRoleManager.getRoles(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus) Returns all roles, in the given organizational unit.
java.util.List<CmsRole>	CmsRoleManager.getRolesForResource(CmsObject cms, CmsUser user, CmsResource resource) Returns all roles the given user has over the given resource.
java.util.List<CmsRole>	CmsRoleManager.getRolesForResource(CmsObject cms, java.lang.String userFqn, java.lang.String resourceName) Returns all roles the given user has over the given resource.
java.util.List<CmsRole>	CmsRoleManager.getRolesOfUser(CmsObject cms, java.lang.String username, java.lang.String ouFqn, boolean includeChildOus, boolean directRolesOnly, boolean recursive) Returns all roles the given user belongs to, in the given organizational unit.
static java.util.List<CmsRole>	CmsRole.getSystemRoles() Returns the list of system defined roles (instances of CmsRole).

Methods in org.opencms.security with parameters of type CmsRole

Modifier and Type	Method and Description
void	CmsRoleManager.addUserToRole(CmsObject cms, CmsRole role, java.lang.String username) Adds a user to the given role.
void	CmsRoleManager.checkRole(CmsObject cms, CmsRole role) Checks if the user of this OpenCms context is a member of the given role for the given organizational unit.
void	CmsRoleManager.checkRoleForResource(CmsObject cms, CmsRole role, java.lang.String resourceName) Checks if the user of this OpenCms context is a member of the given role for the given resource.
java.util.List<CmsResource>	CmsRoleManager.getManageableResources(CmsObject cms, CmsRole role) Returns all resources of organizational units for which the current user has the given role role.
java.util.List<CmsOrganizationalUnit>	CmsRoleManager.getOrgUnitsForRole(CmsObject cms, CmsRole role, boolean includeSubOus) Returns all the organizational units for which the current user has the given role.
java.util.Set<CmsGroup>	CmsRoleManager.getRoleGroups(CmsObject cms, CmsRole role, boolean directUsersOnly) Returns the groups which constitute a given role, i.e. the set of groups such that a member of any of them has the given role.
java.util.List<CmsUser>	CmsRoleManager.getUsersOfRole(CmsObject cms, CmsRole role, boolean includeOtherOuUsers, boolean directUsersOnly) Returns all direct users of a given role, in the given organizational unit.
boolean	CmsRoleManager.hasRole(CmsObject cms, CmsRole role) Checks if the given context user has the given role in the given organizational unit.
boolean	CmsRoleManager.hasRole(CmsObject cms, java.lang.String userName, CmsRole role) Checks if the given user has the given role in the given organizational unit.
boolean	CmsRoleManager.hasRoleForResource(CmsObject cms, CmsRole role, CmsResource resource) Checks if the given context user has the given role for the given resource.
boolean	CmsRoleManager.hasRoleForResource(CmsObject cms, CmsRole role, java.lang.String resourceName) Checks if the given context user has the given role for the given resource.
boolean	CmsRoleManager.hasRoleForResource(CmsObject cms, java.lang.String userName, CmsRole role, java.lang.String resourceName) Checks if the given context user has the given role for the given resource.
void	CmsRoleManager.removeUserFromRole(CmsObject cms, CmsRole role, java.lang.String username) Removes a user from a role, in the given organizational unit.

Method parameters in org.opencms.security with type arguments of type CmsRole

Modifier and Type	Method and Description
static void	CmsRole.applySystemRoleOrder(java.util.List<CmsRole> roles) Applies the system role order to a list of roles.
CmsPermissionSetCustom	CmsAccessControlList.getPermissions(CmsUser user, java.util.List<CmsGroup> groups, java.util.List<CmsRole> roles) Calculates the permissions of the given user and his groups from the access control list.
java.lang.String	CmsAccessControlList.getPermissionString(CmsUser user, java.util.List<CmsGroup> groups, java.util.List<CmsRole> roles) Calculates the permissions of the given user and his groups from the access control list.

Constructors in org.opencms.security with parameters of type CmsRole

Constructor and Description
CmsRole(java.lang.String roleName, CmsRole parentRole, java.lang.String groupName, boolean ouDependent) Creates a user defined role.

Uses of CmsRole in org.opencms.ui.apps

Methods in org.opencms.ui.apps that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsSitemapEditorConfiguration.getRequiredRole()
CmsRole	I_CmsWorkplaceAppConfiguration.getRequiredRole() Returns the user role required for this app.
CmsRole	CmsLegacyAppConfiguration.getRequiredRole()
CmsRole	CmsPageEditorConfiguration.getRequiredRole()
CmsRole	CmsEditorConfiguration.getRequiredRole()
CmsRole	A_CmsWorkplaceAppConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.cacheadmin

Methods in org.opencms.ui.apps.cacheadmin that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsCacheViewFlexConfiguration.getRequiredRole()
CmsRole	CmsCacheViewImageConfiguration.getRequiredRole()
CmsRole	CmsCacheAdminConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.dbmanager

Methods in org.opencms.ui.apps.dbmanager that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsDbImportServerConfiguration.getRequiredRole()
CmsRole	CmsDbExportConfiguration.getRequiredRole()
CmsRole	CmsDbStaticExportConfiguration.getRequiredRole()
CmsRole	CmsDbPropertiesAppConfiguration.getRequiredRole()
CmsRole	CmsDbManagerConfiguration.getRequiredRole()
CmsRole	CmsDbRemovePubLocksConfiguration.getRequiredRole()
CmsRole	CmsDbSynchronizationConfiguration.getRequiredRole()
CmsRole	CmsDbImportHTTPConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.dbmanager.sqlconsole

Methods in org.opencms.ui.apps.dbmanager.sqlconsole that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsSqlConsoleAppConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.filehistory

Methods in org.opencms.ui.apps.filehistory that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsFileHistoryConfiguration.getRequiredRole()
CmsRole	CmsFileHistoryClearConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.git

Methods in org.opencms.ui.apps.git that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsGitAppConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.lists

Methods in org.opencms.ui.apps.lists that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsListManagerConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.logfile

Methods in org.opencms.ui.apps.logfile that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsLogFileConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.modules

Methods in org.opencms.ui.apps.modules that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsModuleAppConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.projects

Methods in org.opencms.ui.apps.projects that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsProjectManagerConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.publishqueue

Methods in org.opencms.ui.apps.publishqueue that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsPublishQueueConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.resourcetypes

Methods in org.opencms.ui.apps.resourcetypes that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsResourceTypeAppConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.scheduler

Methods in org.opencms.ui.apps.scheduler that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsScheduledJobsAppConfig.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.search

Methods in org.opencms.ui.apps.search that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsSourceSearchAppConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.searchindex

Methods in org.opencms.ui.apps.searchindex that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsSearchindexAppConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.sessions

Methods in org.opencms.ui.apps.sessions that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsBroadCastConfigurtion.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.shell

Methods in org.opencms.ui.apps.shell that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsShellAppConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.sitemanager

Methods in org.opencms.ui.apps.sitemanager that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsSiteManagerConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.ui.apps.user

Methods in org.opencms.ui.apps.user that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsAccountsAppConfiguration.getRequiredRole()

Methods in org.opencms.ui.apps.user that return types with arguments of type CmsRole

Modifier and Type	Method and Description
protected com.vaadin.ui.ComboBox<CmsRole>	CmsImportExportUserDialog.getRoleComboBox(java.lang.String ou) Get ComboBox for selecting roles.

Methods in org.opencms.ui.apps.user with parameters of type CmsRole

Modifier and Type	Method and Description
protected void	CmsRoleTable.updateApp(CmsRole role) Updates app.

Method parameters in org.opencms.ui.apps.user with type arguments of type CmsRole

Modifier and Type	Method and Description
protected static void	CmsUserEditDialog.iniRole(CmsObject cms, java.lang.String ou, com.vaadin.ui.ComboBox<CmsRole> roleComboBox, org.apache.commons.logging.Log log) Initialized the role ComboBox.

Constructor parameters in org.opencms.ui.apps.user with type arguments of type CmsRole

Constructor and Description
CmsImportUserThread(CmsObject cms, java.lang.String ou, java.util.List<CmsUser> userList, java.util.List<java.lang.String> groups, java.util.List<CmsRole> roles, boolean sendmail) public constructor.

Uses of CmsRole in org.opencms.widgets

Methods in org.opencms.widgets that return CmsRole

Modifier and Type	Method and Description
CmsRole	CmsOrgUnitWidget.getRole() Returns the role, or null if none.

Constructors in org.opencms.widgets with parameters of type CmsRole

Constructor and Description
CmsOrgUnitWidget(CmsRole role) Creates a new user selection widget with the parameters to configure the popup window behaviour.