Nuxeo ECM Projects 5.4.3-SNAPSHOT

org.nuxeo.ecm.platform.usermanager
Class FakeUserManagerImpl

java.lang.Object
  extended by org.nuxeo.ecm.platform.usermanager.FakeUserManagerImpl
All Implemented Interfaces:
Serializable, UserManager, Authenticator

public class FakeUserManagerImpl
extends Object
implements UserManager

Author:
Florent Guillaume
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.nuxeo.ecm.platform.usermanager.UserManager
UserManager.MatchType
 
Constructor Summary
FakeUserManagerImpl()
           
 
Method Summary
 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.
 Principal authenticate(String name, String password)
          Get a principal object for the given username if the username / password pair is valid, otherwise returns null.
 boolean checkUsernamePassword(String username, String password)
          Check the password for the given username.
 DocumentModel createGroup(DocumentModel groupModel)
          Creates a group from given model
 void createGroup(NuxeoGroup group)
           
 void createPrincipal(NuxeoPrincipal principal)
           
 DocumentModel createUser(DocumentModel userModel)
          Creates user from given model.
 void deleteGroup(DocumentModel groupModel)
          Deletes group represented by given model.
 void deleteGroup(NuxeoGroup group)
           
 void deleteGroup(String groupId)
          Deletes group with given id.
 void deletePrincipal(NuxeoPrincipal principal)
           
 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.
 List<NuxeoGroup> getAvailableGroups()
           
 List<NuxeoPrincipal> getAvailablePrincipals()
           
 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.
 DocumentModel getModelForUser(String name)
           
 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()
           
 List<NuxeoPrincipal> searchByMap(Map<String,Serializable> filter, Set<String> pattern)
           
 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)
           
 DocumentModelList searchUsers(Map<String,Serializable> filter, Set<String> fulltext)
          Returns users matching given criteria.
 DocumentModelList searchUsers(String pattern)
          Returns users matching given pattern
 void setAnonymousUser(VirtualUser anonymousUser)
           
 void setConfiguration(UserManagerDescriptor descriptor)
          Sets the given configuration on the service.
 void setDefaultGroup(String defaultGroup)
           
 void setGroupDirectoryName(String groupDirectoryName)
           
 void setGroupListingMode(String groupListingMode)
           
 void setGroupMembersField(String groupMembersField)
           
 void setGroupParentGroupsField(String groupParentGroupsField)
           
 void setGroupSortField(String sortField)
           
 void setGroupSubGroupsField(String groupSubGroupsField)
           
 void setUserDirectoryName(String userDirectoryName)
           
 void setUserEmailField(String userEmailField)
           
 void setUserListingMode(String userListingMode)
           
 void setUserPasswordPattern(Pattern userPasswordPattern)
           
 void setUserSearchFields(Map<String,UserManager.MatchType> userSearchFields)
           
 void setUserSearchFields(Set<String> userSearchFields)
           
 void setUserSortField(String sortField)
           
 void setVirtualUsers(Map<String,VirtualUserDescriptor> virtualUsers)
           
 void updateGroup(DocumentModel groupModel)
          Updates group represented by given model.
 void updateGroup(NuxeoGroup group)
           
 void updatePrincipal(NuxeoPrincipal principal)
           
 void updateUser(DocumentModel userModel)
          Updates user represented by given model.
 boolean validatePassword(String password)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FakeUserManagerImpl

public FakeUserManagerImpl()
Method Detail

getUserListingMode

public String getUserListingMode()
Specified by:
getUserListingMode in interface UserManager

setUserListingMode

public void setUserListingMode(String userListingMode)

getGroupListingMode

public String getGroupListingMode()
Specified by:
getGroupListingMode in interface UserManager

setGroupListingMode

public void setGroupListingMode(String groupListingMode)

getDefaultGroup

public String getDefaultGroup()
Specified by:
getDefaultGroup in interface UserManager

setDefaultGroup

public void setDefaultGroup(String defaultGroup)

