Package africa.absa.inception.security

Class LDAPUserDirectory

java.lang.Object

africa.absa.inception.security.UserDirectoryBase

africa.absa.inception.security.LDAPUserDirectory

public class LDAPUserDirectory
extends UserDirectoryBase

The LDAPUserDirectory class provides the LDAP user directory implementation.

Author:

Marcus Portmann

Constructor Summary

Constructors

Constructor	Description
LDAPUserDirectory(UUID userDirectoryId, List<UserDirectoryParameter> parameters, GroupRepository groupRepository, UserRepository userRepository, RoleRepository roleRepository)	Constructs a new LDAPUserDirectory.

Method Summary

Modifier and Type	Method	Description
void	addMemberToGroup(String groupName, GroupMemberType memberType, String memberName)
void	addRoleToGroup(String groupName, String roleCode)
void	addUserToGroup(String groupName, String username)
void	adminChangePassword(String username, String newPassword, boolean expirePassword, boolean lockUser, boolean resetPasswordHistory, PasswordChangeReason reason)
void	authenticate(String username, String password)
void	changePassword(String username, String password, String newPassword)
void	createGroup(Group group)
void	createUser(User user, boolean expiredPassword, boolean userLocked)
void	deleteGroup(String groupName)
void	deleteUser(String username)
List<User>	findUsers(List<UserAttribute> userAttributes)
UserDirectoryCapabilities	getCapabilities()
List<String>	getFunctionCodesForUser(String username)
Group	getGroup(String groupName)
List<String>	getGroupNames()
List<String>	getGroupNamesForUser(String username)
List<Group>	getGroups()
Groups	getGroups(String filter, africa.absa.inception.core.sorting.SortDirection sortDirection, Integer pageIndex, Integer pageSize)
List<Group>	getGroupsForUser(String username)
List<GroupMember>	getMembersForGroup(String groupName)
GroupMembers	getMembersForGroup(String groupName, String filter, africa.absa.inception.core.sorting.SortDirection sortDirection, Integer pageIndex, Integer pageSize)
List<String>	getRoleCodesForGroup(String groupName)
List<String>	getRoleCodesForUser(String username)
List<GroupRole>	getRolesForGroup(String groupName)
User	getUser(String username)
String	getUserName(String username)
List<User>	getUsers()
Users	getUsers(String filter, UserSortBy sortBy, africa.absa.inception.core.sorting.SortDirection sortDirection, Integer pageIndex, Integer pageSize)
boolean	isExistingUser(String username)
boolean	isUserInGroup(String groupName, String username)
void	removeMemberFromGroup(String groupName, GroupMemberType memberType, String memberName)
void	removeRoleFromGroup(String groupName, String roleCode)
void	removeUserFromGroup(String groupName, String username)
void	resetPassword(String username, String newPassword)
void	updateGroup(Group group)
void	updateUser(User user, boolean expirePassword, boolean lockUser)

Methods inherited from class africa.absa.inception.security.UserDirectoryBase

getGroupRepository, getParameters, getRoleRepository, getUserDirectoryId, getUserRepository, isNullOrEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LDAPUserDirectory

public LDAPUserDirectory(UUID userDirectoryId,
                         List<UserDirectoryParameter> parameters,
                         GroupRepository groupRepository,
                         UserRepository userRepository,
                         RoleRepository roleRepository)
                  throws africa.absa.inception.core.service.ServiceUnavailableException

Constructs a new LDAPUserDirectory.

Parameters:

userDirectoryId - the Universally Unique Identifier (UUID) for the user directory

parameters - the parameters for the user directory

groupRepository - the Group Repository

userRepository - the User Repository

roleRepository - the Role Repository

Throws:

africa.absa.inception.core.service.ServiceUnavailableException - if the LDAP user directory could not be initialized

Method Detail

addMemberToGroup

public void addMemberToGroup(String groupName,
                             GroupMemberType memberType,
                             String memberName)
                      throws GroupNotFoundException,
                             UserNotFoundException,
                             africa.absa.inception.core.service.ServiceUnavailableException

