Index management

[AlexRuiz7]

Description

The Index module of the Content Manager is responsible for managing the indices the plugin has access to, which are the content metadata index wazuh-content and the contexts' indices, named after them.

The module provided basic features for other modules to read and write data. It also takes care of preparing the indices, by creating them or creating index templates.

---
title: Content Manager - Index module
---
classDiagram
    direction RL
    namespace index {
        class ContextIndex{
            -string index
            +getAll()
            +get(context)
            +set(context)
            +create()
        }
        class ContentIndex{
            -string index
            +index(document)
            +patch(jsonPatch)
            +create()
        }
    }

Loading

Functional requirements

• On start, the Content Manager will initialize the internal index to manage the context's metadata.
• The Index module provides functionality to get all the contexts in the internal index.
• The Index module provides functionality to get a context.
• The index module provides functionality to update a context.

Implementation restrictions

• The content indices and the internal index are managed by different classes.
• Classes belong to the index Java module.

Plan

• Implement the management of the internal index for context metadata.
• Implement the management of the content indices.