public interface UserManager extends Authenticator, EventListener, Serializable
Modifier and Type | Interface and Description |
---|---|
static class |
UserManager.MatchType |
Modifier and Type | Method and Description |
---|---|
Boolean |
areGroupsReadOnly()
Returns true is users referential is read only (ie : LDAP) -> can not add users -> can not delete users.
|
Boolean |
areUsersReadOnly()
Returns true is groups referential is read only (ie : LDAP) -> can not add groups -> can not delete groups.
|
boolean |
checkUsernamePassword(String username,
String password)
Check the password for the given username.
|
DocumentModel |
createGroup(DocumentModel groupModel)
Creates a group from given model
|
DocumentModel |
createUser(DocumentModel userModel)
Creates user from given model.
|
void |
deleteGroup(DocumentModel groupModel)
Deletes group represented by given model.
|
void |
deleteGroup(String groupId)
Deletes group with given id.
|
void |
deleteUser(DocumentModel userModel)
Deletes user represented by given model.
|
void |
deleteUser(String userId)
Deletes user with given id.
|
List<String> |
getAdministratorsGroups()
Returns the list of administrators groups.
|
String |
getAnonymousUserId()
Gets the anonymous user id.
|
DocumentModel |
getBareGroupModel()
Returns a bare group model.
|
DocumentModel |
getBareUserModel()
Returns a bare user model.
|
String |
getDefaultGroup() |
String |
getDigestAuthDirectory()
Gets the Digest Auth directory.
|
String |
getDigestAuthRealm()
Gets the Digest Auth realm.
|
NuxeoGroup |
getGroup(String groupName)
Returns the nuxeo group with given name or null if it does not exist.
|
String |
getGroupDirectoryName()
Gets the group directory name.
|
String |
getGroupIdField()
Returns the group directory id field.
|
List<String> |
getGroupIds()
Returns the list of all groups ids.
|
String |
getGroupLabelField()
Returns the group label field.
|
String |
getGroupListingMode() |
String |
getGroupMembersField()
Gets the group members field.
|
DocumentModel |
getGroupModel(String groupName)
Return the group document model with this id or null if group does not exist.
|
String |
getGroupParentGroupsField()
Gets the group parent-groups field.
|
String |
getGroupSchemaName()
Returns the group directory schema name.
|
Set<String> |
getGroupSearchFields()
Gets the group search fields.
|
List<String> |
getGroupsInGroup(String parentId)
Returns the list of groups that belong to this group.
|
String |
getGroupSubGroupsField()
Gets the group sub-groups field.
|
NuxeoPrincipal |
getPrincipal(String username)
Retrieves the principal with the given username or null if it does not exist.
|
List<String> |
getTopLevelGroups()
Returns the list of groups that are not members of other groups.
|
String |
getUserDirectoryName()
Gets the user directory name.
|
String |
getUserEmailField()
Gets the user email field.
|
String |
getUserIdField()
Returns the user directory id field.
|
List<String> |
getUserIds()
Returns the list of all user ids.
|
String |
getUserListingMode() |
DocumentModel |
getUserModel(String userName)
Returns the document model representing user with given id or null if it does not exist.
|
Pattern |
getUserPasswordPattern() |
String |
getUserSchemaName()
Returns the user directory schema name.
|
Set<String> |
getUserSearchFields()
Gets the user search fields, the fields to use when a principal search is done.
|
String[] |
getUsersForPermission(String perm,
ACP acp)
For an ACP, get the list of user that has a permission.
|
List<String> |
getUsersInGroup(String groupId)
Returns the list of users that belong to this group.
|
List<String> |
getUsersInGroupAndSubGroups(String groupId)
Get users from a group and its subgroups.
|
String |
getUserSortField() |
DocumentModelList |
searchGroups(Map<String,Serializable> filter,
Set<String> fulltext)
Returns groups matching given criteria.
|
DocumentModelList |
searchGroups(String pattern)
Search matching groups through their defined search fields
|
List<NuxeoPrincipal> |
searchPrincipals(String pattern)
Deprecated.
|
DocumentModelList |
searchUsers(Map<String,Serializable> filter,
Set<String> fulltext)
Returns users matching given criteria.
|
DocumentModelList |
searchUsers(String pattern)
Returns users matching given pattern
|
void |
setConfiguration(UserManagerDescriptor descriptor)
Sets the given configuration on the service.
|
void |
updateGroup(DocumentModel groupModel)
Updates group represented by given model.
|
void |
updateUser(DocumentModel userModel)
Updates user represented by given model.
|
boolean |
validatePassword(String password) |
authenticate
handleEvent
boolean checkUsernamePassword(String username, String password)
Authenticator
checkUsernamePassword
in interface Authenticator
username
- the usernamepassword
- the password to checkboolean validatePassword(String password)
NuxeoPrincipal getPrincipal(String username)
Can build principals for anonymous and virtual users as well as for users defined in the users directory.
NuxeoGroup getGroup(String groupName)
@Deprecated List<NuxeoPrincipal> searchPrincipals(String pattern)
searchUsers(String)
DocumentModelList searchGroups(String pattern)
List<String> getUserIds()
DocumentModel createUser(DocumentModel userModel) throws UserAlreadyExistsException
UserAlreadyExistsException
void updateUser(DocumentModel userModel)
void deleteUser(DocumentModel userModel)
DirectoryException
- if given entry does not existvoid deleteUser(String userId)
DirectoryException
- if given entry does not existDocumentModel getBareUserModel()
Can be used for user creation/search screens.
DocumentModel getUserModel(String userName)
DocumentModelList searchUsers(String pattern)
Pattern is used to fill a filter and fulltext map according to users search fields configuration. Search is performed on each of these fields (OR).
DocumentModelList searchUsers(Map<String,Serializable> filter, Set<String> fulltext)
filter
- filter with field names as keysfulltext
- field names used for fulltext matchString getUserListingMode()
String getUserSortField()
Pattern getUserPasswordPattern()
List<String> getGroupIds()
DocumentModelList searchGroups(Map<String,Serializable> filter, Set<String> fulltext)
filter
- filter with field names as keysfulltext
- field names used for fulltext matchDocumentModel createGroup(DocumentModel groupModel) throws GroupAlreadyExistsException
GroupAlreadyExistsException
void updateGroup(DocumentModel groupModel)
DirectoryException
- if given entry does not existvoid deleteGroup(DocumentModel groupModel)
DirectoryException
- if given entry does not existvoid deleteGroup(String groupId)
DirectoryException
- if given entry does not existDocumentModel getBareGroupModel()
Can be used for group creation/search screens.
DocumentModel getGroupModel(String groupName)
groupName
- the group identifierString getDefaultGroup()
String getGroupListingMode()
List<String> getGroupsInGroup(String parentId)
parentId
- the name of the parent group.List<String> getTopLevelGroups()
List<String> getUsersInGroup(String groupId)
groupId
- ID of the groupList<String> getUsersInGroupAndSubGroups(String groupId)
groupId
- ID of the groupBoolean areGroupsReadOnly()
Boolean areUsersReadOnly()
String getUserDirectoryName()
String getUserSchemaName()
String getUserIdField()
String getUserEmailField()
Set<String> getUserSearchFields()
Set<String> getGroupSearchFields()
String getGroupDirectoryName()
String getGroupSchemaName()
String getGroupIdField()
String getGroupLabelField()
String getGroupMembersField()
String getGroupSubGroupsField()
String getGroupParentGroupsField()
String getAnonymousUserId()
String getDigestAuthDirectory()
String getDigestAuthRealm()
void setConfiguration(UserManagerDescriptor descriptor)
descriptor
- the descriptor as parsed from xml, merged from the previous one if it exists.List<String> getAdministratorsGroups()
String[] getUsersForPermission(String perm, ACP acp)
perm
- the permissionacp
- The access control policy of the documentCopyright © 2017 Nuxeo. All rights reserved.