Uses of Class
org.opencms.security.CmsRole

Packages that use CmsRole

Package	Description
org.opencms.ade.configuration	Contains the ade configuration classes.
org.opencms.ade.contenteditor	Contains server side classes for the XML content editor.
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.datesearch
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.unusedcontentfinder
org.opencms.ui.apps.user	Contains classes of the user manager app.
org.opencms.ui.apps.userdata
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.ade.configuration

Methods in org.opencms.ade.configuration that return CmsRole

Modifier and Type	Method	Description
protected CmsRole	CmsADEManager.getRoleForSitemapConfigEditing()	Gets the role necessary to edit sitemap configuration files.

Uses of CmsRole in org.opencms.ade.contenteditor

Fields in org.opencms.ade.contenteditor declared as CmsRole

Modifier and Type	Field	Description
static final CmsRole	CmsAccessRestrictionInfo.ROLE_CAN_IGNORE_GROUP	The role that can ignore group membership for manipulating the 'restricted' status.

Uses of CmsRole in org.opencms.db

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

Modifier and Type	Method	Description
List<CmsRole>	CmsDriverManager.getRolesForResource(CmsDbContext dbc, CmsUser user, CmsResource resource)	Returns all roles the given user has for the given resource.
List<CmsRole>	CmsSecurityManager.getRolesForResource(CmsRequestContext context, CmsUser user, CmsResource resource)	Returns all roles the given user has for the given resource.
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	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, String username, CmsRole role)	Checks that the current user has enough permissions to modify the given user.
protected List<CmsResource>	CmsSecurityManager.getManageableResources(CmsDbContext dbc, CmsRole role)	Returns all resources of organizational units for which the current user has the given role role.
List<CmsResource>	CmsSecurityManager.getManageableResources(CmsRequestContext context, CmsRole role)	Returns all resources of organizational units for which the current user has the given role role.
List<CmsOrganizationalUnit>	CmsDriverManager.getOrgUnitsForRole(CmsDbContext dbc, CmsRole role, boolean includeSubOus)	Returns all the organizational units for which the current user has the given role.
List<CmsOrganizationalUnit>	CmsSecurityManager.getOrgUnitsForRole(CmsRequestContext requestContext, CmsRole role, boolean includeSubOus)	Returns all the organizational units for which the current user has the given role.
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, 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	Description
protected void	CmsUserDriver.internalUpdateRoleGroup(CmsDbContext dbc, 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	Description
static 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	Description
boolean	CmsShell.validateUser(String userName, 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	Description
List<CmsRole>	CmsGroupListCache.getBareRoles(CmsUUID userId)	Gets the cached bare roles for the given user id, or null if none are cached.
List<CmsRole>	CmsMemoryMonitor.getCachedRoleList(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	Description
void	CmsMemoryMonitor.cacheRoleList(String key, List<CmsRole> roles)	Caches the given value under the given cache key.
void	CmsGroupListCache.setBareRoles(CmsUser user, List<CmsRole> bareRoles)	Sets the bare roles for a user (with no OU information).

Uses of CmsRole in org.opencms.security

Fields in org.opencms.security declared as CmsRole

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

Methods in org.opencms.security that return CmsRole

Modifier and Type	Method	Description
CmsRole	CmsRole.forOrgUnit(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.
CmsRole	CmsRoleAsPrincipal.getRole()	Gets the wrapped role.
static CmsRole	CmsRole.valueOf(CmsGroup group)	Returns the role for the given group.
static CmsRole	CmsRole.valueOfGroupName(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(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	Description
List<CmsRole>	CmsRole.getChildren(boolean recursive)	Returns a list of all sub roles.
List<CmsRole>	CmsRoleManager.getRoles(CmsObject cms, String ouFqn, boolean includeSubOus)	Returns all roles, in the given organizational unit.
List<CmsRole>	CmsRoleManager.getRolesForResource(CmsObject cms, String userFqn, String resourceName)	Returns all roles the given user has over the given resource.
List<CmsRole>	CmsRoleManager.getRolesForResource(CmsObject cms, CmsUser user, CmsResource resource)	Returns all roles the given user has over the given resource.
List<CmsRole>	CmsRoleManager.getRolesOfUser(CmsObject cms, String username, String ouFqn, boolean includeChildOus, boolean directRolesOnly, boolean recursive)	Returns all roles the given user belongs to, in the given organizational unit.
static 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	Description
void	CmsRoleManager.addUserToRole(CmsObject cms, CmsRole role, 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, String resourceName)	Checks if the user of this OpenCms context is a member of the given role for the given resource.
List<CmsResource>	CmsRoleManager.getManageableResources(CmsObject cms, CmsRole role)	Returns all resources of organizational units for which the current user has the given role role.
List<CmsOrganizationalUnit>	CmsRoleManager.getOrgUnitsForRole(CmsObject cms, CmsRole role, boolean includeSubOus)	Returns all the organizational units for which the current user has the given role.
Set<CmsGroup>	CmsRoleManager.getRoleGroups(CmsObject cms, CmsRole role, boolean directUsersOnly)	Returns the groups which constitute a given role, i.e.
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, String userName, CmsRole role)	Checks if the given user has the 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.hasRoleForResource(CmsObject cms, String userName, CmsRole role, String resourceName)	Checks if the given context user has the given role for the given resource.
boolean	CmsRoleManager.hasRoleForResource(CmsObject cms, CmsRole role, String resourceName)	Checks if the given context user has the given role for the given resource.
boolean	CmsRoleManager.hasRoleForResource(CmsObject cms, CmsRole role, CmsResource resource)	Checks if the given context user has the given role for the given resource.
void	CmsRoleManager.removeUserFromRole(CmsObject cms, CmsRole role, 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	Description
static void	CmsRole.applySystemRoleOrder(List<CmsRole> roles)	Applies the system role order to a list of roles.

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

Modifier	Constructor	Description
	CmsRole(String roleName, CmsRole parentRole, String groupName, boolean ouDependent)	Creates a user defined role.
	CmsRoleAsPrincipal(CmsRole role)	Creates a new instane.

Uses of CmsRole in org.opencms.ui.apps

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

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

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

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

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

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

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

Modifier and Type	Method	Description
CmsRole	CmsDateSearchConfiguration.getRequiredRole()

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

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

Modifier and Type	Method	Description
CmsRole	CmsDbExportConfiguration.getRequiredRole()
CmsRole	CmsDbImportHTTPConfiguration.getRequiredRole()
CmsRole	CmsDbImportServerConfiguration.getRequiredRole()
CmsRole	CmsDbManagerConfiguration.getRequiredRole()
CmsRole	CmsDbPropertiesAppConfiguration.getRequiredRole()
CmsRole	CmsDbRemovePubLocksConfiguration.getRequiredRole()
CmsRole	CmsDbStaticExportConfiguration.getRequiredRole()
CmsRole	CmsDbSynchronizationConfiguration.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	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	Description
CmsRole	CmsFileHistoryConfiguration.getRequiredRole()

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

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

Modifier and Type	Method	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	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	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	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	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	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	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	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	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	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	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	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	Description
CmsRole	CmsSiteManagerConfiguration.getRequiredRole()

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

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

Modifier and Type	Method	Description
CmsRole	CmsUnusedContentFinderConfiguration.getRequiredRole()

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

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

Modifier and Type	Method	Description
CmsRole	CmsAccountsAppConfiguration.getRequiredRole()

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

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

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

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

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

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

Modifier and Type	Method	Description
CmsRole	CmsUserDataAppConfiguration.getRequiredRole()

Uses of CmsRole in org.opencms.widgets

Methods in org.opencms.widgets that return CmsRole

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

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

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