config_backend_dhcp4.h

Go to the documentation of this file.

// Copyright (C) 2018-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_DHCP4_H
#define CONFIG_BACKEND_DHCP4_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 ConfigBackendDHCPv4 : public cb::BaseConfigBackend {
public:

    virtual ~ConfigBackendDHCPv4() { }

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

    virtual Subnet4Ptr
    getSubnet4(const db::ServerSelector& server_selector, const SubnetID& subnet_id) const = 0;

    virtual Subnet4Collection
    getAllSubnets4(const db::ServerSelector& server_selector) const = 0;

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

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

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

    virtual SharedNetwork4Collection
    getAllSharedNetworks4(const db::ServerSelector& server_selector) const = 0;

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

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

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

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

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

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

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

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

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

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

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

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

    virtual ClientClassDictionary
    getModifiedClientClasses4(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
    getAllServers4() const = 0;

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

    virtual void
    createUpdateSubnet4(const db::ServerSelector& server_selector,
                        const Subnet4Ptr& subnet) = 0;

    virtual void
    createUpdateSharedNetwork4(const db::ServerSelector& server_selector,
                               const SharedNetwork4Ptr& shared_network) = 0;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    virtual uint64_t
    deleteOption4(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
    deleteOption4(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
    deleteOption4(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
    deleteGlobalParameter4(const db::ServerSelector& server_selector,
                           const std::string& name) = 0;

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

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

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

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

    virtual uint64_t
    deleteAllServers4() = 0;
};

typedef boost::shared_ptr<ConfigBackendDHCPv4> ConfigBackendDHCPv4Ptr;
 
} // end of namespace isc::dhcp
} // end of namespace isc
 
#endif // CONFIG_BACKEND_DHCP4_H