getUserSortField

public String getUserSortField()
Specified by:
getUserSortField in interface UserManager

setUserSortField

public void setUserSortField(String sortField)

setGroupSortField

public void setGroupSortField(String sortField)

setUserDirectoryName

public void setUserDirectoryName(String userDirectoryName)

getUserDirectoryName

public String getUserDirectoryName()
Description copied from interface: UserManager
Gets the user directory name.

Specified by:
getUserDirectoryName in interface UserManager
Returns:
the user directory name.

setUserEmailField

public void setUserEmailField(String userEmailField)

getUserEmailField

public String getUserEmailField()
Description copied from interface: UserManager
Gets the user email field.

Specified by:
getUserEmailField in interface UserManager
Returns:
the user email field.

setUserSearchFields

public void setUserSearchFields(Set<String> userSearchFields)

setUserSearchFields

public void setUserSearchFields(Map<String,UserManager.MatchType> userSearchFields)

getUserSearchFields

public Set<String> getUserSearchFields()
Description copied from interface: UserManager
Gets the user search fields, the fields to use when a principal search is done.

Specified by:
getUserSearchFields in interface UserManager
Returns:
the search fields.

getGroupSearchFields

public Set<String> getGroupSearchFields()
Description copied from interface: UserManager
Gets the group search fields.

Specified by:
getGroupSearchFields in interface UserManager

setGroupDirectoryName

public void setGroupDirectoryName(String groupDirectoryName)

getGroupDirectoryName

public String getGroupDirectoryName()
Description copied from interface: UserManager
Gets the group directory name.

Specified by:
getGroupDirectoryName in interface UserManager
Returns:
the group directory name.

setGroupMembersField

public void setGroupMembersField(String groupMembersField)

getGroupMembersField

public String getGroupMembersField()
Description copied from interface: UserManager
Gets the group members field.

Specified by:
getGroupMembersField in interface UserManager
Returns:
the group members field.

setGroupSubGroupsField

public void setGroupSubGroupsField(String groupSubGroupsField)

getGroupSubGroupsField

public String getGroupSubGroupsField()
Description copied from interface: UserManager
Gets the group sub-groups field.

Specified by:
getGroupSubGroupsField in interface UserManager
Returns:
the sub-groups field.

setGroupParentGroupsField

public void setGroupParentGroupsField(String groupParentGroupsField)

getGroupParentGroupsField

public String getGroupParentGroupsField()
Description copied from interface: UserManager
Gets the group parent-groups field.

Specified by:
getGroupParentGroupsField in interface UserManager
Returns:
the parent-groups field.

areGroupsReadOnly

public Boolean areGroupsReadOnly()
                          throws ClientException
Description copied from interface: UserManager
Returns true is users referential is read only (ie : LDAP) -> can not add users -> can not delete users.

Specified by:
areGroupsReadOnly in interface UserManager
Throws:
ClientException

areUsersReadOnly

public Boolean areUsersReadOnly()
                         throws ClientException
Description copied from interface: UserManager
Returns true is groups referential is read only (ie : LDAP) -> can not add groups -> can not delete groups.

Specified by:
areUsersReadOnly in interface UserManager
Throws:
ClientException

checkUsernamePassword

public boolean checkUsernamePassword(String username,
                                     String password)
                              throws ClientException
Description copied from interface: Authenticator
Check the password for the given username. Returns true if the username / password pair match, false otherwise.

Specified by:
checkUsernamePassword in interface UserManager
Specified by:
checkUsernamePassword in interface Authenticator
Parameters:
username - the username
password - the password to check
Returns:
true is valid, false otherwise
Throws:
ClientException

validatePassword

public boolean validatePassword(String password)
Specified by:
validatePassword in interface UserManager

getGroupsInGroup

public List<String> getGroupsInGroup(String parentId)
                              throws ClientException
Description copied from interface: UserManager
Returns the list of groups that belong to this group.

