Package org.duracloud.account.db.util.impl

Class DuracloudUserServiceImpl

java.lang.Object

org.duracloud.account.db.util.impl.DuracloudUserServiceImpl

All Implemented Interfaces:

DuracloudUserService, org.springframework.security.core.userdetails.UserDetailsService

@Component("duracloudUserService")
public class DuracloudUserServiceImpl
extends Object
implements DuracloudUserService, org.springframework.security.core.userdetails.UserDetailsService

Author:

Andrew Woods Date: Oct 9, 2010

Constructor Summary

Constructors

Constructor	Description
DuracloudUserServiceImpl(org.duracloud.account.db.repo.DuracloudRepoMgr duracloudRepoMgr, NotificationMgr notificationMgr, AmaEndpoint amaEndpoint, org.duracloud.common.changenotifier.AccountChangeNotifier accountChangeNotifier, EmailTemplateService emailTemplateService)

Method Summary

Modifier and Type	Method	Description
boolean	addUserToAccount(Long acctId, Long userId)	This method sets the roles of a user in an account.
void	changePassword(Long userId, String oldPassword, boolean oldPasswordEncoded, String newPassword)	This method changes the password of the user with the arg userId from the oldPassword to the newPassword.
void	changePasswordInternal(Long userId, String oldPassword, boolean oldPasswordEncoded, String newPassword)
void	checkUsername(String username)	This method throws an exception is the username is non-unique or it is not a valid username.
org.duracloud.account.db.model.DuracloudUser	createNewUser(String username, String password, String firstName, String lastName, String email, String securityQuestion, String securityAnswer)	This method creates and persists a new user.
void	forgotPassword(String username, String securityQuestion, String securityAnswer)	This method generates a random password, replaces the existing password with the randomly generated one, and sends an email to the address on file for the given username.
org.duracloud.account.db.model.DuracloudUser	loadDuracloudUserByIdInternal(Long userId)
org.duracloud.account.db.model.DuracloudUser	loadDuracloudUserByUsername(String username)	This method loads a DuracloudUser from the persistence layer and populate its rights info.
org.duracloud.account.db.model.DuracloudUser	loadDuracloudUserByUsernameInternal(String username)
org.springframework.security.core.userdetails.UserDetails	loadUserByUsername(String username)
Long	redeemAccountInvitation(Long userId, String redemptionCode)	This method redeems an invitation to add this user to a DuraCloud account.
void	redeemPasswordChangeRequest(Long userId, String redemptionCode)
org.duracloud.account.db.model.UserInvitation	retrievePassordChangeInvitation(String redemptionCode)	Returns a user password change invitation
void	revokeUserRights(Long acctId, Long userId)	This method removes all rights to an account for a given user.
boolean	setUserRights(Long acctId, Long userId, org.duracloud.account.db.model.Role... roles)	This method sets the roles of a user in an account.
void	storeUserDetails(Long userId, String firstName, String lastName, String email, String securityQuestion, String securityAnswer, String allowableIPAddressRange)	This method persists the arg user details.

Methods inherited from class java.lang.Object

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

Constructor Detail

DuracloudUserServiceImpl

@Autowired
public DuracloudUserServiceImpl(org.duracloud.account.db.repo.DuracloudRepoMgr duracloudRepoMgr,
                                NotificationMgr notificationMgr,
                                AmaEndpoint amaEndpoint,
                                org.duracloud.common.changenotifier.AccountChangeNotifier accountChangeNotifier,
                                EmailTemplateService emailTemplateService)

Method Detail

checkUsername

public void checkUsername(String username)
                   throws InvalidUsernameException,
                          UserAlreadyExistsException

Description copied from interface: DuracloudUserService

This method throws an exception is the username is non-unique or it is not a valid username.

Specified by:

checkUsername in interface DuracloudUserService

Parameters:

username - sought

Throws:

InvalidUsernameException

UserAlreadyExistsException

createNewUser

public org.duracloud.account.db.model.DuracloudUser createNewUser(String username,
                                                                  String password,
                                                                  String firstName,
                                                                  String lastName,
                                                                  String email,
                                                                  String securityQuestion,
                                                                  String securityAnswer)
                                                           throws UserAlreadyExistsException,
                                                                  InvalidUsernameException

Description copied from interface: DuracloudUserService

This method creates and persists a new user.

Specified by:

createNewUser in interface DuracloudUserService

Parameters:

username - of new user

password - of new user

firstName - of new user

lastName - of new user

email - of new user

securityQuestion - of new user

securityAnswer - of new user

Returns:

DuracloudUser

Throws:

UserAlreadyExistsException

InvalidUsernameException

setUserRights

public boolean setUserRights(Long acctId,
                             Long userId,
                             org.duracloud.account.db.model.Role... roles)

Description copied from interface: DuracloudUserService

This method sets the roles of a user in an account.

Note that this method only sets a user to new roles. To remove a user from an account, use revokeAllRights().

Specified by:

setUserRights in interface DuracloudUserService

Returns:

true if an update was performed.

revokeUserRights

public void revokeUserRights(Long acctId,
                             Long userId)

Description copied from interface: DuracloudUserService

This method removes all rights to an account for a given user.

Specified by:

revokeUserRights in interface DuracloudUserService

Parameters:

