include/casbin/rbac/role_manager.h

/*
 * Copyright 2020 The casbin Authors. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef CASBIN_CPP_RBAC_ROLE_MANAGER
#define CASBIN_CPP_RBAC_ROLE_MANAGER

#include <string>
#include <vector>

namespace casbin {

// RoleManager provides interface to define the operations for managing roles.
class RoleManager {
public:
    // Clear clears all stored data and resets the role manager to the initial state.
    virtual void Clear() = 0;
    // AddLink adds the inheritance link between two roles. role: name1 and role: name2.
    // domain is a prefix to the roles (can be used for other purposes).
    virtual void AddLink(std::string name1, std::string name2, std::vector<std::string> domain = std::vector<std::string>{}) = 0;
    // DeleteLink deletes the inheritance link between two roles. role: name1 and role: name2.
    // domain is a prefix to the roles (can be used for other purposes).
    virtual void DeleteLink(std::string name1, std::string name2, std::vector<std::string> domain = std::vector<std::string>{}) = 0;
    // HasLink determines whether a link exists between two roles. role: name1 inherits role: name2.
    // domain is a prefix to the roles (can be used for other purposes).
    virtual bool HasLink(std::string name1, std::string name2, std::vector<std::string> domain = std::vector<std::string>{}) = 0;
    // GetRoles gets the roles that a user inherits.
    // domain is a prefix to the roles (can be used for other purposes).
    virtual std::vector<std::string> GetRoles(std::string name, std::vector<std::string> domain = std::vector<std::string>{}) = 0;
    // GetUsers gets the users that inherits a role.
    // domain is a prefix to the users (can be used for other purposes).
    virtual std::vector<std::string> GetUsers(std::string name, std::vector<std::string> domain = std::vector<std::string>{}) = 0;
    // PrintRoles prints all the roles to log.
    virtual void PrintRoles() = 0;
};

}; // namespace casbin

#endif