Specified by:
getGroupsInGroup in interface UserManager
Parameters:
parentId - the name of the parent group.
Returns:
Throws:
ClientException

getPrincipal

public NuxeoPrincipal getPrincipal(String username)
                            throws ClientException
Description copied from interface: UserManager
Retrieves the principal with the given username or null if it does not exist.

Can build principals for anonymous and virtual users as well as for users defined in the users directory.

Specified by:
getPrincipal in interface UserManager
Throws:
ClientException

getTopLevelGroups

public List<String> getTopLevelGroups()
                               throws ClientException
Description copied from interface: UserManager
Returns the list of groups that are not members of other groups.

Specified by:
getTopLevelGroups in interface UserManager
Returns:
Throws:
ClientException

getUsersInGroup

public List<String> getUsersInGroup(String groupId)
                             throws ClientException
Description copied from interface: UserManager
Returns the list of users that belong to this group.

Specified by:
getUsersInGroup in interface UserManager
Parameters:
groupId - ID of the group
Returns:
Throws:
ClientException

getUsersInGroupAndSubGroups

public List<String> getUsersInGroupAndSubGroups(String groupId)
                                         throws ClientException
Description copied from interface: UserManager
Get users from a group and its subgroups.

Specified by:
getUsersInGroupAndSubGroups in interface UserManager
Parameters:
groupId - ID of the group
Returns:
Throws:
ClientException

searchGroups

public DocumentModelList searchGroups(String pattern)
                               throws ClientException
Description copied from interface: UserManager
Search matching groups through their defined search fields

Specified by:
searchGroups in interface UserManager
Throws:
ClientException

searchPrincipals

public List<NuxeoPrincipal> searchPrincipals(String pattern)
                                      throws ClientException
Specified by:
searchPrincipals in interface UserManager
Throws:
ClientException

getUserPasswordPattern

public Pattern getUserPasswordPattern()
Specified by:
getUserPasswordPattern in interface UserManager

setUserPasswordPattern

public void setUserPasswordPattern(Pattern userPasswordPattern)

setAnonymousUser

public void setAnonymousUser(VirtualUser anonymousUser)

setVirtualUsers

public void setVirtualUsers(Map<String,VirtualUserDescriptor> virtualUsers)

getAnonymousUserId

public String getAnonymousUserId()
Description copied from interface: UserManager
Gets the anonymous user id.

Specified by:
getAnonymousUserId in interface UserManager
Returns:
the anonymous user id, or the default one if none is defined.

getDigestAuthDirectory

public String getDigestAuthDirectory()
Description copied from interface: UserManager
Gets the Digest Auth directory.

Specified by:
getDigestAuthDirectory in interface UserManager

getDigestAuthRealm

public String getDigestAuthRealm()
Description copied from interface: UserManager
Gets the Digest Auth realm.

Specified by:
getDigestAuthRealm in interface UserManager

setConfiguration

public void setConfiguration(UserManagerDescriptor descriptor)
Description copied from interface: UserManager
Sets the given configuration on the service.

Specified by:
setConfiguration in interface UserManager
Parameters:
descriptor - the descriptor as parsed from xml, merged from the previous one if it exists.

getBareUserModel

public DocumentModel getBareUserModel()
                               throws ClientException
Description copied from interface: UserManager
Returns a bare user model.

Can be used for user creation/search screens.

Specified by:
getBareUserModel in interface UserManager
Throws:
ClientException

createGroup

public DocumentModel createGroup(DocumentModel groupModel)
                          throws ClientException
Description copied from interface: UserManager
Creates a group from given model

Specified by:
createGroup in interface UserManager
Returns:
the created group model
Throws:
ClientException
GroupAlreadyExistsException

createUser

public DocumentModel createUser(DocumentModel userModel)
                         throws ClientException
Description copied from interface: UserManager
Creates user from given model.

Specified by:
createUser in interface UserManager
Throws:
ClientException
UserAlreadyExistsException

deleteGroup

