org.nuxeo.ecm.automation.core.util
Class PrincipalHelper

java.lang.Object
  org.nuxeo.ecm.automation.core.util.PrincipalHelper

public class PrincipalHelper
extends java.lang.Object

Provides helper methods to find extract permissions/principals info from documents.

Author:

Bogdan Stefanescu, Anahide Tchertchian

Constructor Summary

PrincipalHelper(UserManager userManager, PermissionProvider permissionProvider)

Method Summary

java.util.HashSet<?>	collectObjectsMatchingPermission(DocumentModel input, java.lang.String permission, boolean ignoreGroups, boolean resolveGroups, org.nuxeo.ecm.automation.core.util.PrincipalHelper.Collector<?> collector)
java.util.Set<java.lang.String>	getEmailsForPermission(DocumentModel input, java.lang.String permission, boolean ignoreGroups)
java.lang.String[]	getPermissionsToCheck(java.lang.String permission)
java.util.Set<NuxeoPrincipal>	getPrincipalsForPermission(DocumentModel input, java.lang.String permission, boolean ignoreGroups, boolean resolveGroups)
java.util.Set<java.lang.String>	getUserAndGroupIdsForPermission(DocumentModel input, java.lang.String permission, boolean ignoreGroups, boolean resolveGroups, boolean prefixIds) Resolves the list of identifiers for users and groups who have the given permission on given document.
boolean	permissionMatch(java.lang.String[] perms, java.lang.String perm)
void	resolveGroups(NuxeoGroup group, org.nuxeo.ecm.automation.core.util.PrincipalHelper.Collector<?> collector)

Methods inherited from class java.lang.Object

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

Constructor Detail

PrincipalHelper

public PrincipalHelper(UserManager userManager,
                       PermissionProvider permissionProvider)

Method Detail

getEmailsForPermission

public java.util.Set<java.lang.String> getEmailsForPermission(DocumentModel input,
                                                              java.lang.String permission,
                                                              boolean ignoreGroups)
                                                       throws ClientException

Throws:

ClientException

getUserAndGroupIdsForPermission

public java.util.Set<java.lang.String> getUserAndGroupIdsForPermission(DocumentModel input,
                                                                       java.lang.String permission,
                                                                       boolean ignoreGroups,
                                                                       boolean resolveGroups,
                                                                       boolean prefixIds)
                                                                throws ClientException

Resolves the list of identifiers for users and groups who have the given permission on given document.

Parameters:

input - document model to resolve users and groups on.

permission - the permission to check

ignoreGroups - if true, will ignore groups in resolution of ids

resolveGroups - if true, will resolve user members, iterating in the hierarchy of groups

prefixIds - if true, will prefix identifiers with NuxeoPrincipal.PREFIX and NuxeoGroup.PREFIX

Throws:

ClientException

getPrincipalsForPermission

public java.util.Set<NuxeoPrincipal> getPrincipalsForPermission(DocumentModel input,
                                                                java.lang.String permission,
                                                                boolean ignoreGroups,
                                                                boolean resolveGroups)
                                                         throws ClientException

Throws:

ClientException

collectObjectsMatchingPermission

public java.util.HashSet<?> collectObjectsMatchingPermission(DocumentModel input,
                                                             java.lang.String permission,
                                                             boolean ignoreGroups,
                                                             boolean resolveGroups,
                                                             org.nuxeo.ecm.automation.core.util.PrincipalHelper.Collector<?> collector)
                                                      throws ClientException

Throws:

ClientException

resolveGroups

public void resolveGroups(NuxeoGroup group,
                          org.nuxeo.ecm.automation.core.util.PrincipalHelper.Collector<?> collector)
                   throws ClientException

Throws:

ClientException

getPermissionsToCheck

public java.lang.String[] getPermissionsToCheck(java.lang.String permission)

permissionMatch

public boolean permissionMatch(java.lang.String[] perms,
                               java.lang.String perm)