类 org.opencms.file.CmsGroup
的使用

使用CmsGroup的程序包

程序包	说明
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.file	This important package provides the methods to access the OpenCms VFS repository with the permissions of an authenticated user.
org.opencms.importexport	Contains functions to import and export resources from the OpenCms VFS.
org.opencms.jsp	The implementation of the OpenCms JSP tag library, with some additional utility classes to help in JSP scriplet code and navigation building.
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.workplace.tools.accounts	This package contains the tool classes for the account management related administration views.

org.opencms.db中CmsGroup的使用

返回CmsGroup的org.opencms.db中的方法

限定符和类型	方法和说明
CmsGroup	CmsDriverManager.createGroup(CmsDbContext dbc, CmsUUID id, java.lang.String name, java.lang.String description, int flags, java.lang.String parent) Add a new group to the Cms.
CmsGroup	I_CmsUserDriver.createGroup(CmsDbContext dbc, CmsUUID groupId, java.lang.String groupFqn, java.lang.String description, int flags, java.lang.String parentGroupName) Creates a new group.
CmsGroup	CmsSecurityManager.createGroup(CmsRequestContext context, java.lang.String name, java.lang.String description, int flags, java.lang.String parent) Creates a new user group.
CmsGroup	CmsDriverManager.getParent(CmsDbContext dbc, java.lang.String groupname) Returns the parent group of a group.
CmsGroup	CmsSecurityManager.getParent(CmsRequestContext context, java.lang.String groupname) Returns the parent group of a group.
CmsGroup	CmsDriverManager.readGroup(CmsDbContext dbc, CmsProject project) Reads the group of a project.
CmsGroup	CmsDriverManager.readGroup(CmsDbContext dbc, CmsUUID groupId) Reads a group based on its id.
CmsGroup	I_CmsUserDriver.readGroup(CmsDbContext dbc, CmsUUID groupId) Reads a group based on the group id.
CmsGroup	CmsDriverManager.readGroup(CmsDbContext dbc, java.lang.String groupname) Reads a group based on its name.
CmsGroup	I_CmsUserDriver.readGroup(CmsDbContext dbc, java.lang.String groupFqn) Reads a group based on the group name.
CmsGroup	CmsSecurityManager.readGroup(CmsRequestContext context, CmsProject project) Reads the group of a project.
CmsGroup	CmsSecurityManager.readGroup(CmsRequestContext context, CmsUUID groupId) Reads a group based on its id.
CmsGroup	CmsSecurityManager.readGroup(CmsRequestContext context, java.lang.String groupname) Reads a group based on its name.
CmsGroup	CmsDriverManager.readManagerGroup(CmsDbContext dbc, CmsProject project) Reads the manager group of a project.
CmsGroup	CmsSecurityManager.readManagerGroup(CmsRequestContext context, CmsProject project) Reads the manager group of a project.

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

