org.bremersee.dccon.service

Interface DomainUserService

All Known Implementing Classes:

DomainUserServiceImpl

@Validated
public interface DomainUserService

The domain user service interface.

Author:

Christian Bremer

Method Summary

Modifier and Type	Method and Description
org.bremersee.dccon.model.DomainUser	addUser(@NotNull @Valid org.bremersee.dccon.model.DomainUser domainUser, Boolean sendEmail, org.bremersee.common.model.TwoLetterLanguageCode language) Add domain user.
Boolean	deleteUser(@NotNull String userName) Delete user.
Optional<org.bremersee.dccon.model.DomainUser>	getUser(@NotNull String userName) Get domain user.
Optional<byte[]>	getUserAvatar(@NotNull String userName, org.bremersee.dccon.model.AvatarDefault avatarDefault, Integer size) Gets user avatar.
List<org.bremersee.dccon.model.DomainUser>	getUsers(String sort, String query) Get domain users.
void	resetData() Reset data.
Optional<org.bremersee.dccon.model.DomainUser>	updateUser(@NotNull String userName, Boolean updateGroups, @NotNull @Valid org.bremersee.dccon.model.DomainUser domainUser) Update domain user.
void	updateUserPassword(@NotNull String userName, @NotNull @Valid org.bremersee.dccon.model.Password newPassword, Boolean sendEmail, org.bremersee.common.model.TwoLetterLanguageCode language) Update user password.
Boolean	userExists(@NotNull String userName) Check whether user exists or not.

Method Detail

resetData

void resetData()

Reset data. This method is only available in a non productive environment.

getUsers

List<org.bremersee.dccon.model.DomainUser> getUsers(@Nullable
                                                    String sort,
                                                    @Nullable
                                                    String query)

Get domain users.

Parameters:

sort - the sort order

query - the query

Returns:

the users

addUser

org.bremersee.dccon.model.DomainUser addUser(@NotNull @Valid
                                             @NotNull @Valid org.bremersee.dccon.model.DomainUser domainUser,
                                             @Nullable
                                             Boolean sendEmail,
                                             @Nullable
                                             org.bremersee.common.model.TwoLetterLanguageCode language)

Add domain user.

Parameters:

domainUser - the domain user

sendEmail - specifies whether to send an email or not (default is false)

language - the language of the email

Returns:

the domain user

getUser

Optional<org.bremersee.dccon.model.DomainUser> getUser(@NotNull
                                                       @NotNull String userName)

Get domain user.

Parameters:

userName - the user name

Returns:

the domain user

updateUser

Optional<org.bremersee.dccon.model.DomainUser> updateUser(@NotNull
                                                          @NotNull String userName,
                                                          @Nullable
                                                          Boolean updateGroups,
                                                          @NotNull @Valid
                                                          @NotNull @Valid org.bremersee.dccon.model.DomainUser domainUser)

Update domain user.

Parameters:

userName - the user name

updateGroups - specifies whether the groups should also be updated or not (default is false)

domainUser - the domain user

Returns:

the domain user

updateUserPassword

void updateUserPassword(@NotNull
                        @NotNull String userName,
                        @NotNull @Valid
                        @NotNull @Valid org.bremersee.dccon.model.Password newPassword,
                        @Nullable
                        Boolean sendEmail,
                        @Nullable
                        org.bremersee.common.model.TwoLetterLanguageCode language)

Update user password.

Parameters:

userName - the user name

newPassword - the new password

sendEmail - specifies whether to send an email or not (default is false)

language - the language of the email

getUserAvatar

Optional<byte[]> getUserAvatar(@NotNull
                               @NotNull String userName,
                               @Nullable
                               org.bremersee.dccon.model.AvatarDefault avatarDefault,
                               @Nullable
                               Integer size)

Gets user avatar.

Parameters:

userName - the user name

avatarDefault - the avatar default

size - the size

Returns:

the user avatar

userExists

Boolean userExists(@NotNull
                   @NotNull String userName)

Check whether user exists or not.

Parameters:

userName - the user name

Returns:

true if the user exists, otherwise false

deleteUser

Boolean deleteUser(@NotNull
                   @NotNull String userName)

Delete user.

Parameters:

userName - the user name

Returns:

true if the user was removed; false if the user didn't exist