org.appfuse.service.impl

Class UserManagerImpl

java.lang.Object

org.appfuse.service.impl.GenericManagerImpl<org.appfuse.model.User,Long>

org.appfuse.service.impl.UserManagerImpl

All Implemented Interfaces:

GenericManager<org.appfuse.model.User,Long>, UserManager, UserService

@Service(value="userManager")
public class UserManagerImpl
extends GenericManagerImpl<org.appfuse.model.User,Long>
implements UserManager, UserService

Implementation of UserManager interface.

Author:

Matt Raible

Field Summary

Fields inherited from class org.appfuse.service.impl.GenericManagerImpl

dao, log

Constructor Summary

Constructors

Constructor and Description
UserManagerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
String	buildRecoveryPasswordUrl(org.appfuse.model.User user, String urlTemplate) Builds a recovery password url by replacing placeholders with username and generated recovery token.
String	generateRecoveryToken(org.appfuse.model.User user)
org.appfuse.model.User	getUser(String userId) Retrieves a user by userId.
org.appfuse.model.User	getUserByUsername(String username) Finds a user by their username.
List<org.appfuse.model.User>	getUsers() Retrieves a list of all users.
boolean	isRecoveryTokenValid(String username, String token)
boolean	isRecoveryTokenValid(org.appfuse.model.User user, String token)
void	removeUser(String userId) Removes a user from the database by their userId
void	removeUser(org.appfuse.model.User user) Removes a user from the database
org.appfuse.model.User	saveUser(org.appfuse.model.User user) Saves a user's information.
List<org.appfuse.model.User>	search(String searchTerm) Search a user for search terms.
void	sendPasswordRecoveryEmail(String username, String urlTemplate) Sends a password recovery email to username.
void	setMailEngine(MailEngine mailEngine)
void	setMailMessage(org.springframework.mail.SimpleMailMessage message)
void	setPasswordEncoder(org.springframework.security.crypto.password.PasswordEncoder passwordEncoder) Convenience method for testing - allows you to mock the PasswordEncoder and set it on an interface.
void	setPasswordRecoveryTemplate(String passwordRecoveryTemplate) Velocity template name to send users a password recovery mail (default passwordRecovery.vm).
void	setPasswordTokenManager(PasswordTokenManager passwordTokenManager)
void	setPasswordUpdatedTemplate(String passwordUpdatedTemplate) Velocity template name to inform users their password was updated (default passwordUpdated.vm).
void	setUserDao(UserDao userDao) Convenience method for testing - allows you to mock the DAO and set it on an interface.
org.appfuse.model.User	updatePassword(String username, String currentPassword, String recoveryToken, String newPassword, String applicationUrl)

Methods inherited from class org.appfuse.service.impl.GenericManagerImpl

exists, get, getAll, reindex, reindexAll, remove, remove, save, search

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.appfuse.service.GenericManager

exists, get, getAll, reindex, reindexAll, remove, remove, save, search

Constructor Detail

UserManagerImpl

public UserManagerImpl()

Method Detail

setPasswordEncoder

@Autowired
@Qualifier(value="passwordEncoder")
public void setPasswordEncoder(org.springframework.security.crypto.password.PasswordEncoder passwordEncoder)

Description copied from interface: UserManager

Convenience method for testing - allows you to mock the PasswordEncoder and set it on an interface.

Specified by:

setPasswordEncoder in interface UserManager

Parameters:

passwordEncoder - the PasswordEncoder implementation to use

setUserDao

@Autowired
public void setUserDao(UserDao userDao)

Description copied from interface: UserManager

Convenience method for testing - allows you to mock the DAO and set it on an interface.

Specified by:

setUserDao in interface UserManager

Parameters:

userDao - the UserDao implementation to use

setMailEngine

@Autowired(required=false)
public void setMailEngine(MailEngine mailEngine)

setMailMessage

@Autowired(required=false)
public void setMailMessage(org.springframework.mail.SimpleMailMessage message)

setPasswordTokenManager

@Autowired(required=false)
public void setPasswordTokenManager(PasswordTokenManager passwordTokenManager)

setPasswordRecoveryTemplate

