Package org.nuxeo.ecm.platform.computedgroups

Class DocumentMetadataGroupComputer

java.lang.Object

org.nuxeo.ecm.platform.computedgroups.AbstractGroupComputer

org.nuxeo.ecm.platform.computedgroups.DocumentMetadataGroupComputer

All Implemented Interfaces:

GroupComputer

public class DocumentMetadataGroupComputer
extends AbstractGroupComputer

Configurable Group Computer based on Metadata of Documents. Documents Selection is managed by NXQL where clause.

Since:

5.7.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	DocumentMetadataGroupComputer.GetDocumentsFromUsername

Constructor Summary

Constructors

Constructor	Description
DocumentMetadataGroupComputer(String whereClause, String groupPattern, String xpath)

Method Summary

Modifier and Type	Method	Description
List<String>	getAllGroupIds()	Return all group ids.
List<String>	getGroupMembers(String groupId)	Returns the members for a give group.
List<String>	getGroupsForUser(NuxeoPrincipalImpl user)	Returns the group names for a give User.
List<String>	getParentsGroupNames(String groupID)	Return parent groups.
List<String>	getSubGroupsNames(String groupID)	Returns children groups.
boolean	hasGroup(String groupId)	Default implementation that returns true if method GroupComputer.getAllGroupIds() contains given group name.

Methods inherited from class org.nuxeo.ecm.platform.computedgroups.AbstractGroupComputer

getUM, searchGroups, searchGroups

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocumentMetadataGroupComputer

public DocumentMetadataGroupComputer(String whereClause,
 String groupPattern,
 String xpath)

Method Details

getAllGroupIds

public List<String> getAllGroupIds()

Description copied from interface: GroupComputer

Return all group ids. If you class can not efficiently compute this list, you can return an empty list. In this case you need to implement the searchGroups method.

getGroupMembers

public List<String> getGroupMembers(String groupId)

Description copied from interface: GroupComputer

Returns the members for a give group.

getGroupsForUser

public List<String> getGroupsForUser(NuxeoPrincipalImpl user)

Description copied from interface: GroupComputer

Returns the group names for a give User.

getParentsGroupNames

public List<String> getParentsGroupNames(String groupID)

Description copied from interface: GroupComputer

Return parent groups.

getSubGroupsNames

public List<String> getSubGroupsNames(String groupID)

Description copied from interface: GroupComputer

Returns children groups.

hasGroup

public boolean hasGroup(String groupId)

Description copied from class: AbstractGroupComputer

Default implementation that returns true if method GroupComputer.getAllGroupIds() contains given group name.

Specified by:

hasGroup in interface GroupComputer

Overrides:

hasGroup in class AbstractGroupComputer