Throws:

GroupNotFoundException

UserNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

addRoleToGroup

public void addRoleToGroup(String groupName,
                           String roleCode)
                    throws GroupNotFoundException,
                           RoleNotFoundException,
                           africa.absa.inception.core.service.ServiceUnavailableException

Throws:

GroupNotFoundException

RoleNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

addUserToGroup

public void addUserToGroup(String groupName,
                           String username)
                    throws UserNotFoundException,
                           GroupNotFoundException,
                           africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

GroupNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

adminChangePassword

public void adminChangePassword(String username,
                                String newPassword,
                                boolean expirePassword,
                                boolean lockUser,
                                boolean resetPasswordHistory,
                                PasswordChangeReason reason)
                         throws UserNotFoundException,
                                africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

authenticate

public void authenticate(String username,
                         String password)
                  throws AuthenticationFailedException,
                         UserLockedException,
                         ExpiredPasswordException,
                         UserNotFoundException,
                         africa.absa.inception.core.service.ServiceUnavailableException

Throws:

AuthenticationFailedException

UserLockedException

ExpiredPasswordException

UserNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

changePassword

public void changePassword(String username,
                           String password,
                           String newPassword)
                    throws AuthenticationFailedException,
                           UserLockedException,
                           ExistingPasswordException,
                           africa.absa.inception.core.service.ServiceUnavailableException

Throws:

AuthenticationFailedException

UserLockedException

ExistingPasswordException

africa.absa.inception.core.service.ServiceUnavailableException

createGroup

public void createGroup(Group group)
                 throws DuplicateGroupException,
                        africa.absa.inception.core.service.ServiceUnavailableException

Throws:

DuplicateGroupException

africa.absa.inception.core.service.ServiceUnavailableException

createUser

public void createUser(User user,
                       boolean expiredPassword,
                       boolean userLocked)
                throws DuplicateUserException,
                       africa.absa.inception.core.service.ServiceUnavailableException

Throws:

DuplicateUserException

africa.absa.inception.core.service.ServiceUnavailableException

deleteGroup

public void deleteGroup(String groupName)
                 throws GroupNotFoundException,
                        ExistingGroupMembersException,
                        africa.absa.inception.core.service.ServiceUnavailableException

Throws:

GroupNotFoundException

ExistingGroupMembersException

africa.absa.inception.core.service.ServiceUnavailableException

deleteUser

public void deleteUser(String username)
                throws UserNotFoundException,
                       africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

findUsers

public List<User> findUsers(List<UserAttribute> userAttributes)
                     throws InvalidAttributeException,
                            africa.absa.inception.core.service.ServiceUnavailableException

Throws:

InvalidAttributeException

africa.absa.inception.core.service.ServiceUnavailableException

getCapabilities

public UserDirectoryCapabilities getCapabilities()

getFunctionCodesForUser

public List<String> getFunctionCodesForUser(String username)
                                     throws UserNotFoundException,
                                            africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

getGroup

public Group getGroup(String groupName)
               throws GroupNotFoundException,
                      africa.absa.inception.core.service.ServiceUnavailableException

Throws:

GroupNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

getGroupNames

public List<String> getGroupNames()
                           throws africa.absa.inception.core.service.ServiceUnavailableException

Throws:

africa.absa.inception.core.service.ServiceUnavailableException

getGroupNamesForUser

public List<String> getGroupNamesForUser(String username)
                                  throws UserNotFoundException,
                                         africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

getGroups

public List<Group> getGroups()
                      throws africa.absa.inception.core.service.ServiceUnavailableException

Throws:

africa.absa.inception.core.service.ServiceUnavailableException

getGroups

public Groups getGroups(String filter,
                        africa.absa.inception.core.sorting.SortDirection sortDirection,
                        Integer pageIndex,
                        Integer pageSize)
                 throws africa.absa.inception.core.service.ServiceUnavailableException

Throws:

africa.absa.inception.core.service.ServiceUnavailableException

