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

Field Summary

Fields

Modifier and Type	Field and Description
static Log	log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and 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

searchGroups

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final Log log

Constructor Detail

DocumentMetadataGroupComputer

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

Throws:

ClientException

Method Detail

getAllGroupIds

public List<String> getAllGroupIds()
                            throws Exception

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.

Throws:

Exception

getGroupMembers

public List<String> getGroupMembers(String groupId)
                             throws Exception

Description copied from interface: GroupComputer

Returns the members for a give group.

Throws:

Exception

getGroupsForUser

public List<String> getGroupsForUser(NuxeoPrincipalImpl user)
                              throws Exception

Description copied from interface: GroupComputer

Returns the group names for a give User.

Throws:

Exception

getParentsGroupNames

public List<String> getParentsGroupNames(String groupID)
                                  throws Exception

Description copied from interface: GroupComputer

Return parent groups.

Throws:

Exception

getSubGroupsNames

public List<String> getSubGroupsNames(String groupID)
                               throws Exception

Description copied from interface: GroupComputer

Returns children groups.

Throws:

Exception

hasGroup

public boolean hasGroup(String groupId)
                 throws Exception

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

Throws:

Exception