Package ru.averkiev.greenchat_user.services

Interface RoleService

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Role
    createRole(String roleName)
    Создаёт новую роль с указанным именем.
    void
    deleteRole(Long roleId)
    Удаляет роль по указанному идентификатору.
    boolean
    existsRoleByName(String roleName)
    Проверяет, существует ли роль с данным названием.
    List<Role>
    getAllRoles()
    Возвращает список всех ролей.
    Optional<Role>
    getRoleById(Long roleId)
    Возвращает роль по указанному идентификатору.
    Optional<Role>
    getRoleByName(String roleName)
    Возвращает роль по указанному имени.
    List<User>
    getUsersByRole(String roleName)
    Возвращает список всех пользователь с указанной ролью.
    Role
    softDeleteRole(Long roleId)
    Помечает роль удалённой, но не удаляет физически.
    Role
    updateRole(Long roleId, String roleName)
    Возвращает объект обновлённой роли.

  • Method Details

    • createRole

      Role createRole(String roleName) throws RoleAlreadyExistsException
      Создаёт новую роль с указанным именем.
      Parameters:
      roleName - имя роли.
      Returns:
      созданный объект роли.
      Throws:
      RoleAlreadyExistsException - - выбрасывается если роль с таким названием уже существует.

    • updateRole

      Role updateRole(Long roleId, String roleName) throws RoleNotFoundException
      Возвращает объект обновлённой роли.
      Parameters:
      roleId - идентификатор обновляемой роли.
      roleName - новое имя роли.
      Returns:
      объект обновлённой роли
      Throws:
      RoleNotFoundException - - выбрасывается, если роль с указанным идентификатором не найдена.

    • deleteRole

      void deleteRole(Long roleId) throws RoleNotFoundException
      Удаляет роль по указанному идентификатору.
      Parameters:
      roleId - указанный идентификатор роли.
      Throws:
      RoleNotFoundException - выбрасывается, если роль с таким идентификатором не найдена.

    • softDeleteRole

      Role softDeleteRole(Long roleId) throws RoleNotFoundException
      Помечает роль удалённой, но не удаляет физически.
      Parameters:
      roleId - идентификатор роли.
      Returns:
      роль с измененным статусом.
      Throws:
      RoleNotFoundException

    • getRoleById

      Optional<Role> getRoleById(Long roleId)
      Возвращает роль по указанному идентификатору.
      Parameters:
      roleId - указанный идентификатор роли.
      Returns:
      Optional, содержащий найденную роль, или пустой Optional, если роль не найдена.

    • getRoleByName

      Optional<Role> getRoleByName(String roleName)
      Возвращает роль по указанному имени.
      Parameters:
      roleName - указанное имя роли.
      Returns:
      Optional, содержащий найденную роль, или пустой Optional, если роль не найдена.

    • getAllRoles

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

    • getUsersByRole

      List<User> getUsersByRole(String roleName) throws RoleNotFoundException
      Возвращает список всех пользователь с указанной ролью.
      Parameters:
      roleName - указанное имя роли.
      Returns:
      список пользователей
      Throws:
      RoleNotFoundException - - выбрасывается, если указанная роль не найдена.

    • existsRoleByName

      boolean existsRoleByName(String roleName)
      Проверяет, существует ли роль с данным названием.
      Parameters:
      roleName - электронная почта проверяемого пользователя.
      Returns:
      true, если пользователь существует, иначе false.