[#1177] Add ProtectedAtomDB and Atom::get_protection_mode()

src/atomdb/AtomDB.h

@@ -52,6 +52,7 @@ class AtomDB : public HandleDecoder {
 
     virtual bool allow_nested_indexing() = 0;
     virtual bool composite_type_enabled() const = 0;
+    virtual atomdb_api_types::ProtectionMode get_protection_mode() const = 0;
 
     virtual shared_ptr<Atom> get_atom(const string& handle) = 0;  // HandleDecoder interface
     virtual shared_ptr<Node> get_node(const string& handle) = 0;

src/atomdb/AtomDBAPITypes.h

@@ -120,5 +120,14 @@ class AccessPermissionDocument {
     }
 };
 
+/**
+ * @brief How an AtomDB participates in protected access.
+ *
+ * - UNPROTECTED: no authorization wrapper; open access.
+ * - PROTECTED: wrap and apply authorization post-processing (filter) after queries.
+ * - FORWARD: wrap and pass access keys through, but do not post-process locally
+ */
+enum class ProtectionMode { UNPROTECTED = 0, FORWARD, PROTECTED };
+
 }  // namespace atomdb_api_types
 }  // namespace atomdb

src/atomdb/AtomDBFactory.cc

@@ -3,6 +3,7 @@
 #include "AdapterDB.h"
 #include "InMemoryDB.h"
 #include "MorkDB.h"
+#include "ProtectedAtomDB.h"
 #include "RedisMongoDB.h"
 #include "RemoteAtomDB.h"
 #include "Utils.h"
@@ -103,6 +104,15 @@ shared_ptr<AtomDB> AtomDBFactory::create_composite_atomdb(const JsonConfig& conf
 }
 
 shared_ptr<AtomDB> AtomDBFactory::wrap_if_protected(shared_ptr<AtomDB> atomdb) {
-    // AtomDBFactory::wrap_if_protected() is not implemented yet.
-    return atomdb;
+    if (!atomdb) {
+        RAISE_ERROR("AtomDBFactory::wrap_if_protected() received null atomdb");
+    }
+    if (atomdb->get_protection_mode() == atomdb_api_types::ProtectionMode::UNPROTECTED ||
+        dynamic_pointer_cast<ProtectedAtomDB>(atomdb)) {
+        return atomdb;
+    }
+    // TODO: uncomment this return when the integration with ProtectedDB with authorization is complete
+    // return make_shared<ProtectedAtomDB>(atomdb);
+
+    RAISE_ERROR("Protected AtomDB support is not available");
 }

src/atomdb/AtomDBFactory.h

@@ -27,7 +27,8 @@ namespace atomdb {
 class AtomDBFactory {
    public:
     /**
-     * @brief Creates a AtomDB and wraps it with ProtectedAtomDB when is applyable.
+     * @brief Creates a AtomDB and wraps it with ProtectedAtomDB when mode is
+     * PROTECTED or FORWARD.
      */
     static shared_ptr<AtomDB> create(const JsonConfig& config, const string& context = "");
 
@@ -40,7 +41,7 @@ class AtomDBFactory {
                                                       const string& context = "");
 
     /**
-     * @brief Wraps an AtomDB with ProtectedAtomDB when protected and not already wrapped.
+     * @brief Wraps an AtomDB with ProtectedAtomDB when mode is PROTECTED or FORWARD.
      */
     static shared_ptr<AtomDB> wrap_if_protected(shared_ptr<AtomDB> atomdb);
 };

src/atomdb/BUILD

@@ -11,6 +11,12 @@ cc_library(
         ":atomdb_factory",
         ":atomdb_singleton",
         ":atomdbutils",
+        ":protected_atomdb",
+        "//atomdb/adapterdb:adapterdb_lib",
+        "//atomdb/inmemorydb:inmemorydb_lib",
+        "//atomdb/morkdb:morkdb_lib",
+        "//atomdb/redis_mongodb:redis_mongodb_lib",
+        "//atomdb/remotedb:remotedb_lib",
     ],
 )
 
@@ -21,6 +27,7 @@ cc_library(
     includes = ["."],
     deps = [
         ":atomdb",
+        ":protected_atomdb",
         "//atomdb/adapterdb:adapterdb_lib",
         "//atomdb/inmemorydb:inmemorydb_lib",
         "//atomdb/morkdb:morkdb_lib",
@@ -73,3 +80,16 @@ cc_library(
         "//commons:commons_lib",
     ],
 )
+
+cc_library(
+    name = "protected_atomdb",
+    srcs = ["ProtectedAtomDB.cc"],
+    hdrs = ["ProtectedAtomDB.h"],
+    includes = ["."],
+    deps = [
+        ":atomdb",
+        ":atomdb_api_types",
+        "//commons:commons_lib",
+        "//commons/atoms:atoms_lib",
+    ],
+)