public void deleteGroup(DocumentModel groupModel)
                 throws ClientException
Description copied from interface: UserManager
Deletes group represented by given model.

Specified by:
deleteGroup in interface UserManager
Throws:
DirectoryException - if given entry does not exist
ClientException

deleteGroup

public void deleteGroup(String groupId)
                 throws ClientException
Description copied from interface: UserManager
Deletes group with given id.

Specified by:
deleteGroup in interface UserManager
Throws:
DirectoryException - if given entry does not exist
ClientException

deleteUser

public void deleteUser(DocumentModel userModel)
                throws ClientException
Description copied from interface: UserManager
Deletes user represented by given model.

Specified by:
deleteUser in interface UserManager
Throws:
DirectoryException - if given entry does not exist
ClientException

deleteUser

public void deleteUser(String userId)
                throws ClientException
Description copied from interface: UserManager
Deletes user with given id.

Specified by:
deleteUser in interface UserManager
Throws:
DirectoryException - if given entry does not exist
ClientException

getBareGroupModel

public DocumentModel getBareGroupModel()
                                throws ClientException
Description copied from interface: UserManager
Returns a bare group model.

Can be used for group creation/search screens.

Specified by:
getBareGroupModel in interface UserManager
Throws:
ClientException

getGroup

public NuxeoGroup getGroup(String groupName)
                    throws ClientException
Description copied from interface: UserManager
Returns the nuxeo group with given name or null if it does not exist.

Specified by:
getGroup in interface UserManager
Throws:
ClientException

getGroupIds

public List<String> getGroupIds()
                         throws ClientException
Description copied from interface: UserManager
Returns the list of all groups ids.

Specified by:
getGroupIds in interface UserManager
Throws:
ClientException

getUserIds

public List<String> getUserIds()
                        throws ClientException
Description copied from interface: UserManager
Returns the list of all user ids.

Specified by:
getUserIds in interface UserManager
Throws:
ClientException

searchGroups

public DocumentModelList searchGroups(Map<String,Serializable> filter,
                                      Set<String> fulltext)
                               throws ClientException
Description copied from interface: UserManager
Returns groups matching given criteria.

Specified by:
searchGroups in interface UserManager
Parameters:
filter - filter with field names as keys
fulltext - field names used for fulltext match
Throws:
ClientException

searchUsers

public DocumentModelList searchUsers(Map<String,Serializable> filter,
                                     Set<String> fulltext)
                              throws ClientException
Description copied from interface: UserManager
Returns users matching given criteria.

Specified by:
searchUsers in interface UserManager
Parameters:
filter - filter with field names as keys
fulltext - field names used for fulltext match
Throws:
ClientException

searchUsers

public DocumentModelList searchUsers(String pattern)
                              throws ClientException
Description copied from interface: UserManager
Returns users matching given 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).

Specified by:
searchUsers in interface UserManager
Throws:
ClientException

updateGroup

public void updateGroup(DocumentModel groupModel)
                 throws ClientException
Description copied from interface: UserManager
Updates group represented by given model.

Specified by:
updateGroup in interface UserManager
Throws:
DirectoryException - if given entry does not exist
ClientException

updateUser

public void updateUser(DocumentModel userModel)
                throws ClientException
Description copied from interface: UserManager
Updates user represented by given model.

Specified by:
updateUser in interface UserManager
Throws:
ClientException

getGroupModel

public DocumentModel getGroupModel(String groupName)
                            throws ClientException
Description copied from interface: UserManager
Return the group document model with this id or null if group does not exist.

Specified by:
getGroupModel in interface UserManager
Parameters:
groupName - the group identifier
Throws:
ClientException

getUserModel

public DocumentModel getUserModel(String userName)
                           throws ClientException
Description copied from interface: UserManager
Returns the document model representing user with given id or null if it does not exist.

Specified by:
getUserModel in interface UserManager
Throws:
ClientException

getGroupIdField

public String getGroupIdField()
                       throws ClientException