限定符和类型	方法和说明
java.util.List<CmsGroup>	CmsDriverManager.getChildren(CmsDbContext dbc, CmsGroup group, boolean includeSubChildren) Returns all child groups of a group.
java.util.List<CmsGroup>	CmsSecurityManager.getChildren(CmsRequestContext context, java.lang.String groupname, boolean includeSubChildren) Returns all child groups of a group.
java.util.List<CmsGroup>	CmsSubscriptionFilter.getGroups() Returns the groups to check subscribed resources for.
java.util.List<CmsGroup>	CmsDriverManager.getGroups(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, boolean includeSubOus, boolean readRoles) Returns all groups of the given organizational unit.
java.util.List<CmsGroup>	I_CmsUserDriver.getGroups(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, boolean includeSubOus, boolean readRoles) Returns all groups of the given organizational unit.
java.util.List<CmsGroup>	CmsSecurityManager.getGroups(CmsRequestContext context, CmsOrganizationalUnit orgUnit, boolean includeSubOus, boolean readRoles) Returns all groups of the given organizational unit.
java.util.List<CmsGroup>	CmsDriverManager.getGroupsOfUser(CmsDbContext dbc, java.lang.String username, boolean readRoles) Returns the groups of an user filtered by the specified IP address.
java.util.List<CmsGroup>	CmsDriverManager.getGroupsOfUser(CmsDbContext dbc, java.lang.String username, java.lang.String ouFqn, boolean includeChildOus, boolean readRoles, boolean directGroupsOnly, java.lang.String remoteAddress) Returns the groups of an user filtered by the specified IP address.
java.util.List<CmsGroup>	CmsSecurityManager.getGroupsOfUser(CmsRequestContext context, java.lang.String username, java.lang.String ouFqn, boolean includeChildOus, boolean readRoles, boolean directGroupsOnly, java.lang.String remoteAddress) Returns the list of groups to which the user directly belongs to.
java.util.Set<CmsGroup>	CmsDriverManager.getRoleGroups(CmsDbContext dbc, java.lang.String roleGroupName, boolean directUsersOnly) Collects the groups which constitute a given role.
java.util.Set<CmsGroup>	CmsSecurityManager.getRoleGroups(CmsRequestContext context, CmsRole role, boolean directUsersOnly) Gets the groups which constitute a given role.
java.util.Set<CmsGroup>	CmsDriverManager.getRoleGroupsImpl(CmsDbContext dbc, java.lang.String roleGroupName, boolean directUsersOnly, java.util.Map<java.lang.String,java.util.Set<CmsGroup>> accumulator) Collects the groups which constitute a given role.
java.util.List<CmsGroup>	I_CmsUserDriver.readChildGroups(CmsDbContext dbc, java.lang.String groupFqn) Reads all child groups of a group.
java.util.List<CmsGroup>	I_CmsUserDriver.readGroupsOfUser(CmsDbContext dbc, CmsUUID userId, java.lang.String ouFqn, boolean includeChildOus, java.lang.String remoteAddress, boolean readRoles) Reads all groups the given user is a member in.

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

限定符和类型	方法和说明
void	CmsSubscriptionFilter.addGroup(CmsGroup group) Adds a group to the list of groups to check subscribed resources for.
CmsProject	I_CmsProjectDriver.createProject(CmsDbContext dbc, CmsUUID id, CmsUser owner, CmsGroup group, CmsGroup managergroup, java.lang.String name, java.lang.String description, int flags, CmsProject.CmsProjectType type) Creates a new project.
void	CmsDriverManager.deleteGroup(CmsDbContext dbc, CmsGroup group, CmsUUID replacementId) Deletes a group, where all permissions, users and children of the group are transfered to a replacement group.
java.lang.String	I_CmsCacheKey.getCacheKeyForGroupUsers(java.lang.String prefix, CmsDbContext context, CmsGroup group) Returns the cache key for the group users cache.
java.lang.String	CmsCacheKey.getCacheKeyForGroupUsers(java.lang.String prefix, CmsDbContext context, CmsGroup group)
java.util.List<CmsGroup>	CmsDriverManager.getChildren(CmsDbContext dbc, CmsGroup group, boolean includeSubChildren) Returns all child groups of a group.
java.util.List<CmsProject>	I_CmsProjectDriver.readProjectsForGroup(CmsDbContext dbc, CmsGroup group) Returns all projects, which are accessible by a group.
java.util.List<CmsProject>	I_CmsProjectDriver.readProjectsForManagerGroup(CmsDbContext dbc, CmsGroup group) Returns all projects, which are manageable by a group.
void	CmsDriverManager.writeGroup(CmsDbContext dbc, CmsGroup group) Writes an already existing group.
void	I_CmsUserDriver.writeGroup(CmsDbContext dbc, CmsGroup group) Writes an already existing group.
void	CmsSecurityManager.writeGroup(CmsRequestContext context, CmsGroup group) Writes an already existing group.

类型变量类型为CmsGroup的org.opencms.db中的方法参数

