audit_entry.h

Go to the documentation of this file.

// Copyright (C) 2019-2020 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 AUDIT_ENTRY_H
#define AUDIT_ENTRY_H

#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/multi_index/composite_key.hpp>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/hashed_index.hpp>
#include <boost/multi_index/mem_fun.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/shared_ptr.hpp>
#include <cstdint>
#include <string>

namespace isc {
namespace db {

class AuditEntry;

typedef boost::shared_ptr<AuditEntry> AuditEntryPtr;

class AuditEntry {
public:

    enum class ModificationType : uint8_t {
        CREATE = 0,
        UPDATE = 1,
        DELETE = 2
    };

    AuditEntry(const std::string& object_type,
               const uint64_t object_id,
               const ModificationType& modification_type,
               const boost::posix_time::ptime& modification_time,
               const uint64_t revision_id,
               const std::string& log_message);

    AuditEntry(const std::string& object_type,
               const uint64_t object_id,
               const ModificationType& modification_type,
               const uint64_t revision_id,
               const std::string& log_message);

    static AuditEntryPtr create(const std::string& object_type,
                                const uint64_t object_id,
                                const ModificationType& modification_type,
                                const boost::posix_time::ptime& modification_time,
                                const uint64_t revision_id,
                                const std::string& log_message);

    static AuditEntryPtr create(const std::string& object_type,
                                const uint64_t object_id,
                                const ModificationType& modification_type,
                                const uint64_t revision_id,
                                const std::string& log_message);

    std::string getObjectType() const {
        return (object_type_);
    }

    uint64_t getObjectId() const {
        return (object_id_);
    }

    ModificationType getModificationType() const {
        return (modification_type_);
    }

    boost::posix_time::ptime getModificationTime() const {
        return (modification_time_);
    }

    uint64_t getRevisionId() const {
        return (revision_id_);
    }

    std::string getLogMessage() const {
        return (log_message_);
    }

private:

    void validate() const;

    std::string object_type_;

    uint64_t object_id_;

    ModificationType modification_type_;

    boost::posix_time::ptime modification_time_;

    uint64_t revision_id_;

    std::string log_message_;
};

struct AuditEntryObjectTypeTag { };

struct AuditEntryModificationTimeIdTag { };

struct AuditEntryObjectIdTag { };

typedef boost::multi_index_container<
    // The container holds pointers to @c AuditEntry objects.
    AuditEntryPtr,
    // First index allows for accessing by the object type.
    boost::multi_index::indexed_by<
        boost::multi_index::ordered_non_unique<
            boost::multi_index::tag<AuditEntryObjectTypeTag>,
            boost::multi_index::composite_key<
                AuditEntry,
                boost::multi_index::const_mem_fun<
                    AuditEntry,
                    std::string,
                    &AuditEntry::getObjectType
                >,
                boost::multi_index::const_mem_fun<
                    AuditEntry,
                    AuditEntry::ModificationType,
                    &AuditEntry::getModificationType
                >
            >
        >,

        // Second index allows for accessing by the modification time and id.
        boost::multi_index::ordered_non_unique<
            boost::multi_index::tag<AuditEntryModificationTimeIdTag>,
            boost::multi_index::composite_key<
                AuditEntry,
                boost::multi_index::const_mem_fun<
                    AuditEntry,
                    boost::posix_time::ptime,
                    &AuditEntry::getModificationTime
                >,
                boost::multi_index::const_mem_fun<
                    AuditEntry,
                    uint64_t,
                    &AuditEntry::getRevisionId
                >
            >
        >,

        // Third index allows for accessing by the object id.
        boost::multi_index::hashed_non_unique<
            boost::multi_index::tag<AuditEntryObjectIdTag>,
            boost::multi_index::const_mem_fun<
                AuditEntry,
                uint64_t,
                &AuditEntry::getObjectId
            >
        >
    >
> AuditEntryCollection;

typedef boost::shared_ptr<AuditEntryCollection> AuditEntryCollectionPtr;

} // end of namespace isc::db
} // end of namespace isc

#endif