public void setPasswordRecoveryTemplate(String passwordRecoveryTemplate)

Velocity template name to send users a password recovery mail (default passwordRecovery.vm).

Parameters:

passwordRecoveryTemplate - the Velocity template to use (relative to classpath)

See Also:

MailEngine.sendMessage(org.springframework.mail.SimpleMailMessage, String, java.util.Map)

setPasswordUpdatedTemplate

public void setPasswordUpdatedTemplate(String passwordUpdatedTemplate)

Velocity template name to inform users their password was updated (default passwordUpdated.vm).

Parameters:

passwordUpdatedTemplate - the Velocity template to use (relative to classpath)

See Also:

MailEngine.sendMessage(org.springframework.mail.SimpleMailMessage, String, java.util.Map)

getUser

public org.appfuse.model.User getUser(String userId)

Retrieves a user by userId. An exception is thrown if user not found

Specified by:

getUser in interface UserManager

Specified by:

getUser in interface UserService

Parameters:

userId - the identifier for the user

Returns:

User

getUsers

public List<org.appfuse.model.User> getUsers()

Retrieves a list of all users.

Specified by:

getUsers in interface UserManager

Specified by:

getUsers in interface UserService

Returns:

List

saveUser

public org.appfuse.model.User saveUser(org.appfuse.model.User user)
                                throws UserExistsException

Saves a user's information.

Specified by:

saveUser in interface UserManager

Specified by:

saveUser in interface UserService

Parameters:

user - the user's information

Returns:

user the updated user object

Throws:

UserExistsException - thrown when user already exists

removeUser

public void removeUser(org.appfuse.model.User user)

Removes a user from the database

Specified by:

removeUser in interface UserManager

Parameters:

user - the user to remove

removeUser

public void removeUser(String userId)

Removes a user from the database by their userId

Specified by:

removeUser in interface UserManager

Specified by:

removeUser in interface UserService

Parameters:

userId - the user's id

getUserByUsername

public org.appfuse.model.User getUserByUsername(String username)
                                         throws org.springframework.security.core.userdetails.UsernameNotFoundException

Finds a user by their username.

Specified by:

getUserByUsername in interface UserManager

Specified by:

getUserByUsername in interface UserService

Parameters:

username - the login name of the human

Returns:

User the populated user object

Throws:

org.springframework.security.core.userdetails.UsernameNotFoundException - thrown when username not found

search

public List<org.appfuse.model.User> search(String searchTerm)

Search a user for search terms.

Specified by:

search in interface UserManager

Parameters:

searchTerm - the search terms.

Returns:

a list of matches, or all if no searchTerm.

buildRecoveryPasswordUrl

public String buildRecoveryPasswordUrl(org.appfuse.model.User user,
                              String urlTemplate)

Description copied from interface: UserManager

Builds a recovery password url by replacing placeholders with username and generated recovery token. UrlTemplate should include two placeholders '{username}' for username and '{token}' for the recovery token.

Specified by:

buildRecoveryPasswordUrl in interface UserManager

Returns:

generateRecoveryToken

public String generateRecoveryToken(org.appfuse.model.User user)

Specified by:

generateRecoveryToken in interface UserManager

Returns:

isRecoveryTokenValid

public boolean isRecoveryTokenValid(String username,
                           String token)

Specified by:

isRecoveryTokenValid in interface UserManager

Returns:

isRecoveryTokenValid

public boolean isRecoveryTokenValid(org.appfuse.model.User user,
                           String token)

Specified by:

isRecoveryTokenValid in interface UserManager

Returns:

sendPasswordRecoveryEmail

public void sendPasswordRecoveryEmail(String username,
                             String urlTemplate)

Sends a password recovery email to username.

Specified by:

sendPasswordRecoveryEmail in interface UserManager

urlTemplate - url template including two placeholders '{username}' and '{token}'

updatePassword

public org.appfuse.model.User updatePassword(String username,
                                    String currentPassword,
                                    String recoveryToken,
                                    String newPassword,
                                    String applicationUrl)
                                      throws UserExistsException

Specified by:

updatePassword in interface UserManager

Returns:

Throws:

UserExistsException