Description copied from interface: UserManager
Returns the group directory id field.

Specified by:
getGroupIdField in interface UserManager
Throws:
ClientException

getGroupLabelField

public String getGroupLabelField()
                          throws ClientException
Description copied from interface: UserManager
Returns the group label field.

Specified by:
getGroupLabelField in interface UserManager
Throws:
ClientException

getGroupSchemaName

public String getGroupSchemaName()
                          throws ClientException
Description copied from interface: UserManager
Returns the group directory schema name.

Specified by:
getGroupSchemaName in interface UserManager
Throws:
ClientException

getUserIdField

public String getUserIdField()
                      throws ClientException
Description copied from interface: UserManager
Returns the user directory id field.

Specified by:
getUserIdField in interface UserManager
Throws:
ClientException

getUserSchemaName

public String getUserSchemaName()
                         throws ClientException
Description copied from interface: UserManager
Returns the user directory schema name.

Specified by:
getUserSchemaName in interface UserManager
Throws:
ClientException

createGroup

public void createGroup(NuxeoGroup group)
                 throws ClientException
Specified by:
createGroup in interface UserManager
Throws:
ClientException

createPrincipal

public void createPrincipal(NuxeoPrincipal principal)
                     throws ClientException
Specified by:
createPrincipal in interface UserManager
Throws:
ClientException

deleteGroup

public void deleteGroup(NuxeoGroup group)
                 throws ClientException
Specified by:
deleteGroup in interface UserManager
Throws:
ClientException

deletePrincipal

public void deletePrincipal(NuxeoPrincipal principal)
                     throws ClientException
Specified by:
deletePrincipal in interface UserManager
Throws:
ClientException

getAvailableGroups

public List<NuxeoGroup> getAvailableGroups()
                                    throws ClientException
Specified by:
getAvailableGroups in interface UserManager
Throws:
ClientException

getAvailablePrincipals

public List<NuxeoPrincipal> getAvailablePrincipals()
                                            throws ClientException
Specified by:
getAvailablePrincipals in interface UserManager
Throws:
ClientException

getModelForUser

public DocumentModel getModelForUser(String name)
                              throws ClientException
Specified by:
getModelForUser in interface UserManager
Throws:
ClientException

searchByMap

public List<NuxeoPrincipal> searchByMap(Map<String,Serializable> filter,
                                        Set<String> pattern)
                                 throws ClientException
Specified by:
searchByMap in interface UserManager
Throws:
ClientException

updateGroup

public void updateGroup(NuxeoGroup group)
                 throws ClientException
Specified by:
updateGroup in interface UserManager
Throws:
ClientException

updatePrincipal

public void updatePrincipal(NuxeoPrincipal principal)
                     throws ClientException
Specified by:
updatePrincipal in interface UserManager
Throws:
ClientException

getAdministratorsGroups

public List<String> getAdministratorsGroups()
Description copied from interface: UserManager
Returns the list of administrators groups.

Specified by:
getAdministratorsGroups in interface UserManager

getUsersForPermission

public String[] getUsersForPermission(String perm,
                                      ACP acp)
Description copied from interface: UserManager
For an ACP, get the list of user that has a permission. This method should be use with care as it can cause performance issues while getting the list of users.

Specified by:
getUsersForPermission in interface UserManager
Parameters:
perm - the permission
acp - The access control policy of the document
Returns:
the list of user ids

authenticate

public Principal authenticate(String name,
                              String password)
                       throws ClientException
Description copied from interface: Authenticator
Get a principal object for the given username if the username / password pair is valid, otherwise returns null.

This method is doing the authentication of the given username / password pair and returns the corresponding principal object if authentication succeeded otherwise returns null.

Specified by:
authenticate in interface Authenticator
Returns:
the authenticated principal if authentication succeded otherwise null
Throws:
ClientException

Nuxeo ECM Projects 5.4.3-SNAPSHOT

Copyright © 2011 Nuxeo SAS. All Rights Reserved.