限定符和类型	方法和说明
java.util.Set<CmsGroup>	CmsDriverManager.getRoleGroupsImpl(CmsDbContext dbc, java.lang.String roleGroupName, boolean directUsersOnly, java.util.Map<java.lang.String,java.util.Set<CmsGroup>> accumulator) Collects the groups which constitute a given role.
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.
java.util.List<I_CmsHistoryResource>	I_CmsSubscriptionDriver.readSubscribedDeletedResources(CmsDbContext dbc, java.lang.String poolName, CmsUser user, java.util.List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom) Returns the subscribed history resources that were deleted.
java.util.List<I_CmsHistoryResource>	CmsDriverManager.readSubscribedDeletedResources(CmsDbContext dbc, java.lang.String poolName, CmsUser user, java.util.List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom) Returns the subscribed history resources that were deleted.
java.util.List<I_CmsHistoryResource>	CmsSecurityManager.readSubscribedDeletedResources(CmsRequestContext context, java.lang.String poolName, CmsUser user, java.util.List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom) Returns the subscribed history resources that were deleted.
void	CmsSubscriptionFilter.setGroups(java.util.List<CmsGroup> groups) Sets the groups to check subscribed resources for.

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

返回CmsGroup的org.opencms.db.generic中的方法

限定符和类型	方法和说明
CmsGroup	CmsUserDriver.createGroup(CmsDbContext dbc, CmsUUID groupId, java.lang.String groupFqn, java.lang.String description, int flags, java.lang.String parentGroupFqn)
protected CmsGroup	CmsUserDriver.internalCreateGroup(java.sql.ResultSet res) Semi-constructor to create a CmsGroup instance from a JDBC result set.
CmsGroup	CmsUserDriver.readGroup(CmsDbContext dbc, CmsUUID groupId)
CmsGroup	CmsUserDriver.readGroup(CmsDbContext dbc, java.lang.String groupFqn)

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

限定符和类型	方法和说明
java.util.List<CmsGroup>	CmsUserDriver.getGroups(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, boolean includeSubOus, boolean readRoles)
java.util.List<CmsGroup>	CmsUserDriver.readChildGroups(CmsDbContext dbc, java.lang.String parentGroupFqn)
java.util.List<CmsGroup>	CmsUserDriver.readGroupsOfUser(CmsDbContext dbc, CmsUUID userId, java.lang.String ouFqn, boolean includeChildOus, java.lang.String remoteAddress, boolean readRoles)

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

限定符和类型	方法和说明
CmsProject	CmsProjectDriver.createProject(CmsDbContext dbc, CmsUUID id, CmsUser owner, CmsGroup group, CmsGroup managergroup, java.lang.String projectFqn, java.lang.String description, int flags, CmsProject.CmsProjectType type)
java.util.List<CmsProject>	CmsProjectDriver.readProjectsForGroup(CmsDbContext dbc, CmsGroup group)
java.util.List<CmsProject>	CmsProjectDriver.readProjectsForManagerGroup(CmsDbContext dbc, CmsGroup group)
void	CmsUserDriver.writeGroup(CmsDbContext dbc, CmsGroup group)

类型变量类型为CmsGroup的org.opencms.db.generic中的方法参数

限定符和类型	方法和说明
java.util.List<I_CmsHistoryResource>	CmsSubscriptionDriver.readSubscribedDeletedResources(CmsDbContext dbc, java.lang.String poolName, CmsUser user, java.util.List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom)

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

返回CmsGroup的org.opencms.db.jpa中的方法

限定符和类型	方法和说明
CmsGroup	CmsUserDriver.createGroup(CmsDbContext dbc, CmsUUID groupId, java.lang.String groupFqn, java.lang.String description, int flags, java.lang.String parentGroupFqn)
protected CmsGroup	CmsUserDriver.internalCreateGroup(CmsDAOGroups g) Semi-constructor to create a CmsGroup instance from a JDBC result set.
CmsGroup	CmsUserDriver.readGroup(CmsDbContext dbc, CmsUUID groupId)
CmsGroup	CmsUserDriver.readGroup(CmsDbContext dbc, java.lang.String groupFqn)

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

限定符和类型	方法和说明
java.util.List<CmsGroup>	CmsUserDriver.getGroups(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, boolean includeSubOus, boolean readRoles)
java.util.List<CmsGroup>	CmsUserDriver.readChildGroups(CmsDbContext dbc, java.lang.String parentGroupFqn)
java.util.List<CmsGroup>	CmsUserDriver.readGroupsOfUser(CmsDbContext dbc, CmsUUID userId, java.lang.String ouFqn, boolean includeChildOus, java.lang.String remoteAddress, boolean readRoles)

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

