config_backend_dhcp6.h

Go to the documentation of this file.

// Copyright (C) 2019-2025 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef CONFIG_BACKEND_DHCP6_H
#define CONFIG_BACKEND_DHCP6_H
 
#include <cc/server_tag.h>
#include <cc/stamped_value.h>
#include <config_backend/base_config_backend.h>
#include <database/audit_entry.h>
#include <database/server.h>
#include <database/server_collection.h>
#include <database/server_selector.h>
#include <dhcp/option.h>
#include <dhcp/option_definition.h>
#include <dhcpsrv/cfg_option.h>
#include <dhcpsrv/client_class_def.h>
#include <dhcpsrv/shared_network.h>
#include <dhcpsrv/subnet.h>
#include <boost/shared_ptr.hpp>
#include <boost/date_time/posix_time/ptime.hpp>
#include <string>
 
namespace isc {
namespace dhcp {

class ConfigBackendDHCPv6 : public cb::BaseConfigBackend {
public:

    virtual ~ConfigBackendDHCPv6() { }

    virtual Subnet6Ptr
    getSubnet6(const db::ServerSelector& server_selector,
               const std::string& subnet_prefix) const = 0;

    virtual Subnet6Ptr
    getSubnet6(const db::ServerSelector& server_selector, const SubnetID& subnet_id) const = 0;

    virtual Subnet6Collection
    getAllSubnets6(const db::ServerSelector& server_selector) const = 0;

    virtual Subnet6Collection
    getSharedNetworkSubnets6(const db::ServerSelector& server_selector,
                             const std::string& shared_network_name) const = 0;

    virtual Subnet6Collection
    getModifiedSubnets6(const db::ServerSelector& server_selector,
                        const boost::posix_time::ptime& modification_time) const = 0;

    virtual SharedNetwork6Ptr
    getSharedNetwork6(const db::ServerSelector& server_selector,
                      const std::string& name) const = 0;

    virtual SharedNetwork6Collection
    getAllSharedNetworks6(const db::ServerSelector& server_selector) const = 0;

    virtual SharedNetwork6Collection
    getModifiedSharedNetworks6(const db::ServerSelector& server_selector,
                               const boost::posix_time::ptime& modification_time) const = 0;

    virtual OptionDefinitionPtr
    getOptionDef6(const db::ServerSelector& server_selector, const uint16_t code,
                  const std::string& space) const = 0;

    virtual OptionDefContainer
    getAllOptionDefs6(const db::ServerSelector& server_selector) const = 0;

    virtual OptionDefContainer
    getModifiedOptionDefs6(const db::ServerSelector& server_selector,
                           const boost::posix_time::ptime& modification_time) const = 0;

    virtual OptionDescriptorPtr
    getOption6(const db::ServerSelector& server_selector, const uint16_t code,
               const std::string& space,
               const ClientClassesPtr client_classes = ClientClassesPtr()) const = 0;

    virtual OptionContainer
    getAllOptions6(const db::ServerSelector& server_selector) const = 0;

    virtual OptionContainer
    getModifiedOptions6(const db::ServerSelector& selector,
                        const boost::posix_time::ptime& modification_time) const = 0;

    virtual data::StampedValuePtr
    getGlobalParameter6(const db::ServerSelector& selector,
                        const std::string& name) const = 0;

    virtual data::StampedValueCollection
    getAllGlobalParameters6(const db::ServerSelector& selector) const = 0;

    virtual data::StampedValueCollection
    getModifiedGlobalParameters6(const db::ServerSelector& selector,
                                 const boost::posix_time::ptime& modification_time) const = 0;

    virtual ClientClassDefPtr
    getClientClass6(const db::ServerSelector& selector, const std::string& name) const = 0;

    virtual ClientClassDictionary
    getAllClientClasses6(const db::ServerSelector& selector) const = 0;

    virtual ClientClassDictionary
    getModifiedClientClasses6(const db::ServerSelector& selector,
                              const boost::posix_time::ptime& modification_time) const = 0;

    virtual db::AuditEntryCollection
    getRecentAuditEntries(const db::ServerSelector& server_selector,
                          const boost::posix_time::ptime& modification_time,
                          const uint64_t& modification_id) const = 0;

    virtual db::ServerCollection
    getAllServers6() const = 0;

    virtual db::ServerPtr
    getServer6(const data::ServerTag& server_tag) const = 0;

    virtual void
    createUpdateSubnet6(const db::ServerSelector& server_selector,
                        const Subnet6Ptr& subnet) = 0;

    virtual void
    createUpdateSharedNetwork6(const db::ServerSelector& server_selector,
                               const SharedNetwork6Ptr& shared_network) = 0;

    virtual void
    createUpdateOptionDef6(const db::ServerSelector& server_selector,
                           const OptionDefinitionPtr& option_def) = 0;

