cql_lease_mgr.h

Go to the documentation of this file.

// Copyright (C) 2018-2021 Internet Systems Consortium, Inc. ("ISC")
// Copyright (C) 2015-2018 Deutsche Telekom AG.
//
// Authors: Razvan Becheriu <razvan.becheriu@qualitance.com>
//          Andrei Pavel <andrei.pavel@qualitance.com>
//
// 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 CQL_LEASE_MGR_H
#define CQL_LEASE_MGR_H

#include <cql/cql_connection.h>
#include <cql/cql_exchange.h>
#include <dhcp/hwaddr.h>
#include <dhcpsrv/dhcpsrv_exceptions.h>
#include <dhcpsrv/lease_mgr.h>

#include <boost/scoped_ptr.hpp>

#include <string>
#include <utility>
#include <vector>

namespace isc {
namespace dhcp {

class CqlLeaseMgr : public LeaseMgr {
public:

    explicit CqlLeaseMgr(const db::DatabaseConnection::ParameterMap& parameters);

    virtual ~CqlLeaseMgr();

    static std::string getDBVersion();

    virtual bool addLease(const Lease4Ptr& lease) override;

    virtual bool addLease(const Lease6Ptr& lease) override;


    virtual Lease4Ptr
    getLease4(const isc::asiolink::IOAddress& addr) const override;

    virtual Lease4Collection
    getLease4(const isc::dhcp::HWAddr& hwaddr) const override;

    virtual Lease4Ptr getLease4(const isc::dhcp::HWAddr& hwaddr,
                                SubnetID subnet_id) const override;

    virtual Lease4Collection getLease4(const ClientId& clientid) const override;

    virtual Lease4Ptr getLease4(const ClientId& clientid,
                                SubnetID subnet_id) const override;

    virtual Lease4Collection getLeases4(SubnetID subnet_id) const override;

    virtual Lease4Collection getLeases4(const std::string& hostname) const override;

    virtual Lease4Collection getLeases4() const override;

    virtual Lease4Collection
    getLeases4(const asiolink::IOAddress& lower_bound_address,
               const LeasePageSize& page_size) const override;

    virtual Lease6Ptr
    getLease6(Lease::Type type,
              const isc::asiolink::IOAddress& addr) const override;

    virtual Lease6Collection getLeases6(Lease::Type type,
                                        const DUID& duid,
                                        uint32_t iaid) const override;

    virtual Lease6Collection getLeases6(Lease::Type type,
                                        const DUID& duid,
                                        uint32_t iaid,
                                        SubnetID subnet_id) const override;

    virtual Lease6Collection getLeases6(SubnetID subnet_id) const override;

    virtual Lease6Collection getLeases6(const std::string& hostname) const override;

    virtual Lease6Collection getLeases6() const override;

    virtual Lease6Collection getLeases6(const DUID& duid) const override;

    virtual Lease6Collection
    getLeases6(const asiolink::IOAddress& lower_bound_address,
               const LeasePageSize& page_size) const override;

    virtual void getExpiredLeases4(Lease4Collection& expired_leases,
                                   const size_t max_leases) const override;

    virtual void getExpiredLeases6(Lease6Collection& expired_leases,
                                   const size_t max_leases) const override;

    virtual void updateLease4(const Lease4Ptr& lease4) override;


    virtual void updateLease6(const Lease6Ptr& lease6) override;

    bool deleteLease(const Lease4Ptr& lease) override final;

    bool deleteLease(const Lease6Ptr& lease) override final;

    virtual uint64_t
    deleteExpiredReclaimedLeases4(const uint32_t secs) override;

    virtual uint64_t
    deleteExpiredReclaimedLeases6(const uint32_t secs) override;

    virtual LeaseStatsQueryPtr startLeaseStatsQuery4() override;

    virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery4(const SubnetID& subnet_id) override;

    virtual LeaseStatsQueryPtr startSubnetRangeLeaseStatsQuery4(const SubnetID& first_subnet_id,
                                                                const SubnetID& last_subnet_id) override;
    virtual LeaseStatsQueryPtr startLeaseStatsQuery6() override;

    virtual LeaseStatsQueryPtr startSubnetLeaseStatsQuery6(const SubnetID& subnet_id) override;

    virtual LeaseStatsQueryPtr startSubnetRangeLeaseStatsQuery6(const SubnetID& first_subnet_id,
                                                                const SubnetID& last_subnet_id) override;
    virtual size_t wipeLeases4(const SubnetID& subnet_id) override;

    virtual size_t wipeLeases6(const SubnetID& subnet_id) override;

    virtual std::string getType() const override {
        return (std::string("cql"));
    }

    virtual std::string getName() const override;

    virtual std::string getDescription() const override;

    virtual VersionPair getVersion() const override;

    virtual void commit() override;

    virtual void rollback() override;

private:

    db::DatabaseConnection::ParameterMap parameters_;

    mutable db::CqlConnection dbconn_;
};

}  // namespace dhcp
}  // namespace isc

#endif  // CQL_LEASE_MGR_H