限定符和类型	方法和说明
CmsProject	CmsProjectDriver.createProject(CmsDbContext dbc, CmsUUID id, CmsUser owner, CmsGroup group, CmsGroup managergroup, java.lang.String projectFqn, java.lang.String description, int flags, CmsProject.CmsProjectType type)
java.util.List<CmsProject>	CmsProjectDriver.readProjectsForGroup(CmsDbContext dbc, CmsGroup group)
java.util.List<CmsProject>	CmsProjectDriver.readProjectsForManagerGroup(CmsDbContext dbc, CmsGroup group)
void	CmsUserDriver.writeGroup(CmsDbContext dbc, CmsGroup group)

类型变量类型为CmsGroup的org.opencms.db.jpa中的方法参数

限定符和类型	方法和说明
java.util.List<I_CmsHistoryResource>	CmsSubscriptionDriver.readSubscribedDeletedResources(CmsDbContext dbc, java.lang.String poolName, CmsUser user, java.util.List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom)

org.opencms.file中CmsGroup的使用

返回CmsGroup的org.opencms.file中的方法

限定符和类型	方法和说明
CmsGroup	CmsObject.createGroup(java.lang.String groupFqn, java.lang.String description, int flags, java.lang.String parent) Creates a new user group.
CmsGroup	CmsUserSearchParameters.getGroup() Returns the group such that users which are not in the group will be filtered out.
CmsGroup	CmsUserSearchParameters.getNotGroup() Returns the group such that users not in that group will be filtered out.
CmsGroup	CmsObject.getParent(java.lang.String groupname) Returns the parent group of a group.
CmsGroup	CmsObject.readGroup(CmsProject project) Reads the group of a project.
CmsGroup	CmsObject.readGroup(CmsUUID groupId) Reads a group based on its id.
CmsGroup	CmsObject.readGroup(java.lang.String groupName) Reads a group based on its name.
CmsGroup	CmsObject.readManagerGroup(CmsProject project) Returns the project manager group of a project.

返回变量类型为CmsGroup的类型的org.opencms.file中的方法

限定符和类型	方法和说明
java.util.Collection<CmsGroup>	CmsUserSearchParameters.getAnyGroups() Returns the collection of groups such that returned users must be in at least one of them.
java.util.List<CmsGroup>	CmsObject.getChildren(java.lang.String groupname, boolean includeSubChildren) Returns all child groups of a group.
java.util.List<CmsGroup>	CmsObject.getGroupsOfUser(java.lang.String username, boolean directGroupsOnly) Returns all the groups the given user belongs to.
java.util.List<CmsGroup>	CmsObject.getGroupsOfUser(java.lang.String username, boolean directGroupsOnly, boolean includeOtherOus) Returns all the groups the given user belongs to.
java.util.List<CmsGroup>	CmsObject.getGroupsOfUser(java.lang.String username, boolean directGroupsOnly, boolean includeOtherOus, java.lang.String remoteAddress) Returns the groups of a user filtered by the specified IP address.
java.util.Collection<CmsGroup>	CmsUserSearchParameters.getNotAnyGroups() Returns the groups whose users may not appear in the search results.

参数类型为CmsGroup的org.opencms.file中的方法

限定符和类型	方法和说明
void	CmsUserSearchParameters.setGroup(CmsGroup group) Sets the group such that users which are not in the group will be filtered out.
void	CmsUserSearchParameters.setNotGroup(CmsGroup group) Sets the group such that users not in that group will be filtered out.
void	CmsObject.writeGroup(CmsGroup group) Writes an already existing group.

类型变量类型为CmsGroup的org.opencms.file中的方法参数

限定符和类型	方法和说明
void	CmsUserSearchParameters.setAnyGroups(java.util.Collection<CmsGroup> anyGroups) Sets the groups such that returned users must be in at least one of them.
void	CmsUserSearchParameters.setNotAnyGroups(java.util.Collection<CmsGroup> groups) Sets the groups whose users may not appear in the search results.

org.opencms.importexport中CmsGroup的使用

参数类型为CmsGroup的org.opencms.importexport中的方法

限定符和类型	方法和说明
protected void	CmsExport.exportGroup(org.dom4j.Element parent, CmsGroup group) Exports one single group with all it's data.

