类 org.opencms.security.CmsRole
的使用

使用CmsRole的程序包

程序包	说明
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.db.jpa
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.widgets	Contains the widget implementations, these are GUI elements used in editors and dialogs of the OpenCms workplace.
org.opencms.workplace.tools.accounts	This package contains the tool classes for the account management related administration views.

org.opencms.db中CmsRole的使用

返回变量类型为CmsRole的类型的org.opencms.db中的方法

限定符和类型	方法和说明
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.

参数类型为CmsRole的org.opencms.db中的方法

限定符和类型	方法和说明
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.

org.opencms.db.generic中CmsRole的使用

参数类型为CmsRole的org.opencms.db.generic中的方法

限定符和类型	方法和说明
protected void	CmsUserDriver.internalUpdateRoleGroup(CmsDbContext dbc, java.lang.String groupName, CmsRole role) Updates a group to a virtual group.

org.opencms.db.jpa中CmsRole的使用

参数类型为CmsRole的org.opencms.db.jpa中的方法

限定符和类型	方法和说明
protected void	CmsUserDriver.internalUpdateRoleGroup(CmsDbContext dbc, java.lang.String groupName, CmsRole role) Updates a group to a virtual group.

org.opencms.main中CmsRole的使用

返回变量类型为CmsRole的类型的org.opencms.main中的方法

限定符和类型	方法和说明
static java.util.List<CmsRole>	OpenCms.getSystemRoles() Returns the list of system defined roles (instances of CmsRole).

org.opencms.monitor中CmsRole的使用

返回变量类型为CmsRole的类型的org.opencms.monitor中的方法

限定符和类型	方法和说明
java.util.List<CmsRole>	CmsMemoryMonitor.getCachedRoleList(java.lang.String key) Returns the value cached with the given cache key or null if not found.

类型变量类型为CmsRole的org.opencms.monitor中的方法参数

限定符和类型	方法和说明
void	CmsMemoryMonitor.cacheRoleList(java.lang.String key, java.util.List<CmsRole> roles) Caches the given value under the given cache key.

org.opencms.security中CmsRole的使用

声明为CmsRole的org.opencms.security中的字段

限定符和类型	字段和说明
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.DATABASE_MANAGER The "EXPORT_DATABASE" role.
static CmsRole	CmsRole.DEVELOPER The "DEVELOPER" 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.

返回CmsRole的org.opencms.security中的方法

限定符和类型	方法和说明
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.

返回变量类型为CmsRole的类型的org.opencms.security中的方法

限定符和类型	方法和说明
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, 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).

参数类型为CmsRole的org.opencms.security中的方法

限定符和类型	方法和说明
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, 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.

类型变量类型为CmsRole的org.opencms.security中的方法参数

限定符和类型	方法和说明
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.

参数类型为CmsRole的org.opencms.security中的构造器

构造器和说明
CmsRole(java.lang.String roleName, CmsRole parentRole, java.lang.String groupName, boolean ouDependent) Creates a user defined role.

org.opencms.widgets中CmsRole的使用

返回CmsRole的org.opencms.widgets中的方法

限定符和类型	方法和说明
CmsRole	CmsOrgUnitWidget.getRole() Returns the role, or null if none.

参数类型为CmsRole的org.opencms.widgets中的构造器

构造器和说明
CmsOrgUnitWidget(CmsRole role) Creates a new user selection widget with the parameters to configure the popup window behaviour.

org.opencms.workplace.tools.accounts中CmsRole的使用

声明为CmsRole的org.opencms.workplace.tools.accounts中的字段

限定符和类型	字段和说明
protected CmsRole	CmsRoleOverviewDialog.m_role The role object that is viewed on this dialog.

返回变量类型为CmsRole的类型的org.opencms.workplace.tools.accounts中的方法

限定符和类型	方法和说明
protected java.util.List<CmsRole>	CmsRolesList.getRoles()
java.util.List<CmsRole>	A_CmsUserDataImexportDialog.getRoles() Returns the list of roles to export.
protected java.util.List<CmsRole>	CmsRoleEditList.getRoles()
protected java.util.List<CmsRole>	CmsShowUserRolesList.getRoles()
protected abstract java.util.List<CmsRole>	A_CmsRolesList.getRoles() Returns all roles to display.

类型变量类型为CmsRole的org.opencms.workplace.tools.accounts中的方法参数

限定符和类型	方法和说明
void	A_CmsUserDataImexportDialog.setRoles(java.util.List<CmsRole> roles) Sets the roles list.