com.neurosys.user.service

Class UserServiceImpl<U extends User,R extends ResetPassword.ResetPasswordResponse>

java.lang.Object

com.neurosys.user.service.UserServiceImpl<U,R>

Type Parameters:

U - as User

T - as ResetPasswordResponse

All Implemented Interfaces:

ChangeGenerator<Object>, ChangePassword, ResetPassword<R>, UserService<U,R>

Direct Known Subclasses:

UserServiceImpl

public class UserServiceImpl<U extends User,R extends ResetPassword.ResetPasswordResponse>
extends Object
implements UserService<U,R>, ChangeGenerator<Object>

Provide user with default common services around IDM and password management etc. Also hashing of passwords if in appConfiguration.site.hash.passwords is defined and true
Note : This class does not extend its Dao, because we want to be able to substitute and replace the Dao if needed for more specific scenarios.

Since this implements ChangeGenerator; it will also generate Events of Type

• on Reset Password Response Setup - Object[]{String userId, R response}
• Save User - U
• Any other event - Object[]{eventName, User}

Author:

Arjun Dhar

Nested Class Summary

Nested classes/interfaces inherited from interface com.neurosys.user.service.ResetPassword

ResetPassword.ResetPasswordResponse

Field Summary

Fields

Modifier and Type	Field and Description
protected UserDao<U>	userDao

Constructor Summary

Constructors

Constructor and Description
UserServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener changeListener) Allow Notify all ChangeListeners about a change
void	changePassword(String userNameId, String existingPassword, String newPassword)
void	changePasswordRestrictedAccess(String userChangingThePassword, String userNameId, String newPassword) Whenere another user can change for the given user but the user id of the change request should be supplied to validate if the changer has authority to do sp
protected String	generatePassword()
<E> Supplier<E>	getEnvironmentSupplier(Object... userEnvRelatedObjects) Since User.getEnvironmentSupplier() and Role.getEnvironmentSupplier().
List	getListeners() Get list directly.
UserDao	getUserDao()
void	notifyAllListeners(Object object) Whenever a node is selected/updated, it also notifies its listeners.
U	notifyChange(String eventName, U user) Any change in User object, notify the change using the changed object
void	onResetFail(String userNameId, Exception e) Due to some reason the requested action to reset password for user with ud = userNameId failed.
void	onResetSuccess(String userNameId, R passwordResetResponse) For a valid userNameId the password was successfully reset, allow other action to be taken on success status
R	resetPassword(String userNameId) Reset the password for the User with userNameId and product a Response of type R. Callbacks ResetPassword.onResetSuccess(java.lang.String, R) and ResetPassword.onResetFail(java.lang.String, java.lang.Exception)
void	save(Credentials credentials)
U	save(U user)
void	setListeners(List listeners) Set list directly.
protected R	setupResponse(String userNameId, String newPassword) Please note this method is called before the newPassword is persisted.
void	setUserDao(UserDao userDao)
<E> void	updateShell(Shell<E> shell, E environment, U user) Once we have a User object, update the Shell with it with any environment or contextual details.
void	updateShell(Shell shell, U user) UserService.updateShell(Shell, Object, User) where the environment does not need to be specified and is assumed self-dervied from the user

Methods inherited from class java.lang.Object

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

Field Detail

userDao

@Qualifier(value="userModuleJPADao")
protected UserDao<U extends User> userDao

Constructor Detail

UserServiceImpl

public UserServiceImpl()

Method Detail

changePassword

@Transactional(readOnly=false)
public void changePassword(String userNameId,
                                                          String existingPassword,
                                                          String newPassword)
                                                   throws Exception

Specified by:

changePassword in interface ChangePassword

Throws:

Exception

changePasswordRestrictedAccess

public void changePasswordRestrictedAccess(String userChangingThePassword,
                                           String userNameId,
                                           String newPassword)
                                    throws Exception

Description copied from interface: ChangePassword

Whenere another user can change for the given user but the user id of the change request should be supplied to validate if the changer has authority to do sp

Specified by:

changePasswordRestrictedAccess in interface ChangePassword

Throws:

Exception

save

@Transactional(readOnly=false)
public void save(Credentials credentials)

Specified by:

save in interface ChangePassword

save

@Transactional(readOnly=false)
public U save(U user)

Specified by:

save in interface UserService<U extends User,R extends ResetPassword.ResetPasswordResponse>

getUserDao

public UserDao getUserDao()

Specified by:

getUserDao in interface UserService<U extends User,R extends ResetPassword.ResetPasswordResponse>

setUserDao