getGroupsForUser

public List<Group> getGroupsForUser(String username)
                             throws UserNotFoundException,
                                    africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

getMembersForGroup

public List<GroupMember> getMembersForGroup(String groupName)
                                     throws GroupNotFoundException,
                                            africa.absa.inception.core.service.ServiceUnavailableException

Throws:

GroupNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

getMembersForGroup

public GroupMembers getMembersForGroup(String groupName,
                                       String filter,
                                       africa.absa.inception.core.sorting.SortDirection sortDirection,
                                       Integer pageIndex,
                                       Integer pageSize)
                                throws GroupNotFoundException,
                                       africa.absa.inception.core.service.ServiceUnavailableException

Throws:

GroupNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

getRoleCodesForGroup

public List<String> getRoleCodesForGroup(String groupName)
                                  throws GroupNotFoundException,
                                         africa.absa.inception.core.service.ServiceUnavailableException

Throws:

GroupNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

getRoleCodesForUser

public List<String> getRoleCodesForUser(String username)
                                 throws UserNotFoundException,
                                        africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

getRolesForGroup

public List<GroupRole> getRolesForGroup(String groupName)
                                 throws GroupNotFoundException,
                                        africa.absa.inception.core.service.ServiceUnavailableException

Throws:

GroupNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

getUser

public User getUser(String username)
             throws UserNotFoundException,
                    africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

getUserName

public String getUserName(String username)
                   throws UserNotFoundException,
                          africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

getUsers

public List<User> getUsers()
                    throws africa.absa.inception.core.service.ServiceUnavailableException

Throws:

africa.absa.inception.core.service.ServiceUnavailableException

getUsers

public Users getUsers(String filter,
                      UserSortBy sortBy,
                      africa.absa.inception.core.sorting.SortDirection sortDirection,
                      Integer pageIndex,
                      Integer pageSize)
               throws africa.absa.inception.core.service.ServiceUnavailableException

Throws:

africa.absa.inception.core.service.ServiceUnavailableException

isExistingUser

public boolean isExistingUser(String username)
                       throws africa.absa.inception.core.service.ServiceUnavailableException

Throws:

africa.absa.inception.core.service.ServiceUnavailableException

isUserInGroup

public boolean isUserInGroup(String groupName,
                             String username)
                      throws UserNotFoundException,
                             GroupNotFoundException,
                             africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

GroupNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

removeMemberFromGroup

public void removeMemberFromGroup(String groupName,
                                  GroupMemberType memberType,
                                  String memberName)
                           throws GroupNotFoundException,
                                  GroupMemberNotFoundException,
                                  africa.absa.inception.core.service.ServiceUnavailableException

Throws:

GroupNotFoundException

GroupMemberNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

removeRoleFromGroup

public void removeRoleFromGroup(String groupName,
                                String roleCode)
                         throws GroupNotFoundException,
                                GroupRoleNotFoundException,
                                africa.absa.inception.core.service.ServiceUnavailableException

Throws:

GroupNotFoundException

GroupRoleNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

removeUserFromGroup

public void removeUserFromGroup(String groupName,
                                String username)
                         throws UserNotFoundException,
                                GroupNotFoundException,
                                africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

GroupNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

resetPassword

public void resetPassword(String username,
                          String newPassword)
                   throws UserNotFoundException,
                          UserLockedException,
                          ExistingPasswordException,
                          africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

UserLockedException

ExistingPasswordException

africa.absa.inception.core.service.ServiceUnavailableException

updateGroup

public void updateGroup(Group group)
                 throws GroupNotFoundException,
                        africa.absa.inception.core.service.ServiceUnavailableException

Throws:

GroupNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException

updateUser

public void updateUser(User user,
                       boolean expirePassword,
                       boolean lockUser)
                throws UserNotFoundException,
                       africa.absa.inception.core.service.ServiceUnavailableException

Throws:

UserNotFoundException

africa.absa.inception.core.service.ServiceUnavailableException