Files
alfresco-community-repo/source/java/org/alfresco/repo/security/sync/UserRegistry.java
Raluca Munteanu 6afb44e712 Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125788 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-26 13:45:01 +00:00

90 lines
3.7 KiB
Java

/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.repo.security.sync;
import java.util.Collection;
import java.util.Date;
import java.util.Set;
import org.alfresco.service.namespace.QName;
/**
* A <code>UserRegistry</code> 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
*/
public interface UserRegistry
{
/**
* Gets descriptions of all the persons (users) in the user registry or all those changed since a certain date.
*
* @param modifiedSince
* if non-null, then only descriptions of users modified since this date should be returned; if
* <code>null</code> then descriptions of all users should be returned.
* @return a {@link Collection} of {@link NodeDescription}s 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.
*/
public Collection<NodeDescription> getPersons(Date modifiedSince);
/**
* Gets descriptions of all the groups in the user registry or all those changed since a certain date.
*
* @param modifiedSince
* if non-null, then only descriptions of groups modified since this date should be returned; if
* <code>null</code> then descriptions of all groups should be returned.
* @return a {@link Collection} of {@link NodeDescription}s 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.
*/
public Collection<NodeDescription> getGroups(Date modifiedSince);
/**
* 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.
*
* @return the person names
*/
public Collection<String> getPersonNames();
/**
* Gets the names of all groups in the registry. Used to detect local groups to be deleted.
*
* @return the person names
*/
public Collection<String> getGroupNames();
/**
* 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.
*
* @return the person mapped properties
*/
public Set<QName> getPersonMappedProperties();
}