Package org.alfresco.repo.security.sync

Interface UserRegistry

All Known Implementing Classes:
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.
Author:
dward

  • Method Details

    • getPersons

      Collection<NodeDescription> getPersons(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

      Collection<NodeDescription> getGroups(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.

    • getPersonNames

      Collection<String> getPersonNames()
      Gets the names of all persons in the registry. Used to detect local persons to be deleted. Note that the treatment of these names will depend on Alfresco's username case-sensitivity setting.
      Returns:
      the person names

    • getGroupNames

      Collection<String> getGroupNames()
      Gets the names of all groups in the registry. Used to detect local groups to be deleted.
      Returns:
      the person names

    • getPersonMappedProperties

      Set<QName> getPersonMappedProperties()
      Gets the set of property names that are auto-mapped by this user registry. These should remain read-only for this registry's users in the UI.
      Returns:
      the person mapped properties

    • initSync

      default void initSync(Date modifiedSince, boolean syncDelete)
      Notifies the user registry that the sync process is about to start.
      Parameters:
      modifiedSince - if non-null, then only descriptions of groups and users modified since this date should be returned; if null then descriptions of all groups and users should be returned.
      syncDelete - if true then registry will be queried for all users and groups to calculate deleted entities