org.alfresco.repo.security.sync
Interface UserRegistry

All Known Implementing Classes:
ChainingUserRegistrySynchronizerTest.MockUserRegistry, LDAPUserRegistry

public interface UserRegistry

A UserRegistry is an encapsulation of an external registry from which user and group information can be queried (typically an LDAP directory). Implementations may optional support the ability to query only those users and groups modified since a certain time.


Method Summary
 java.util.Collection getGroups(java.util.Date modifiedSince)
          Gets descriptions of all the groups in the user registry or all those changed since a certain date.
 java.util.Collection getPersons(java.util.Date modifiedSince)
          Gets descriptions of all the persons (users) in the user registry or all those changed since a certain date.
 void processDeletions(java.util.Set candidateAuthoritiesForDeletion)
          Retrieves the complete set of known users and groups from the user registry and removes them from the set of candidate local authorities to be deleted.
 

Method Detail

getPersons

java.util.Collection getPersons(java.util.Date modifiedSince)
Gets descriptions of all the persons (users) in the user registry or all those changed since a certain date.

Parameters:
modifiedSince - if non-null, then only descriptions of users modified since this date should be returned; if null then descriptions of all users should be returned.
Returns:
a Collection of NodeDescriptions of all the persons (users) in the user registry or all those changed since a certain date. The description properties should correspond to those of an Alfresco person node.

getGroups

java.util.Collection getGroups(java.util.Date modifiedSince)
Gets descriptions of all the groups in the user registry or all those changed since a certain date.

Parameters:
modifiedSince - if non-null, then only descriptions of groups modified since this date should be returned; if null then descriptions of all groups should be returned.
Returns:
a Collection of NodeDescriptions of all the groups in the user registry or all those changed since a certain date. The description properties should correspond to those of an Alfresco authority node.

processDeletions

void processDeletions(java.util.Set candidateAuthoritiesForDeletion)
Retrieves the complete set of known users and groups from the user registry and removes them from the set of candidate local authorities to be deleted.

Parameters:
candidateAuthoritiesForDeletion - the candidate authorities for deletion


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.