Class UserService

java.lang.Object

com.bluebell.greenhouse.radicle.services.AbstractGenericEntityService<User, UserRepository>

com.bluebell.greenhouse.radicle.services.security.UserService

@Service
@Transactional(readOnly=true)
public class UserService
extends AbstractGenericEntityService<User, UserRepository>

Service-layer for User entities.

Version:

3.0.6

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor	Description
UserService(ApiTokenServiceStrategy apiTokenServiceStrategy, SimpleEmailService simpleEmailService, UserRepository userRepository)	Creates the service.

Method Summary

Modifier and Type	Method	Description
User	createUser(CreateUpdateUserDTO data)	Creates a new User from the given Map of data.
boolean	deleteUser(User user)	Deletes the given User when it no longer owns platform data.
Optional<User>	findAuthUserByEmail(String email)	Finds a User's authentication details by their email.
Optional<User>	findUserByEmail(String email)	Finds a User by their email.
Optional<User>	findUserByUsername(String username)	Finds a User by their username.
User	resolveAuthenticated(AuthenticatedUserRef ref)	Resolves the authenticated user a reference identifies.
User	rotateApiToken(User user)	Rotates the given User's api token.
org.springframework.data.domain.Page<User>	searchUsers(UserFilter filter, int page, int pageSize, org.springframework.data.domain.Sort sort)	Returns a paginated Page of Users matching the given filter.
User	updateUser(User user, CreateUpdateUserDTO data)	Updates an existing User with the given Map of data.
User	updateUserAccess(User user, UpdateUserAccessDTO data)	Updates an existing User's access information.

Methods inherited from class AbstractGenericEntityService

refreshEntity, resolveEntity, resolveEntity, resolveEntity

Methods inherited from class Object

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

Constructor Details

UserService

public UserService(ApiTokenServiceStrategy apiTokenServiceStrategy,
 SimpleEmailService simpleEmailService,
 UserRepository userRepository)

Creates the service.

Parameters:

apiTokenServiceStrategy - ApiTokenServiceStrategy

simpleEmailService - SimpleEmailService

userRepository - UserRepository

Method Details

resolveAuthenticated

public User resolveAuthenticated(AuthenticatedUserRef ref)

Resolves the authenticated user a reference identifies.

Parameters:

ref - AuthenticatedUserRef

Returns:

User

findUserByUsername

public Optional<User> findUserByUsername(String username)

Finds a User by their username.

Parameters:

username - username

Returns:

Optional User

findUserByEmail

public Optional<User> findUserByEmail(String email)

Finds a User by their email.

Parameters:

email - email

Returns:

Optional User

findAuthUserByEmail

public Optional<User> findAuthUserByEmail(String email)

Finds a User's authentication details by their email.

Parameters:

email - email

Returns:

Optional User

searchUsers

public org.springframework.data.domain.Page<User> searchUsers(UserFilter filter,
 int page,
 int pageSize,
 org.springframework.data.domain.Sort sort)

Returns a paginated Page of Users matching the given filter.

Parameters:

filter - UserFilter

page - current page

pageSize - page size

sort - Sort

Returns:

Page of User

createUser

@Transactional
public User createUser(CreateUpdateUserDTO data)

Creates a new User from the given Map of data.

Parameters:

data - CreateUpdateUserDTO

Returns:

newly created User

updateUser

@Transactional
public User updateUser(User user,
 CreateUpdateUserDTO data)

Updates an existing User with the given Map of data. Update methods are designed to be idempotent.

Parameters:

user - User

data - CreateUpdateUserDTO

Returns:

modified User

updateUserAccess

@Transactional
public User updateUserAccess(User user,
 UpdateUserAccessDTO data)

Updates an existing User's access information.

Parameters:

user - User

data - UpdateUserAccessDTO

Returns:

modified User

rotateApiToken

@Transactional
public User rotateApiToken(User user)

Rotates the given User's api token.

Parameters:

user - User

Returns:

updated User

deleteUser

@Transactional
public boolean deleteUser(User user)

Deletes the given User when it no longer owns platform data.

Parameters:

user - User

Returns:

true when deleted