store: Added public functions to create and execute matchers.

[sysdb.git] / src / include / core / store.h

diff --git a/src/include/core/store.h b/src/include/core/store.h
index 5558e77154f32f00e9d59edf75ea3d1f0a014119..a327ae9d31ebd31744e4ce6d9d0786b0d183ae29 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
@@ -30,6 +30,7 @@
 
 #include "sysdb.h"
 #include "core/object.h"
+#include "core/data.h"
 #include "core/time.h"
 #include "utils/llist.h"
 #include "utils/strbuf.h"
@@ -48,6 +49,13 @@ extern "C" {
 struct sdb_store_base;
 typedef struct sdb_store_base sdb_store_base_t;
 
+/*
+ * sdb_store_clear:
+ * Clear the entire store and remove all stored objects.
+ */
+void
+sdb_store_clear(void);
+
 /*
  * sdb_store_host:
  * Add/update a host in the store. If the host, identified by its
@@ -65,9 +73,20 @@ typedef struct sdb_store_base sdb_store_base_t;
 int
 sdb_store_host(const char *name, sdb_time_t last_update);
 
+/*
+ * sdb_store_has_host:
+ * sdb_store_get_host:
+ * Query the store for a host by its (canonicalized) name.
+ *
+ * sdb_store_get_host increments the ref count of the host object. The caller
+ * needs to deref it when no longer using it.
+ */
 _Bool
 sdb_store_has_host(const char *name);
 
+sdb_store_base_t *
+sdb_store_get_host(const char *name);
+
 /*
  * sdb_store_attribute:
  * Add/update a host's attribute in the store. If the attribute, identified by
@@ -84,7 +103,8 @@ sdb_store_has_host(const char *name);
  *  - a negative value on error
  */
 int
-sdb_store_attribute(const char *hostname, const char *key, const char *value,
+sdb_store_attribute(const char *hostname,
+               const char *key, const sdb_data_t *value,
                sdb_time_t last_update);
 
 /*
@@ -107,6 +127,70 @@ int
 sdb_store_service(const char *hostname, const char *name,
                sdb_time_t last_update);
 
+/*
+ * Store matchers may be used to lookup objects from the host based on their
+ * various attributes. Each type of matcher evaluates attributes of the
+ * respective object type.
+ *
+ * For each matcher object, *all* specified attributes have to match.
+ *
+ * A store matcher object inherits from sdb_object_t and, thus, may safely be
+ * cast to a generic object.
+ */
+struct sdb_store_matcher;
+typedef struct sdb_store_matcher sdb_store_matcher_t;
+
+/*
+ * sdb_store_attr_matcher:
+ * Creates a matcher matching attributes based on their name or value. Either
+ * a complete name (which will have to match completely but case-independent)
+ * or an extended POSIX regular expression may be specified.
+ */
+sdb_store_matcher_t *
+sdb_store_attr_matcher(const char *attr_name, const char *attr_name_re,
+               const char *attr_value, const char *attr_value_re);
+
+/*
+ * sdb_store_service_matcher:
+ * Creates a matcher matching services based on their name or attributes.
+ */
+sdb_store_matcher_t *
+sdb_store_service_matcher(const char *service_name, const char *service_name_re,
+               sdb_store_matcher_t *attr_matcher);
+
+/*
+ * sdb_store_host_matcher:
+ * Creates a matcher matching hosts based on their name, services assigned to
+ * the host, or its attributes.
+ */
+sdb_store_matcher_t *
+sdb_store_host_matcher(const char *host_name, const char *host_name_re,
+               sdb_store_matcher_t *service_matcher,
+               sdb_store_matcher_t *attr_matcher);
+
+/*
+ * sdb_store_matcher_matches:
+ * Check whether the specified matcher matches the specified store object.
+ *
+ * Returns:
+ *  - 0 if the object matches
+ *  - a negative value else
+ */
+int
+sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_base_t *obj);
+
+/*
+ * Flags for serialization functions.
+ *
+ * By default, the full object will be included in the serialized output. When
+ * specifying any of the flags, the respective information will be left out.
+ */
+enum {
+       SDB_SKIP_ATTRIBUTES         = 1 << 0,
+       SDB_SKIP_SERVICES           = 1 << 1,
+       SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 2,
+};
+
 /*
  * sdb_store_tojson:
  * Serialize the entire store to JSON and append the result to the specified
@@ -117,7 +201,19 @@ sdb_store_service(const char *hostname, const char *name,
  *  - a negative value on error
  */
 int
-sdb_store_tojson(sdb_strbuf_t *buf);
+sdb_store_tojson(sdb_strbuf_t *buf, int flags);
+
+/*
+ * sdb_store_host_tojson:
+ * Serialize a host object to JSON and append the result to the specified
+ * buffer.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value on error
+ */
+int
+sdb_store_host_tojson(sdb_store_base_t *host, sdb_strbuf_t *buf, int flags);
 
 #ifdef __cplusplus
 } /* extern "C" */