UserApi.h

Go to the documentation of this file.

#ifndef LINTEL_USERAPI_H
#define LINTEL_USERAPI_H
 
#include <memory>
#include <optional>
#include <set>
#include <vector>
 
#include "lintel/features/base/controller/UserDto.h"
#include "lintel/features/base/controller/UserLoginDto.h"
#include "lintel/features/base/controller/UserPasswordChangeDto.h"
#include "lintel/features/base/controller/UserSessionDto.h"
#include "lintel/features/base/controller/UserTokenDto.h"
#include "lintel/features/base/services/AuthService.h"
#include "lintel/features/http/provider/ClientProvider.h"
 
namespace lintel {
class UserApi
{
private:
  std::shared_ptr<Client> m_client;
 
protected:
  UserApi() = default;
 
public:
  explicit UserApi(const std::shared_ptr<ClientProvider> &clientProvider);
 
  virtual ~UserApi() = default;
 
  // basic user functions for login / logout
  virtual std::optional<UserDto> loginOf(const UserLoginDto &userLoginDto);
 
  virtual bool logoutOf(const UserTokenDto &userTokenDto);
 
  virtual bool changePasswordOf(const UserPasswordChangeDto &passwordChangeDto);
 
  virtual std::vector<UserSessionDto> sessionsOf();
 
  virtual bool revokeSessionOf(const std::string &sessionId);
 
  virtual bool isLoggedIn();
 
  // user management functions
  virtual std::vector<GroupDto> allOf();
 
  virtual std::vector<GroupDto> allOf(const std::string &groupName);
 
  virtual std::vector<GroupDto> allOf(const std::string &groupName, bool isVirtualGroup);
 
  virtual std::vector<GroupDto> allOf(bool isVirtualGroup);
 
  virtual std::vector<UserDto> allUsersOf();
 
  virtual std::vector<UserDto> allUsersOf(const std::string &userName);
 
  virtual void createOf(const UserDto &userDto);
 
  virtual void updateOf(const std::string &userName,
    const std::set<std::string> &addGroups,
    const std::set<std::string> &removeGroups);
 
  virtual void deleteOf(const std::vector<std::string> &userNames);
};
 
}// namespace lintel
#endif// LINTEL_USERAPI_H