acctId - on which rights will be revoked

userId - of user whose rights will be revoked

changePassword

public void changePassword(Long userId,
                           String oldPassword,
                           boolean oldPasswordEncoded,
                           String newPassword)
                    throws DBNotFoundException,
                           InvalidPasswordException

Description copied from interface: DuracloudUserService

This method changes the password of the user with the arg userId from the oldPassword to the newPassword.

Specified by:

changePassword in interface DuracloudUserService

Parameters:

userId - of user who is seeking a password change

oldPasswordEncoded - flag noting if the password is hashed

Throws:

InvalidPasswordException

DBNotFoundException

changePasswordInternal

public void changePasswordInternal(Long userId,
                                   String oldPassword,
                                   boolean oldPasswordEncoded,
                                   String newPassword)
                            throws DBNotFoundException,
                                   InvalidPasswordException

Specified by:

changePasswordInternal in interface DuracloudUserService

Throws:

InvalidPasswordException

DBNotFoundException

redeemPasswordChangeRequest

public void redeemPasswordChangeRequest(Long userId,
                                        String redemptionCode)
                                 throws InvalidRedemptionCodeException

Specified by:

redeemPasswordChangeRequest in interface DuracloudUserService

Throws:

InvalidRedemptionCodeException

forgotPassword

public void forgotPassword(String username,
                           String securityQuestion,
                           String securityAnswer)
                    throws DBNotFoundException,
                           InvalidPasswordException,
                           UnsentEmailException

Description copied from interface: DuracloudUserService

This method generates a random password, replaces the existing password with the randomly generated one, and sends an email to the address on file for the given username.

Specified by:

forgotPassword in interface DuracloudUserService

Parameters:

username - of user who forgot their password

securityQuestion - of user who forgot their password

securityAnswer - of user who forgot their password

Throws:

InvalidPasswordException

UnsentEmailException

DBNotFoundException

retrievePassordChangeInvitation

public org.duracloud.account.db.model.UserInvitation retrievePassordChangeInvitation(String redemptionCode)
                                                                              throws DBNotFoundException

Description copied from interface: DuracloudUserService

Returns a user password change invitation

Specified by:

retrievePassordChangeInvitation in interface DuracloudUserService

Returns:

Throws:

DBNotFoundException

loadUserByUsername

public org.springframework.security.core.userdetails.UserDetails loadUserByUsername(String username)
                                                                             throws org.springframework.security.core.userdetails.UsernameNotFoundException

Specified by:

loadUserByUsername in interface org.springframework.security.core.userdetails.UserDetailsService

Throws:

org.springframework.security.core.userdetails.UsernameNotFoundException

loadDuracloudUserByUsername

public org.duracloud.account.db.model.DuracloudUser loadDuracloudUserByUsername(String username)
                                                                         throws DBNotFoundException

Description copied from interface: DuracloudUserService

This method loads a DuracloudUser from the persistence layer and populate its rights info.

Specified by:

loadDuracloudUserByUsername in interface DuracloudUserService

Parameters:

username - of user to load

Returns:

DuracloudUser

Throws:

DBNotFoundException

loadDuracloudUserByUsernameInternal

public org.duracloud.account.db.model.DuracloudUser loadDuracloudUserByUsernameInternal(String username)
                                                                                 throws DBNotFoundException

Specified by:

loadDuracloudUserByUsernameInternal in interface DuracloudUserService

Throws:

DBNotFoundException

loadDuracloudUserByIdInternal

public org.duracloud.account.db.model.DuracloudUser loadDuracloudUserByIdInternal(Long userId)
                                                                           throws DBNotFoundException

Specified by:

loadDuracloudUserByIdInternal in interface DuracloudUserService

Throws:

DBNotFoundException

redeemAccountInvitation

public Long redeemAccountInvitation(Long userId,
                                    String redemptionCode)
                             throws InvalidRedemptionCodeException

Description copied from interface: DuracloudUserService

This method redeems an invitation to add this user to a DuraCloud account.

Specified by:

redeemAccountInvitation in interface DuracloudUserService

Parameters:

userId - the id of the user which will be added to the account indicated in the invitation

redemptionCode - code which was sent to the user as part of the invitation to become part of an account

Returns:

the account id associated with the newly redeemed invitation.

Throws:

InvalidRedemptionCodeException

storeUserDetails

public void storeUserDetails(Long userId,
                             String firstName,
                             String lastName,
                             String email,
                             String securityQuestion,
                             String securityAnswer,
                             String allowableIPAddressRange)
                      throws DBNotFoundException

Description copied from interface: DuracloudUserService

This method persists the arg user details.

Specified by:

storeUserDetails in interface DuracloudUserService

Parameters:

userId - of user

firstName - of user

lastName - of user

email - of user

securityQuestion - of user

securityAnswer - of user

Throws:

DBNotFoundException

addUserToAccount

public boolean addUserToAccount(Long acctId,
                                Long userId)
                         throws DBNotFoundException

Description copied from interface: DuracloudUserService

This method sets the roles of a user in an account.

Note that this method only sets a user to new roles. To remove a user from an account, use revokeAllRights().

Specified by:

addUserToAccount in interface DuracloudUserService

Returns:

true if an update was performed.

Throws:

DBNotFoundException