    virtual void
    createUpdateOption6(const db::ServerSelector& server_selector,
                        const OptionDescriptorPtr& option) = 0;

    virtual void
    createUpdateOption6(const db::ServerSelector& selector,
                        const std::string& shared_network_name,
                        const OptionDescriptorPtr& option) = 0;

    virtual void
    createUpdateOption6(const db::ServerSelector& server_selector,
                        const SubnetID& subnet_id,
                        const OptionDescriptorPtr& option) = 0;

    virtual void
    createUpdateOption6(const db::ServerSelector& server_selector,
                        const asiolink::IOAddress& pool_start_address,
                        const asiolink::IOAddress& pool_end_address,
                        const OptionDescriptorPtr& option) = 0;

    virtual void
    createUpdateOption6(const db::ServerSelector& server_selector,
                        const asiolink::IOAddress& pd_pool_prefix,
                        const uint8_t pd_pool_prefix_length,
                        const OptionDescriptorPtr& option) = 0;

    virtual void
    createUpdateGlobalParameter6(const db::ServerSelector& server_selector,
                                 const data::StampedValuePtr& value) = 0;

    virtual void
    createUpdateClientClass6(const db::ServerSelector& server_selector,
                             const ClientClassDefPtr& client_class,
                             const std::string& follow_class_name) = 0;

    virtual void
    createUpdateServer6(const db::ServerPtr& server) = 0;

    virtual uint64_t
    deleteSubnet6(const db::ServerSelector& server_selector,
                  const std::string& subnet_prefix) = 0;

    virtual uint64_t
    deleteSubnet6(const db::ServerSelector& server_selector, const SubnetID& subnet_id) = 0;

    virtual uint64_t
    deleteAllSubnets6(const db::ServerSelector& server_selector) = 0;

    virtual uint64_t
    deleteSharedNetworkSubnets6(const db::ServerSelector& server_selector,
                                const std::string& shared_network_name) = 0;

    virtual uint64_t
    deleteSharedNetwork6(const db::ServerSelector& server_selector,
                         const std::string& name) = 0;

    virtual uint64_t
    deleteAllSharedNetworks6(const db::ServerSelector& server_selector) = 0;

    virtual uint64_t
    deleteOptionDef6(const db::ServerSelector& server_selector,
                     const uint16_t code,
                     const std::string& space) = 0;

    virtual uint64_t
    deleteAllOptionDefs6(const db::ServerSelector& server_selector) = 0;

    virtual uint64_t
    deleteOption6(const db::ServerSelector& server_selector,
                  const uint16_t code,
                  const std::string& space,
                  ClientClassesPtr client_classes = ClientClassesPtr()) = 0;

    virtual uint64_t
    deleteOption6(const db::ServerSelector& selector,
                  const std::string& shared_network_name,
                  const uint16_t code,
                  const std::string& space,
                  ClientClassesPtr client_classes = ClientClassesPtr()) = 0;

    virtual uint64_t
    deleteOption6(const db::ServerSelector& server_selector,
                  const SubnetID& subnet_id,
                  const uint16_t code,
                  const std::string& space,
                  ClientClassesPtr client_classes = ClientClassesPtr()) = 0;

    virtual uint64_t
    deleteOption6(const db::ServerSelector& server_selector,
                  const asiolink::IOAddress& pool_start_address,
                  const asiolink::IOAddress& pool_end_address,
                  const uint16_t code,
                  const std::string& space,
                  ClientClassesPtr client_classes = ClientClassesPtr()) = 0;

    virtual uint64_t
    deleteOption6(const db::ServerSelector& server_selector,
                  const asiolink::IOAddress& pd_pool_prefix,
                  const uint8_t pd_pool_prefix_length,
                  const uint16_t code,
                  const std::string& space,
                  ClientClassesPtr client_classes = ClientClassesPtr()) = 0;

    virtual uint64_t
    deleteGlobalParameter6(const db::ServerSelector& server_selector,
                           const std::string& name) = 0;

    virtual uint64_t
    deleteAllGlobalParameters6(const db::ServerSelector& server_selector) = 0;

    virtual uint64_t
    deleteClientClass6(const db::ServerSelector& server_selector,
                       const std::string& name) = 0;

    virtual uint64_t
    deleteAllClientClasses6(const db::ServerSelector& server_selector) = 0;

    virtual uint64_t
    deleteServer6(const data::ServerTag& server_tag) = 0;

    virtual uint64_t
    deleteAllServers6() = 0;
};

typedef boost::shared_ptr<ConfigBackendDHCPv6> ConfigBackendDHCPv6Ptr;
 
} // end of namespace isc::dhcp
} // end of namespace isc
 
#endif // CONFIG_BACKEND_DHCP6_H