Package ru.averkiev.socialmediaapi.services

Interface AuthService

All Known Implementing Classes:
AuthServiceImpl
public interface AuthService
Интерфейс определяет функциональность для осуществления входа в систему, получения токенов, их валидации и обновления.
Author:
mrGreenNV

  • Method Summary

    Modifier and Type
    Method
    Description
    JwtResponse
    getAccessToken(RefreshToken refreshToken)
    Позволяет получить новый AccessToken по заданному refresh токену.
    JwtAuthentication
    getAuthInfo()
    Позволяет получить информацию об аутентификации.
    Long
    getUserIdFromAuthentication()
    Позволяет получить идентификатор пользователя из аутентификации.
    JwtResponse
    login(JwtRequest authRequest)
    Осуществляет вход пользователя в систему
    boolean
    logout(RefreshToken refreshToken)
    Позволяет осуществить выход пользователя из системы, при этом access и refresh токены удаляются.
    JwtResponse
    refresh(RefreshToken refreshToken)
    Позволяет обновить пару токенов на заданному refresh токену.
    boolean
    validateAccessToken(AccessToken accessToken)
    Осуществляет валидацию access токена.
    boolean
    validateRefreshToken(RefreshToken refreshToken)
    Осуществляет валидацию refresh токена.

  • Method Details

    • login

      JwtResponse login(JwtRequest authRequest)
      Осуществляет вход пользователя в систему
      Parameters:
      authRequest - запрос аутентификации.
      Returns:
      объект JwtResponse содержащий пару токенов.

    • getAccessToken

      JwtResponse getAccessToken(RefreshToken refreshToken) throws AuthException
      Позволяет получить новый AccessToken по заданному refresh токену.
      Parameters:
      refreshToken - refresh токен.
      Returns:
      объект JwtResponse содержащий новый access токен.
      Throws:
      AuthException - выбрасывает при ошибке обновления токена.

    • refresh

      JwtResponse refresh(RefreshToken refreshToken) throws AuthException
      Позволяет обновить пару токенов на заданному refresh токену.
      Parameters:
      refreshToken - refresh токен.
      Returns:
      объект JwtResponse содержащий пару новых токенов.
      Throws:
      AuthException - выбрасывает при ошибке обновления токенов.

    • getAuthInfo

      JwtAuthentication getAuthInfo()
      Позволяет получить информацию об аутентификации.
      Returns:
      объект JwtAuthentication.

    • logout

      boolean logout(RefreshToken refreshToken)
      Позволяет осуществить выход пользователя из системы, при этом access и refresh токены удаляются.
      Parameters:
      refreshToken - refresh токен.
      Returns:
      true, если выход осуществлен иначе - false.

    • validateRefreshToken

      boolean validateRefreshToken(RefreshToken refreshToken) throws AuthException
      Осуществляет валидацию refresh токена.
      Parameters:
      refreshToken - refresh токен.
      Returns:
      true, если токен валиден, иначе - false.
      Throws:
      AuthException

    • validateAccessToken

      boolean validateAccessToken(AccessToken accessToken)
      Осуществляет валидацию access токена.
      Parameters:
      accessToken - access токен.
      Returns:
      true, если токен валиден, иначе - false.

    • getUserIdFromAuthentication

      Long getUserIdFromAuthentication() throws AuthException
      Позволяет получить идентификатор пользователя из аутентификации.
      Returns:
      идентификатор пользователя.
      Throws:
      AuthException - выбрасывает если возникает ошибка аутентификации.