7.11.2.7. Vitam Offer

7.11.2.7.1. Présentation

Parent package: fr.gouv.vitam.storage.offers
Package proposition: fr.gouv.vitam.storage.offers.workspace

Module embarquant l’offre de stockage Vitam utilisant une partie du workspace. Utilisation du terme worskpace dans les packages car le terme default est réservé.

L’offre de stockage workspace est séparé en deux parties :

  • le serveur de l’offre de stockage par défaut
  • l’implémentation du driver associé à l’offre de stockage par défaut

Dans l’offre, tout les objets binaires sont stockés dans des conteneur définis par : {type}_{tenant}. Un objet binaire est lui définit par son identifiant ET son conteneur.

7.11.2.7.2. Driver

Objet technique responsable d’établir une connexion avec le service de stockage en fonction des
paramètres qui lui sont fournis. C’est aussi lui qui est responsable de déterminer si le service est disponible ou non. La méthode connect, permet de récupérer un objet Connection afin de pouvoir effectuer des actions sur l’offre de stockage.

7.11.2.7.3. Serveur

7.11.2.7.3.1. Description

Les fonctionnalités sont :

  • récupérer la capacité et disponibilité de l’offre
  • envoyer un objet
  • récupérer un objet
  • tester l’existence d’un objet
  • récupérer l’empreinte d’un objet
  • compter le nombre d’objets d’un conteneur
  • contrôler un objet pour valider son transfert
  • supprimer un objet

7.11.2.7.3.2. REST

7.11.2.7.3.2.1. Description

L’API REST, trois header spécifiques sont définis :

  • X-Tenant-Id : l’identifiant du Tenant
  • X-Type : permets de préciser le résultat attendu pour la recupération de l’objet
    • DATA : l’objet en lui-même (valeur par défaut)
    • DIGEST : empreinte de l’objet

Les réponses en erreur définies par l’API Vitam sont respéctées (400, 401, 404, etc)

7.11.2.7.3.2.2. REST API

HEAD /

  • description : recupération des informations de l’offre
  • response :
    • code : 200
    • contenu : information sur l’offre (capacité, disponibilité, …)

GET /count/{type}/

  • description : compter le nombre d’objet d’un conteneur de l’offre
  • headers :
    • X-Tenant-Id: id du tenant
  • path :
    • {type} : le type permettant d’identifier un conteneur (unit/report/logbook/etc, se basant sur une enum)
  • response :
    • code : 200
    • contenu : le nombre d’objets binaires (hors répertoires)

GET /objects/{id}

  • description : recupération sur l’offre d’un objet ou de son empreinte
  • headers :
    • X-Type: DATA / DIGEST
    • X-Tenant-Id: id du tenant
  • path :
    • {id} : path de l’objet
  • response :
    • code : 200
    • contenu : data ou empreinte de l’objet

GET /objects/{type}/{id:.+}/check

  • description : vérification d’un objet
  • headers :
    • X-Type: DATA / DIGEST
    • X-Tenant-Id: id du tenant
  • path :
    • {id} : path de l’objet
    • {type} : le type permettant d’identifier un conteneur (unit/report/logbook/etc, se basant sur une enum)
  • response :
    • code : 200
    • contenu : un boolean indiquant si le digest de l’objet correspond ou non

PUT /objects/{type}/{id}

  • description : écriture d’un objet sur l’offre
  • headers :
    • X-Tenant-Id: id du tenant
    • Vitam-Content-Length: Taille de l’objet
    • X-digest-algorithm: Algorithme de hash utilisé pour vérifier l’empreinte de l’objet
  • path :
    • {id} : id de l’objet
    • {type} : le type (unit/objectgroup/logbook/etc, se basant sur une enum)
  • body :
    • flux : data ou digest
  • response :
    • code : 201
    • contenu : un json avec le digest de l’objet et sa taille.

HEAD /objects/{id}

  • description : existance de l’objet sur l’offre
  • headers :
    • X-Tenant-Id: id du tenant
  • path :
    • {id} : id de l’objet
  • response :
    • code : 204

DELETE /objects/{type}/{id}

  • description : suppression d’un objet de l’offre
  • headers :
    • X-Tenant-Id: id du tenant
    • X-Type: DATA / DIGEST
  • path :
    • {id} : id de l’objet
    • {type} : le type permettant d’identifier un conteneur (unit/report/logbook/etc, se basant sur une enum)
  • response :
    • code : 200
    • contenu : l’id de l’objet supprimé + le statut

GET /status

  • description : état du serveur
  • reponse :
    • code : 200
    • contenu : statut