de.terrestris.shogun2.service

Class UserService<E extends User,D extends UserDao<E>>

java.lang.Object

de.terrestris.shogun2.service.AbstractDaoService<E,D>

de.terrestris.shogun2.service.AbstractCrudService<E,D>

de.terrestris.shogun2.service.PermissionAwareCrudService<E,D>

de.terrestris.shogun2.service.PersonService<E,D>

de.terrestris.shogun2.service.UserService<E,D>

@Service(value="userService")
public class UserService<E extends User,D extends UserDao<E>>
extends PersonService<E,D>

Service class for the User model.

Author:

Nils Bühner

See Also:

AbstractCrudService

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.security.crypto.password.PasswordEncoder	passwordEncoder The autowired PasswordEncoder
protected RegistrationTokenService<RegistrationToken,RegistrationTokenDao<RegistrationToken>>	registrationTokenService Registration token service
protected RoleService<Role,RoleDao<Role>>	roleService Role service

Fields inherited from class de.terrestris.shogun2.service.PermissionAwareCrudService

permissionCollectionService

Fields inherited from class de.terrestris.shogun2.service.AbstractDaoService

dao, LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
	UserService() Default constructor, which calls the type-constructor
protected	UserService(Class<E> entityClass) Constructor that sets the concrete entity class for the service.

Method Summary

Modifier and Type	Method and Description
void	activateUser(String tokenValue)
E	findByAccountName(String accountName) Returns the user for the given (unique) account name.
E	findByEmail(String email)
Role	getDefaultUserRole()
Set<UserGroup>	getGroupsOfUser(Integer userId)
org.springframework.security.crypto.password.PasswordEncoder	getPasswordEncoder()
E	getUserBySession()
E	persistNewUser(E user, boolean encryptPassword) Persists a new user in the database.
E	registerUser(E user, javax.servlet.http.HttpServletRequest request) Registers a new user.
void	setDao(D dao) We have to use Qualifier to define the correct dao here.
void	setDefaultUserRole(Role defaultUserRole)
void	setPasswordEncoder(org.springframework.security.crypto.password.PasswordEncoder passwordEncoder)
void	updatePassword(E user, String rawPassword)

Methods inherited from class de.terrestris.shogun2.service.PermissionAwareCrudService

addAndSaveGroupPermissions, addAndSaveUserPermissions, findAllUserGroupPermissionsOfUserGroup, findAllUserPermissionsOfUser, getPermissionCollectionService, removeAndSaveGroupPermissions, removeAndSaveUserPermissions, setPermissionCollectionService

Methods inherited from class de.terrestris.shogun2.service.AbstractCrudService

delete, findAll, findById, loadById, saveOrUpdate, updatePartialWithJsonNode

Methods inherited from class de.terrestris.shogun2.service.AbstractDaoService

getDao, getEntityClass

Methods inherited from class java.lang.Object

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

Field Detail

registrationTokenService

@Autowired
protected RegistrationTokenService<RegistrationToken,RegistrationTokenDao<RegistrationToken>> registrationTokenService

Registration token service

roleService

@Autowired
protected RoleService<Role,RoleDao<Role>> roleService

Role service

passwordEncoder

@Autowired
protected org.springframework.security.crypto.password.PasswordEncoder passwordEncoder

The autowired PasswordEncoder

Constructor Detail

UserService

public UserService()

Default constructor, which calls the type-constructor

UserService

protected UserService(Class<E> entityClass)

Constructor that sets the concrete entity class for the service. Subclasses MUST call this constructor.

Method Detail

setDao

@Autowired
 @Qualifier(value="userDao")
public void setDao(D dao)

We have to use Qualifier to define the correct dao here. Otherwise, spring can not decide which dao has to be autowired here as there are multiple candidates.

Overrides:

setDao in class PersonService<E extends User,D extends UserDao<E>>

Parameters:

dao - the dao to set

findByAccountName

@PostAuthorize(value="hasRole(@configHolder.getSuperAdminRoleName()) or hasPermission(#accountName, \'READ\')")
public E findByAccountName(String accountName)

Returns the user for the given (unique) account name. If no user was found, null will be returned.

Parameters:

accountName - A unique account name.

Returns:

The unique user for the account name or null.

findByEmail

@PostAuthorize(value="hasRole(@configHolder.getSuperAdminRoleName()) or hasPermission(#email, \'READ\')")
public E findByEmail(String email)

Parameters:

email -

Returns:

registerUser

public E registerUser(E user,
                      javax.servlet.http.HttpServletRequest request)
               throws Exception

Registers a new user. Initially, the user will be inactive. An email with an activation link will be sent to the user.

Parameters:

user - A user with an UNencrypted password (!)

request -

Returns:

Throws:

Exception

activateUser

public void activateUser(String tokenValue)
                  throws Exception

Parameters:

token -

Throws:

Exception

persistNewUser

public E persistNewUser(E user,
                        boolean encryptPassword)

Persists a new user in the database.

Parameters:

user - The user to create

encryptPassword - Whether or not the current password of the user object should be encrypted or not before the object is persisted in the db

Returns:

The persisted user object (incl. ID value)

updatePassword

public void updatePassword(E user,
                           String rawPassword)
                    throws Exception

Parameters:

user -

rawPassword -

Throws:

Exception

getUserBySession

public E getUserBySession()

Parameters:

request -

Throws:

Exception

getGroupsOfUser

@PostFilter(value="hasRole(@configHolder.getSuperAdminRoleName()) or hasPermission(filterObject, \'READ\')")
public Set<UserGroup> getGroupsOfUser(Integer userId)
                                                                                                                                            throws Exception

Parameters:

userId -

Returns:

Throws:

Exception

getPasswordEncoder

public org.springframework.security.crypto.password.PasswordEncoder getPasswordEncoder()

Returns:

the passwordEncoder

setPasswordEncoder

public void setPasswordEncoder(org.springframework.security.crypto.password.PasswordEncoder passwordEncoder)

Parameters:

passwordEncoder - the passwordEncoder to set

getDefaultUserRole

public Role getDefaultUserRole()

Returns:

the defaultUserRole

setDefaultUserRole

public void setDefaultUserRole(Role defaultUserRole)

Parameters:

defaultUserRole - the defaultUserRole to set