Package ru.averkiev.socialmediaapi.services

Interface UserService

All Known Implementing Classes:
UserServiceImpl
public interface UserService
Интерфейс определяет функциональность для управления пользователями.
Author:
mrGreenNV

  • Method Summary

    Modifier and Type
    Method
    Description
    List<User>
    getAllUsers()
    Возвращает список всех пользователей.
    User
    getUserById(Long userId)
    Возвращает пользователя по его идентификатору.
    User
    getUserByUsername(String username)
    Возвращает пользователя по его логину.
    UserCreateDTO
    register(UserCreateDTO userCreateDTO)
    Регистрирует нового пользователя в системе.
    User
    saveUser(User user)
    Сохраняет нового пользователя в системе.

  • Method Details

    • register

      UserCreateDTO register(UserCreateDTO userCreateDTO) throws UserRegistrationException
      Регистрирует нового пользователя в системе.
      Parameters:
      userCreateDTO - DTO данные нового пользователя.
      Returns:
      данные зарегистрированного пользователя.
      Throws:
      UserRegistrationException - выбрасывает если регистрация пользователя не удалась по каким-либо причинам.

    • saveUser

      User saveUser(User user)
      Сохраняет нового пользователя в системе.
      Parameters:
      user - новый пользователь.
      Returns:
      созданный пользователь.

    • getUserById

      User getUserById(Long userId) throws UserNotFoundException
      Возвращает пользователя по его идентификатору.
      Parameters:
      userId - идентификатор искомого пользователя.
      Returns:
      Optional, содержащий найденного пользователя, или пустой Optional, если пользователь не найден.
      Throws:
      UserNotFoundException - выбрасывает, если пользователь с заданным идентификатором не найден.

    • getUserByUsername

      User getUserByUsername(String username) throws UserNotFoundException
      Возвращает пользователя по его логину.
      Parameters:
      username - имя пользователя в системе.
      Returns:
      Optional, содержащий найденного пользователя, или пустой Optional, если пользователь не найден.
      Throws:
      UserNotFoundException - выбрасывает, если пользователь с заданным именем не найден.

    • getAllUsers

      List<User> getAllUsers()
      Возвращает список всех пользователей.
      Returns:
      список пользователей.