public void setUserDao(UserDao userDao)

generatePassword

protected String generatePassword()

setupResponse

protected R setupResponse(String userNameId,
                          String newPassword)
                   throws Exception

Please note this method is called before the newPassword is persisted.
So any validation or any activity/cross-checks can be performed here and one may even throw an Exception to discontinue the reset if required.
In this implementation (default); the response contains the new password. See ResetPassword.ResetPasswordResponse.getResponseCode()

Parameters:

userNameId - as String

newPassword - as String

Returns:

R as ResetPassword.ResetPasswordResponse

Throws:

Exception

resetPassword

public R resetPassword(String userNameId)
                throws Exception

Description copied from interface: ResetPassword

Reset the password for the User with userNameId and product a Response of type R.
Callbacks ResetPassword.onResetSuccess(java.lang.String, R) and ResetPassword.onResetFail(java.lang.String, java.lang.Exception)

Specified by:

resetPassword in interface ResetPassword<R extends ResetPassword.ResetPasswordResponse>

Returns:

R @nullable false

Throws:

Exception

onResetSuccess

public void onResetSuccess(String userNameId,
                           R passwordResetResponse)

Description copied from interface: ResetPassword

For a valid userNameId the password was successfully reset, allow other action to be taken on success status

Specified by:

onResetSuccess in interface ResetPassword<R extends ResetPassword.ResetPasswordResponse>

Parameters:

userNameId - as String

onResetFail

public void onResetFail(String userNameId,
                        Exception e)

Description copied from interface: ResetPassword

Due to some reason the requested action to reset password for user with ud = userNameId failed.

Specified by:

onResetFail in interface ResetPassword<R extends ResetPassword.ResetPasswordResponse>

Parameters:

userNameId - as String

e - as Exception details

getEnvironmentSupplier

public <E> Supplier<E> getEnvironmentSupplier(Object... userEnvRelatedObjects)

Since User.getEnvironmentSupplier() and Role.getEnvironmentSupplier(). In case of multiple Roles or names of Roles; merge and decide the final Supplier of the environment context. This implementation assumes all user Environment Related Objects to be String names of Roles and the first as User.getEnvironmentSupplier().
TODO: Code for Role related context resolution

Specified by:

getEnvironmentSupplier in interface UserService<U extends User,R extends ResetPassword.ResetPasswordResponse>

Parameters:

userEnvRelatedObjects - can be User, Role, String (Role Name), or any Object assumed to be a context itself.

Returns:

Supplier of environment Object

updateShell

public <E> void updateShell(Shell<E> shell,
                            E environment,
                            U user)

Once we have a User object, update the Shell with it with any environment or contextual details.

Specified by:

updateShell in interface UserService<U extends User,R extends ResetPassword.ResetPasswordResponse>

Parameters:

shell - as Shell

environment - as Object (supplied by caller who has access to the raw environment). See example UserShell.getEnvironment(). An environment may also be derived from user or role. See UserService.getEnvironmentSupplier(Object...)

user - as User

updateShell

public void updateShell(Shell shell,
                        U user)

UserService.updateShell(Shell, Object, User) where the environment does not need to be specified and is assumed self-dervied from the user

Specified by:

updateShell in interface UserService<U extends User,R extends ResetPassword.ResetPasswordResponse>

Parameters:

shell - as Shell

user - as User

See Also:

here varargs param = user; to derive environment by default

addChangeListener

public void addChangeListener(ChangeListener changeListener)

Description copied from interface: ChangeGenerator

Allow Notify all ChangeListeners about a change

Specified by:

addChangeListener in interface ChangeGenerator<Object>

notifyAllListeners

public void notifyAllListeners(Object object)

Description copied from interface: ChangeGenerator

Whenever a node is selected/updated, it also notifies its listeners.

Specified by:

notifyAllListeners in interface ChangeGenerator<Object>

getListeners

public List getListeners()

Description copied from interface: ChangeGenerator

Get list directly. Support DI; like Spring IOC

Specified by:

getListeners in interface ChangeGenerator<Object>

setListeners

public void setListeners(List listeners)

Description copied from interface: ChangeGenerator

Set list directly. Support DI; like Spring IOC

Specified by:

setListeners in interface ChangeGenerator<Object>

notifyChange

public U notifyChange(String eventName,
                      U user)

Description copied from interface: UserService

Any change in User object, notify the change using the changed object

Specified by:

notifyChange in interface UserService<U extends User,R extends ResetPassword.ResetPasswordResponse>

Parameters:

eventName - as String

user - as User type

Returns:

User