org.opencms.jsp中CmsGroup的使用

类型变量类型为CmsGroup的org.opencms.jsp中的方法参数

限定符和类型	方法和说明
protected static java.lang.String	CmsJspTagUserTracking.generateSessionKey(java.lang.String prefix, java.lang.String fileName, boolean subFolder, CmsUser user, java.util.List<CmsGroup> groups) Returns a unique session key depending on the values of the given parameters.
protected static boolean	CmsJspTagUserTracking.isResourceSubscribed(CmsObject cms, java.lang.String fileName, boolean subFolder, CmsUser user, java.util.List<CmsGroup> groups, javax.servlet.http.HttpServletRequest req) Returns if the given resource is subscribed to the user or groups.

org.opencms.monitor中CmsGroup的使用

返回CmsGroup的org.opencms.monitor中的方法

限定符和类型	方法和说明
CmsGroup	CmsMemoryMonitor.getCachedGroup(java.lang.String key) Returns the group cached with the given cache key or null if not found.

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

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

参数类型为CmsGroup的org.opencms.monitor中的方法

限定符和类型	方法和说明
void	CmsMemoryMonitor.cacheGroup(CmsGroup group) Caches the given group under its id AND fully qualified name.
void	CmsMemoryMonitor.uncacheGroup(CmsGroup group) Removes the given group from the cache.

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

限定符和类型	方法和说明
void	CmsMemoryMonitor.cacheUserGroups(java.lang.String key, java.util.List<CmsGroup> userGroups) Caches the given list of user groups under the given cache key.

org.opencms.security中CmsGroup的使用

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

限定符和类型	方法和说明
static java.util.List<CmsGroup>	CmsPrincipal.filterCoreGroups(java.util.List<CmsGroup> groups) Filters out all groups with flags greater than I_CmsPrincipal.FLAG_CORE_LIMIT.
java.util.List<CmsGroup>	CmsOrgUnitManager.getGroups(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus) Returns all groups of the given organizational unit.
java.util.List<CmsGroup>	CmsRoleManager.getManageableGroups(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus) Returns all groups of organizational units for which the current user has the CmsRole.ACCOUNT_MANAGER 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.

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

限定符和类型	方法和说明
static CmsRole	CmsRole.valueOf(CmsGroup group) Returns the role for the given group.

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

限定符和类型	方法和说明
static java.util.List<CmsGroup>	CmsPrincipal.filterCoreGroups(java.util.List<CmsGroup> groups) Filters out all groups with flags greater than I_CmsPrincipal.FLAG_CORE_LIMIT.
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.

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

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

限定符和类型	字段和说明
protected CmsGroup	A_CmsEditGroupDialog.m_group The user object that is edited on this dialog.
protected CmsGroup	CmsGroupOverviewDialog.m_group The user object that is edited on this dialog.

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

限定符和类型	方法和说明
java.util.List<CmsGroup>	A_CmsUserDataImexportDialog.getGroups() Returns the list of groups.
protected java.util.List<CmsGroup>	CmsGroupTransferList.getGroups() Returns the list of groups to display.
protected abstract java.util.List<CmsGroup>	A_CmsGroupsList.getGroups() Returns a list of groups.
protected java.util.List<CmsGroup>	CmsGroupsAllOrgUnitsList.getGroups()
protected java.util.List<CmsGroup>	CmsGroupsList.getGroups()
protected abstract java.util.List<CmsGroup>	A_CmsUserGroupsList.getGroups(boolean withOtherOus) Returns a list of groups to display.
protected java.util.List<CmsGroup>	CmsNotUserGroupsList.getGroups(boolean withOtherOus)
protected java.util.List<CmsGroup>	CmsShowUserGroupsList.getGroups(boolean withOtherOus)

参数类型为CmsGroup的org.opencms.workplace.tools.accounts中的方法

限定符和类型	方法和说明
protected abstract boolean	A_CmsEditGroupDialog.isEditable(CmsGroup group) Tests if the given group is editable or not.
protected boolean	CmsEditGroupDialog.isEditable(CmsGroup group)

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

限定符和类型	方法和说明
void	A_CmsUserDataImexportDialog.setGroups(java.util.List<CmsGroup> groups) Sets the groups list.