Worker¶
Présentation¶
4 modules composent la partie worker : - worker-common : incluant la partie common (Utilitaires…), notamment le SedaUtils. - worker-core : contenant les différents handlers. - worker-client : incluant le client permettant d’appeler le REST. - worker-server : incluant la partie REST.
Worker-server¶
Rest API¶
Pour l’instant les uri suivantes sont déclarées :
Registration¶
Une partie registration permet de gérer la registration du Worker.
La gestion de l’abonnement du worker auprès du serveur processing se fait à l’aide d’un ServletContextListener : fr.gouv.vitam.worker.server.registration.WorkerRegistrationListener.
Le WorkerRegistrationListener va lancer l’enregistrement du worker au démarrage du serveur worker, dans un autre Thread utilisant l’instance Runnable : fr.gouv.vitam.worker.server.registration.WorkerRegister.
L’execution du WorkerRegister essaie d’enregistrer le worker suivant un retry paramétrable dans la configuration du serveur avec :
- un délai (registerDelay en secondes)
- un nombre d’essai (registerTry)
Le lancement du serveur est indépendant de l’enregistrement du worker auprès du processing : le serveur worker ne s’arrêtera pas si l’enregistrement n’a pas réussi.
Configuration de worker¶
Cela présente la configuration pour un worker quand il est déployé. Deux paramètres importants quand le worker fonctionne en mode parallèle.
WorkerCapacity :
Cela présente la capacité d’un worker qui réponds au demande de parallélisation de la distribution de tâches du workflow. Il est précisé par le paramètre capacity dans le WorkerConfiguration.
WorkerFamily :
Chaque worker est configuré pour traiter groupe de tâches corresponsant à ses fonctions et on cela permetre de définir les familles de worker. Il est précisé par workerFamily dans le WorkerConfigration.
WorkerBean¶
présente l’information complète sur un worker pour la procédure d’enregistrement d’un worker. Il contient les information sur le nom, la famille et la capacité … d’un worker et présente en mode json. Voici un example :
{ "name" : "workername", "family" : "DefaultWorker", "capacity" : 10, "storage" : 100,
"status" : "Active", "configuration" : {"serverHost" : "localhost", "serverPort" : 12345 } }
Persistence des workers¶
La lise de workers est persistée dans une base de données. Pour le moment, la base est un fichier de données qui contient une tableau de workers en format ArrayNode et chaque worker est une élément JsonNode. Exemple ci-dessous est des données d’une liste de workers
[
{"workerId": "workerId1", "workerinfo": { "name" : "workername", "family" : "DefaultWorker", "capacity" : 10, "storage" : 100,
"status" : "Active", "configuration" : {"serverHost" : "localhost", "serverPort" : 12345 }}},
{"workerId": "workerId2", "workerinfo": { "name" : "workername2", "family" : "BigWorker", "capacity" : 10, "storage" : 100,
"status" : "Active", "configuration" : {"serverHost" : "localhost", "serverPort" : 54321 } }}
]
Le fichier nommé « worker.db » qui sera créé dans le répertoire /vitam/data/processing
.
Chaque worker est identifié par workerId et l’information générale du champs workerInfo. L’ensemble des actions suivantes sont traitées :
- Lors du redémarrage du distributor, il recharge la liste des workers enregistrés. Ensuite, il vérifie le status de chaque worker de la liste,
(serverPort:serverHost) en utilisant le WorkerClient. Si le worker qui n’est pas disponible, il sera supprimé de la liste des workers enregistrés et la base sera mise à jour.
- Lors de l’enregistrement/désenregistrement, la liste des workers enregistrés sera mis à jour (ajout/supression d’un worker).
checkStatusWorker(String serverHost, int serverPort) // vérifier le statut d'un worker
marshallToDB() // mise à jour la base de la liste des workers enregistrés
Désenregistrement d’un worker¶
Lorsque le worker s’arrête ou se plante, ce worker doit être désenregistré.
- Si le worker s’arrête, la demande de désenregistrement sera lancé pour le contexte « contextDestroyed » de la WorkerRegistrationListener (implémenté de ServletContextListener) en utilisant le ProcessingManagementClient pour appeler le service de desenregistrement de distributeur.
- Si le worker se plante, il ne réponse plus aux requêtes de WorkerClient dans la « run() » WorkerThread et dans le catch() des exceptions de de traitement,
une demande de désenregistrement doit être appelé dans cette boucle.
- le distributeur essaie de faire une vérification de status de workers en appelant checkStatusWorker() en plusieurs fois définit dans GlobalDataRest.STATUS_CHECK_RETRY).
- si après l’étape 1 le statut de worker est toujours indisponible, le distributeur va appeler la procédure de désenregistrement de ce worker de la liste de worker enregistrés.
Worker-core¶
Dans la partie Core, sont présents les différents Handlers nécessaires pour exécuter les différentes actions.
- CheckConformityActionHandler
- CheckObjectsNumberActionHandler
- CheckObjectUnitConsistencyActionHandler
- CheckSedaActionHandler
- CheckStorageAvailabilityActionHandler
- CheckVersionActionHandler
- ExtractSedaActionHandler
- CheckIngestContractActionHandler
- IndexObjectGroupActionHandler
- IndexUnitActionHandler
- StoreObjectGroupActionHandler
- FormatIdentificationActionHandler
- AccessionRegisterActionHandler
- TransferNotificationActionHandler
- UnitsRulesCompteHandler
- DummyHandler
Plugins Worker : les plugins proposent des actions comme les Handler. Quand le service worker démarré, les plugins et leur fichier properties sont chargés. Les actions sont cherché d’abord dans le plugin pour le traitement, si l’action ne trouve pas dans plugin, il sera appelé dans le Handler correspondant.
- CheckConfirmityActionPlugin : pour la vérification de la conformité de document
- FormatIdentificationActionPlugin : pour le vérification de formats de fichiers
- StoreObjectGroupActionPlugin : pour le storage des groupes d’objets
- UnitsRulesComputeActionPlugin : pour la gestion de règles de gestion
- IndexUnitActionPlugin : pour indexer des unités archivistes
- IndexObjectGroupActionPlugin : pour indexer des groupes d’objets
- ArchiveUnitRulesUpdateActionPlugin : mise à jour des unités archivisitiques
- RunningIngestsUpdateActionPlugin : mise à jour des ingests en cours
La classe WorkerImpl permet de lancer ces différents handlers.
Focus sur la gestion des entrées / sorties des Handlers¶
Chaque Handler a un constructeur sans argument et est lancé avec la commande :
CompositeItemStatus execute(WorkerParameters params, HandlerIO ioParam).
..
Le HandlerIO a pour charge d’assurer la liaison avec le Workspace et la mémoire entre tous les handlers d’un step.
La structuration du HandlerIO est la suivante :
des paramètres d’entrées (in) :
un nom (name) utilisé pour référencer cet élément entre différents handlers d’une même étape
une cible (uri) comportant un schema (WORKSPACE, MEMORY, VALUE) et un path :
- WORKSPACE:path indique le chemin relatif sur le workspace
- MEMORY:path indique le nom de la clef de valeur
- VALUE:path indique la valeur statique en entrée
chaque handler peut accéder à ces valeurs, définies dans l’ordre stricte, via le handlerIO
- WORKSPACE : implicitement un File
File file = handlerIO.getInput(rank);
..
- MEMORY : implicitement un objet mémoire déjà alloué par un Handler précédent
// Object could be whatever, Map, List, JsonNode or even File
Object object = handlerIO.getInput(rank);
..
- VALUE : implicitement une valeur String
String string = handlerIO.getInput(rank);
..
des paramètres d’entrées (out) :
un nom (name) utilisé pour référencer cet élément entre différents handlers d’une même étape
une cible (uri) comportant un schema (WORKSPACE, MEMORY) et un path :
- WORKSPACE:path indique le chemin relatif sur le workspace
- MEMORY:path indique le nom de la clef de valeur
chaque handler peut stocker les valeurs finales, définies dans l’ordre stricte, via le handlerIO
- WORKSPACE : implicitement un File local
// To get the filename as specified by the workflow
ProcessingUri uri = handlerIO.getOutput(rank);
String filename = uri.getPath();
// Write your own file
File newFile = handlerIO.getNewLocalFile(filename);
// write it
...
// Now give it back to handlerIO as ouput result,
// specifying if you want to delete it right after or not
handlerIO.addOuputResult(rank, newFile, true);
// or let the handlerIO delete it later on
handlerIO.addOuputResult(rank, newFile);
..
- MEMORY : implicitement un objet mémoire
// Create your own Object
MyClass object = ...
// Now give it back to handlerIO as ouput result
handlerIO.addOuputResult(rank, object);
..
Afin de vérifier la cohérence entre ce qu’attend le Handler et ce que contient le HandlerIO, la méthode suivante est à réaliser :
List<Class<?>> clasz = new ArrayList<>();
// add in order the Class type of each Input argument
clasz.add(File.class);
clasz.add(String.class);
// Then check the conformity passing the number of output parameters too
boolean check = handlerIO.checkHandlerIO(outputNumber, clasz);
// According to the check boolean, continue or raise an error
..
Cas particulier des Tests unitaires¶
Afin d’avoir un handlerIO correctement initialisé, il faut redéfinir le handlerIO manuellement comme l’attend le handler :
// In a common part (@Before for instance)
HandlerIO handlerIO = new HandlerIO("containerName", "workerid");
List<IOParameter> out = new ArrayList<>();
out.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.WORKSPACE, "UnitsLevel/ingestLevelStack.json")));
out.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.WORKSPACE, "Maps/DATA_OBJECT_TO_OBJECT_GROUP_ID_MAP.json")));
out.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.WORKSPACE, "Maps/DATA_OBJECT_ID_TO_GUID_MAP.json")));
out.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.WORKSPACE, "Maps/OBJECT_GROUP_ID_TO_GUID_MAP.json")));
out.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.WORKSPACE, "Maps/OG_TO_ARCHIVE_ID_MAP.json")));
out.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.WORKSPACE, "Maps/DATA_OBJECT_ID_TO_DATA_OBJECT_DETAIL_MAP.json")));
out.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.WORKSPACE, "Maps/ARCHIVE_ID_TO_GUID_MAP.json")));
out.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.WORKSPACE, "ATR/globalSEDAParameters.json")));
// Dans un bloc @After, afin de nettoyer les dossiers
@After
public void aftertest() {
handlerIO.close();
}
// Pour chaque test
@Test
public void test() {
handlerIO.addOutIOParameters(out);
...
}
Si nécessaire et si compatible, il est possible de passer par un mode MEMORY pour les paramètres « in » :
// In a common part (@Before for instance)
HandlerIO handlerIO = new HandlerIO("containerName", "workerid");
// Declare the signature in but instead of using WORKSPACE, use MEMORY
List<IOParameter> in = new ArrayList<>();
in.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.MEMORY, "file1")));
in.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.MEMORY, "file2")));
in.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.MEMORY, "file3")));
in.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.MEMORY, "file4")));
// Dans un bloc @After, afin de nettoyer les dossiers
@After
public void aftertest() {
handlerIO.close();
}
// Pour chaque test
@Test
public void test() {
// Use it first as Out parameters
handlerIO.addOutIOParameters(in);
// Initialize the real value in MEMORY using those out parameters from Resource Files
handlerIO.addOuputResult(0, PropertiesUtils.getResourceFile(ARCHIVE_ID_TO_GUID_MAP));
handlerIO.addOuputResult(1, PropertiesUtils.getResourceFile(OBJECT_GROUP_ID_TO_GUID_MAP));
handlerIO.addOuputResult(2, PropertiesUtils.getResourceFile(DO_TO_DO_INFO_MAP));
handlerIO.addOuputResult(3, PropertiesUtils.getResourceFile(ATR_GLOBAL_SEDA_PARAMETERS));
// Reset the handlerIo in order to remove all In and Out parameters
handlerIO.reset();
// And now declares the In parameter list, that will use the MEMORY default values
handlerIO.addInIOParameters(in);
...
}
// If necessary, delcares real OUT parameters too there
List<IOParameter> out = new ArrayList<>();
out.add(new IOParameter().setUri(new ProcessingUri(UriPrefix.WORKSPACE, "file5")));
handlerIO.addOutIOParameters(out);
// Now handler will have access to in parameter as File as if they were coming from Workspace
Création d’un nouveau handler¶
La création d’un nouveaux handler doit être motivée par certaines conditions nécessaires :
- lorsque qu’il n’y a pas de handler qui répond au besoin
- lorsque rajouter la fonctionnalité dans un handler existant, le surcharge et le détourne de sa fonctionalité première
- lorsque l’on veut refactorer un handler existant pour donner des fonctionalités “un peu” plus “élémentaires”
Les handlers doivent étendrent la classe ActionHandler et implémenter la méthode execute. Lors de la création d’un nouveau handler, il faut ajouter une nouvelle instance, dans WorkerImpl.init pour enregistrer le handler dans le worker et définir le handler id. Celui-ci sert de clé pour :
- les messages dans logbook (vitam-logbook-messages_fr.properties) en fonction de la criticité
- les fichiers json de définition des workflows json (exemple : DefaultIngestWorkflow.json)
cf. workflow
Details des Handlers¶
Détail du handler : CheckConformityActionHandler¶
Description¶
Ce handler permet de contrôle de l’empreinte. Il comprend désormais 2 tâches :
– Vérification de l’empreinte par rapport à l’empreinte indiquée dans le manifeste (en utilisant algorithme déclaré dans manifeste) – Calcul d’une empreinte en SHA-512 si l’empreinte du manifeste est calculée avec un algorithme différent
Exécution¶
CheckConformityActionHandler recupère l’algorithme de Vitam (SHA-512) par l’input dans workflow et le fichier en InputStream par le workspace.
Si l’algorithme est différent que celui dans le manifest, il calcul l’empreinte de fichier en SHA-512
DigestType digestTypeInput = DigestType.fromValue((String) handlerIO.getInput().get(ALGO_RANK));
response = handlerIO.getInputStreamNoCachedFromWorkspace(
IngestWorkflowConstants.SEDA_FOLDER + "/" + binaryObject.getUri());
InputStream inputStream = (InputStream) response.getEntity();
final Digest vitamDigest = new Digest(digestTypeInput);
Digest manifestDigest;
boolean isVitamDigest = false;
if (!binaryObject.getAlgo().equals(digestTypeInput)) {
manifestDigest = new Digest(binaryObject.getAlgo());
inputStream = manifestDigest.getDigestInputStream(inputStream);
} else {
manifestDigest = vitamDigest;
isVitamDigest = true;
}
......................
Si les empreintes sont différents, c’est le cas KO. Le message { « MessageDigest »: « value », « Algorithm »: « algo », « ComputedMessageDigest »: « value »} va être stocké dans le journal Sinon le message { « MessageDigest »: « value », « Algorithm »: « algo », « SystemMessageDigest »: « value », « SystemAlgorithm »: « algo »} va être stocké dans le journal Mais il y a encore deux cas à ce moment:
si l’empreinte est avec l’algorithme SHA-512, c’est le cas OK. sinon, c’est le cas WARNING. le nouveau empreint et son algorithme seront mis à jour dans la collection ObjectGroup.
CheckConformityActionHandler compte aussi le nombre de OK, KO et WARNING. Si nombre de KO est plus de 0, l’action est KO.
4.1.3 journalisation¶
logbook lifecycle¶
CA 1 : Vérification de la conformité de l’empreinte. (empreinte en SHA-512 dans le manifeste)
Dans le processus d’entrée, l’étape de vérification de la conformité de l’empreinte doit être appelée en position 450. Lorsque l’étape débute, pour chaque objet du groupe d’objet technique, une vérification d’empreinte doit être effectuée (celle de l’objet avec celle inscrite dans le manifeste SEDA). Cette étape est déjà existante actuellement. Le calcul d’empreinte en SHA-512 (CA 2) ne doit pas s’effectuer si l’empreinte renseigné dans le manifeste a été calculé en SHA-512. C’est cette empreinte qui sera indexée dans les bases Vitam.
CA 1.1 : Vérification de la conformité de l’empreinte. (empreinte en SHA-512 dans le manifeste) - OK
- Lorsque l’action est OK, elle inscrit une ligne dans les journaux du cycle de vie des GOT :
- eventType EN – FR : « Digest Check», « Vérification de l’empreinte des objets»
- outcome : « OK »
- outcomeDetailMessage FR : « Succès de la vérification de l’empreinte »
- eventDetailData FR : « Empreinte : <MessageDigest>, algorithme : <MessageDigest attribut algorithm> »
- objectIdentifierIncome : MessageIdentifier du manifest
Comportement du workflow décrit dans l’US #680
- La collection ObjectGroup est aussi mis à jour, en particulier le champs : Message Digest : { empreinte, algorithme utlisé }
CA 1.2 : Vérification de la conformité de l’empreinte. (empreinte en SHA-512 dans le manifeste) - KO
- Lorsque l’action est KO, elle inscrit une ligne dans les journaux du cycle de vie des GOT :
- eventType EN – FR : « Digest Check», « Vérification de l’empreinte des objets»
- outcome : « KO »
- outcomeDetailMessage FR : « Échec de la vérification de l’empreinte »
- eventDetailData FR : « Empreinte manifeste : <MessageDigest>, algorithme : <MessageDigest attribut algorithm> Empreinte calculée : <Empreinte calculée par Vitam> »
- objectIdentifierIncome : MessageIdentifier du manifest
Comportement du workflow décrit dans l’US #680
CA 2 : Vérification de la conformité de l’empreinte. (empreinte différent de SHA-512 dans le manifeste)
Si l’empreinte proposé dans le manifeste SEDA n’est pas en SHA-512, alors le système doit calculer l’empreinte en SHA-512. C’est cette empreinte qui sera indexée dans les bases Vitam. Lorsque l’action débute, pour chaque objet du groupe d’objet technique, un calcul d’empreinte au format SHA-512 doit être effectué. Cette action intervient juste apres le check de l’empreinte dans le manifeste (mais on est toujours dans l’étape du check conformité de l’empreinte).
CA 2.1 : Vérification de la conformité de l’empreinte. (empreinte différent de SHA-512 dans le manifeste) - OK
- Lorsque l’action est OK, elle inscrit une ligne dans les journaux du cycle de vie des GOT :
- eventType EN – FR : « Digest Check», « Vérification de l’empreinte des objets»
- outcome : « OK »
- outcomeDetailMessage FR : « Succès de la vérification de l’empreinte »
- eventDetailData FR : « Empreinte Manifeste : <MessageDigest>, algorithme : <MessageDigest attribut algorithm> » « Empreinte calculée (<algorithme utilisé « XXX »>): <Empreinte calculée par Vitam> »
- objectIdentifierIncome : MessageIdentifier du manifest
modules utilisés¶
processing, worker, workspace et logbook
cas d’erreur¶
XMLStreamException : problème de lecture SEDA InvalidParseOperationException : problème de parsing du SEDA LogbookClientAlreadyExistsException : un logbook client existe dans ce workflow LogbookClientBadRequestException : LogbookLifeCycleObjectGroupParameters est mal paramétré et le logbook client génère une mauvaise requete LogbookClientException : Erreur générique de logbook. LogbookException classe mère des autres exceptions LogbookClient LogbookClientNotFoundException : un logbook client n’existe pas pour ce workflow LogbookClientServerException : logbook server a un internal error ProcessingException : erreur générique du processing ContentAddressableStorageException : erreur de stockage
Détail du handler : CheckObjectsNumberActionHandler¶
description¶
Ce handler permet de comparer le nombre d’objet stocké sur le workspace et le nombre d’objets déclaré dans le manifest.
Détail du handler : CheckObjectUnitConsistencyActionHandler¶
Ce handler permet de contrôler la cohérence entre l’object/object group et l’ArchiveUnit.
Pour ce but, on détecte les groupes d’object qui ne sont pas référé par au moins d’un ArchiveUnit. Ce tache prend deux maps de données qui ont été crée dans l’étape précédente de workflow comme input : objectGroupIdToUnitId objectGroupIdToGuid Le ouput de cette contrôle est une liste de groupe d’objects invalide. Si on trouve les groupe d’objects invalide, le logbook lifecycles de group d’object sera mis à jour.
L’exécution de l’algorithme est présenté dans le code suivant :*
while (it.hasNext()) {
final Map.Entry<String, Object> objectGroup = it.next();
if (!objectGroupToUnitStoredMap.containsKey(objectGroup.getKey())) {
itemStatus.increment(StatusCode.KO);
try {
// Update logbook OG lifecycle
final LogbookLifeCycleObjectGroupParameters logbookLifecycleObjectGroupParameters =
LogbookParametersFactory.newLogbookLifeCycleObjectGroupParameters();
LogbookLifecycleWorkerHelper.updateLifeCycleStartStep(handlerIO.getHelper(),
logbookLifecycleObjectGroupParameters,
params, HANDLER_ID, LogbookTypeProcess.INGEST,
objectGroupToGuidStoredMap.get(objectGroup.getKey()).toString());
logbookLifecycleObjectGroupParameters.setFinalStatus(HANDLER_ID, null, StatusCode.KO,
null);
handlerIO.getHelper().updateDelegate(logbookLifecycleObjectGroupParameters);
final String objectID =
logbookLifecycleObjectGroupParameters.getParameterValue(LogbookParameterName.objectIdentifier);
handlerIO.getLifecyclesClient().bulkUpdateObjectGroup(params.getContainerName(),
handlerIO.getHelper().removeUpdateDelegate(objectID));
} catch (LogbookClientBadRequestException | LogbookClientNotFoundException |
LogbookClientServerException | ProcessingException e) {
LOGGER.error("Can not update logbook lifcycle", e);
}
ogList.add(objectGroup.getKey());
} else {
itemStatus.increment(StatusCode.OK);
// Update logbook OG lifecycle
....
}
}
Détail du handler : CheckSedaActionHandler¶
Ce handler permet de valider la validité du manifest par rapport à un schéma XSD. Il permet aussi de vérifier que les informations remplies dans ce manifest sont correctes.
- Le schéma de validation du manifest : src/main/resources/seda-vitam-2.0-main.xsd.
Détail du handler : CheckStorageAvailabilityActionHandler¶
TODO
Détail du handler : CheckVersionActionHandler¶
TODO
Détail du handler : ExtractSedaActionHandler¶
description¶
Ce handler permet d’extraire le contenu du SEDA. Il y a :
- extraction des BinaryDataObject et PhysicalDataObject
- extraction des ArchiveUnit
- création des lifes cycles des units
- construction de l’arbre des units et sauvegarde sur le workspace
- sauvegarde de la map des units sur le workspace
- sauvegarde de la map des objets sur le workspace
- sauvegarde de la map des objets groupes sur le workspace
Détail des différentes maps utilisées¶
Map<String, String> dataObjectIdToGuid
contenu : cette map contient l’id du DO relié à son guid création : elle est créé lors de la création du handler MAJ, put : elle est populée lors de la lecture des BinaryDataObject et PhysicalDataObject lecture, get : saveObjectGroupsToWorkspace, getObjectGroupQualifiers, suppression : c’est un clean en fin d’execution du handler
Map<String, String> dataObjectIdToObjectGroupId :
contenu : cette map contient l’id du DO relié au groupe d’objet de la balise DataObjectGroupId ou DataObjectGroupReferenceId création : elle est créé lors de la création du handler MAJ, put : elle est populée lors de la lecture des BinaryDataObject et PhysicalDataObject lecture, get : lecture de la map dans mapNewTechnicalDataObjectGroupToDO, getNewGdoIdFromGdoByUnit, completeDataObjectToObjectGroupMap, checkArchiveUnitIdReference et writeDataObjectInLocal suppression : c’est un clean en fin d’execution du handler
Map<String, GotObj> dataObjectIdWithoutObjectGroupId :
contenu : cette map contient l’id du DO relié à un groupe d’objet technique instanciés lors du parcours des objets. création : elle est créé lors de la création du handler MAJ, put : elle est populée lors du parcours des DO dans mapNewTechnicalDataObjectGroupToDO et extractArchiveUnitToLocalFile. Dans extractArchiveUnitToLocalFile, quand on découvre un DataObjectReferenceId et que cet Id se trouve dans dataObjectIdWithoutObjectGroupId alors on récupère l’objet et on change le statut isVisited à true. lecture, get : lecture de la map dans mapNewTechnicalDataObjectGroupToDO, extractArchiveUnitToLocalFile, getNewGdoIdFromGdoByUnit, suppression : c’est un clean en fin d’execution du handler
Le groupe d’objet technique GotObj contient un guid et un boolean isVisited, initialisé à false lors de la création. Le set à true est fait lors du parcours des units.
Map<String, String> objectGroupIdToGuid
contenu : cette map contient l’id du groupe d’objet relié à son guid création : elle est créé lors de la création du handler MAJ, put : elle est populée lors du parcours des DO dans writeDataObjectInLocal et mapNewTechnicalDataObjectGroupToDO lors de la création du groupe d’objet technique lecture, get : lecture de la map dans checkArchiveUnitIdReference, writeDataObjectInLocal, extractArchiveUnitToLocalFile, saveObjectGroupsToWorkspace suppression : c’est un clean en fin d’execution du handler
Map<String, String> objectGroupIdToGuidTmp
contenu : c’est la même map que objectGroupIdToGuid création : elle est créé lors de la création du handler MAJ, put : elle est populée dans writeDataObjectInLocal lecture, get : lecture de la map dans writeDataObjectInLocal suppression : c’est un clean en fin d’execution du handler
Map<String, List<String>> objectGroupIdToDataObjectId
contenu : cette map contient l’id du groupe d’objet relié à son ou ses DO création : elle est créé lors de la création du handler MAJ, put : elle est populée lors du parcours des DO dans writeDataObjectInLocal quand il y a une balise DataObjectGroupId ou DataObjectGroupReferenceId et qu’il n’existe pas dans objectGroupIdToDataObjectId. lecture, get : lecture de la map dans le parcours des DO dans writeDataObjectInLocal. La lecture est faite pour ajouter des DO dans la liste. suppression : c’est un clean en fin d’execution du handler
Map<String, List<String>> objectGroupIdToUnitId
contenu : cette map contient l’id du groupe d’objet relié à ses AU création : elle est créé lors de la création du handler MAJ, put : elle est populée lors du parcours des units dans extractArchiveUnitToLocalFile quand il y a une balise DataObjectGroupId ou DataObjectGroupReferenceId et qu’il nexiste pas dans objectGroupIdToUnitId sinon on ajoute dans la liste des units de la liste lecture, get : lecture de la map dans le parcours des units. La lecture est faite pour ajouter des units dans la liste. suppression : c’est un clean en fin d’execution du handler
Map<String, DataObjectInfo> objectGuidToDataObject
contenu : cette map contient le guid du data object et DataObjectInfo création : elle est créé lors de la création du handler MAJ, put : elle est populer lors de l’extraction des infos du data object vers le workspace lecture, get : elle permet de récupérer les infos binary data object pour sauver l’object group sur le worskapce supression : c’est un clean en fin d’execution du handler
Map<String, String> unitIdToGuid
contenu : cette map contient l’id de l’unit relié à son guid création : elle est créé lors de la création du handler MAJ, put : elle est populée lors du parcours des units dans extractArchiveUnitToLocalFile lecture, get : lecture de la map se fait lors de la création du graph/level des unit dans createIngestLevelStackFile et dans la sauvegarde des object groups vers le workspace suppression : c’est un clean en fin d’execution du handler
Map<String, String> unitIdToGroupId
contenu : cette map contient l’id de l’unit relié à son group id création : elle est créé lors de la création du handler MAJ, put : elle est populée lors du parcours des DO dans writeDataObjectInLocal quand il y a une balise DataObjectGroupId ou DataObjectGroupReferenceId lecture, get : lecture de la map se fait lors de l’extraction des unit dans extractArchiveUnitToLocalFile et permettant de lire dans objectGroupIdToGuid. suppression : c’est un clean en fin d’execution du handler
Map<String, String> objectGuidToUri
contenu : cette map contient le guid du BDO relié à son uri définis dans le manifest création : elle est créé lors de la création du handler MAJ, put : elle est poppulée lors du parcours des DO dans writeDataObjectInLocal quand il rencontre la balise uri lecture, get : lecture de la map se fait lors du save des objects groups dans le workspace suppression : c’est un clean en fin d’execution du handler
sauvegarde des maps (dataObjectIdToObjectGroupId, objectGroupIdToGuid) dans le workspace
Vérifier les ArchiveUnit du SIP¶
Dans les cas où le SIP contient un objet numérique référencé par un groupe d’objet et qu’une unité archiviste référence cet objet directement (au lieu de déclarer le GOT), le résultat attendu est un statut KO au niveau de l’étape STP_INGEST_CONTROL_SIP dans l’action CHECK_MANIFEST. Ce contrôle est effectué dans la fonction checkArchiveUnitIdReference de ExtractSedaHandler.
Pour ce cas, le map unitIdToGroupId contient une référence entre un unitId et groupId et ce groupId est l’id de l’objet numérique. Dans le objectGroupIdToGuid, il n’existe pas de lien entre id de groupe d’objet et son guid (parce que c’est un id d’object numérique).
On vérifie la valeur des groupIds récupérés dans dataObjectIdToObjectGroupId et unitIdToGroupId. Si ils sont différents, il s’agit du cas abordé ci-dessus, sinon c’est celui des objects numériques sans groupe d’objet technique. Enfin, l’exception ArchiveUnitContainDataObjectException est déclenchée pour ExtractSeda et dans cette étape, le status KO est mise à jour pour l’exécution de l’étape.
L’exécution de l’algorithme est présenté dans le preudo-code ci-dessous:
Si (map unitIdToGroupId contient des valeurs)
Pour (chaque élement ELEM du map unitIdToGroupId)
Si (la valeur guid de groupe d'object dans objectGroupIdToGuid associé à ELEM) // archiveUnit reference par DO
Prendre (la valeur groupId dans le maps dataObjectIdToObjectGroupId associé à groupId d'ELEM)
Si (cette groupId est NULLE) // ArchiveUnit réferencé DO mais il n'existe pas un lien DO à groupe d'objet
Délencher (exception ProcessingException)
Autrement
Si (cette groupId est différente grouId associé à ELEM)
Délencher (exception ArchiveUnitContainDataObjectException)
Fin Si
Fin Si
Fin Si
Fin Pour
Fin Si
Détails du data dans l’itemStatus retourné¶
Le itemStatus est mis à jour avec les objets du manifest.xml remontées pour mettre à jour evDetData. Il contient dans data le json de evDetData en tant que String. Entre autre, le evDetData contient la valeur evDetDataType à « MASTER » qui définit une action de copie de ce evDetData dans le evDetData master de l’operation. Les champs récupérés (s’ils existent dans le manifest) sont « evDetailReq », « evDateTimeReq », « ArchivalAgreement », « agIfTrans », « ServiceLevel ».
Détail du handler : IndexObjectGroupActionHandler¶
4.7.1 description¶
Indexation des objets groupes en récupérant les objets groupes du workspace. Il y a utilisation d’un client metadata.
4.8 Détail du handler : IndexUnitActionHandler¶
4.8.1 description¶
Indexation des units en récupérant les units du workspace. Il y a utilisation d’un client metadata.
4.9 Détail du handler : StoreObjectGroupActionHandler¶
4.9.1 description¶
Persistence des objets dans l’offre de stockage depuis le workspace.
4.10 Détail du handler : FormatIdentificationActionHandler¶
4.10.1 Description¶
Ce handler permet d’identifier et contrôler automatiquement le format des objets versés. Il s’exécute sur les différents ObjectGroups déclarés dans le manifest. Pour chaque objectGroup, voici ce qui est effectué :
- récupération du JSON de l’objectGroup présent sur le Workspace
- transformation de ce Json en une map d’id d’objets / uri de l’objet associée
- boucle sur les objets :
- téléchargement de l’objet (File) depuis le Workspace
- appel l’outil de vérification de format (actuellement Siegfried) en lui passant le path vers l’objet à identifier + récupération de la réponse.
- appel de l’AdminManagement pour faire une recherche getFormats par rapport au PUID récupéré.
- mise à jour du Json : le format récupéré par Siegfried est mis à jour dans le Json (pour indexation future).
- construction d’une réponse.
- sauvegarde du JSON de l’objectGroup dans le Workspace.
- aggrégation des retours pour générer un message + mise à jour du logbook.
4.10.2 Détail des différentes maps utilisées :¶
Map<String, String> objectIdToUri
contenu : cette map contient l’id du BDO associé à son uri. création : elle est créée dans le Handler après récupération du json listant les ObjectGroups MAJ, put : elle est populée lors de la lecture du json listant les ObjectGroups. lecture, get : lecture au fur et à mesure du traitement des BDO. suppression : elle n’est pas enregistrée sur le workspace et est présente en mémoire uniquement.
4.10.3 exécution¶
Ce Handler est exécuté dans l’étape « Contrôle et traitements des objets », juste après le Handler de vérification des empreintes.
4.10.4 journalisation : logbook operation? logbook life cycle?¶
Dans le traitement du Handler, sont mis à jour uniquement les journaux de cycle de vie des ObjectGroups. Les Outcome pour les journaux de cycle de vie peuvent être les suivants :
- Le format PUID n’a pas été trouvé / ne correspond pas avec le référentiel des formats.
- Le format du fichier n’a pas pu être trouvé.
- Le format du fichier a été complété dans les métadonnées (un « diff » est généré et ajouté).
- Le format est correct et correspond au référentiel des formats.
(Note : les messages sont informatifs et ne correspondent aucunement à ce qui sera vraiment inséré en base)
4.10.5 modules utilisés¶
Le Handler utilise les modules suivants :
- Workspace (récupération / copie de fichiers)
- Logbook (mise à jour des journaux de cycle de vie des ObjectGroups)
- Common-format-identification (appel pour analyse des objets)
- AdminManagement (comparaison format retourné par l’outil d’analyse par rapport au référentiel des formats de Vitam).
4.10.6 cas d’erreur¶
Les différentes exceptions pouvant être rencontrées :
- ReferentialException : si un problème est rencontré lors de l’interrogation du référentiel des formats de Vitam
- InvalidParseOperationException/InvalidCreateOperationException : si un problème est rencontré lors de la génération de la requête d’interrogation du référentiel des formats de Vitam
- FormatIdentifier*Exception : si un problème est rencontré avec l’outil d’analyse des formats (Siegfried)
- Logbook*Exception : si un problème est rencontré lors de l’interrogation du logbook
- Logbook*Exception : si un problème est rencontré lors de l’interrogation du logbook
- Content*Exception : si un problème est rencontré lors de l’interrogation du workspace
- ProcessingException : si un problème plus général est rencontré dans le Handler
Détail du handler : TransferNotificationActionHandler¶
Description¶
Ce handler permet de finaliser le processus d’entrée d’un SIP. Cet Handler est un peu spécifique car il sera lancé même si une étape précédente tombe en erreur.
Il permet de générer un xml de notification qui sera :
- une notification KO si une étape du workflow est tombée en erreur.
- une notification OK si le process est OK, et que le SIP a bien été intégré sans erreur.
La première étape dans ce handler est de déterminer l’état du Workflow : OK ou KO.
Détail des différentes maps utilisées¶
Map<String, Object> archiveUnitSystemGuid
contenu : cette map contient la liste des archives units avec son identifiant tel que déclaré dans le manifest, associé à son GUID.
Map<String, Object> dataObjectSystemGuid
contenu : cette map contient la liste Data Objects avec leur GUID généré associé à l’identifiant déclaré dans le manifest.
Map<String, Object> bdoObjectGroupSystemGuid
contenu : cette map contient la liste groupes d’objets avec leur GUID généré associé à l’identifiant déclaré dans le manifest.
exécution¶
Ce Handler est exécuté en dernière position. Il sera exécuté quoi qu’il se passe avant. Même si le processus est KO avant, le Handler sera exécuté.
Cas OK : @TODO@
Cas KO : Pour l’opération d’ingest en cours, on va récupérer dans les logbooks plusieurs informations :
- récupération des logbooks operations générés par l’opération d’ingest.
- récupération des logbooks lifecycles pour les archive units présentes dans le SIP.
- récupération des logbooks lifecycles pour les groupes d’objets présents dans le SIP.
Le Handler s’appuie sur des fichiers qui lui sont transmis. Ces fichiers peuvent ne pas être présents si jamais le process est en erreur avec la génération de ces derniers.
- un fichier globalSedaParameters.file contenant des informations sur le manifest (messageIdentifier).
- un fichier mapsUnits.file : présentant une map d’archive unit
- un fichier mapsDO.file : présentant la liste des data objects
- un fichier mapsDOtoOG.file : mappant le data object à son object group
A noter que ces fichiers ne sont pas obligatoires pour le bon déroulement du handler.
Le handler va alors procéder à la génération d’un XML à partir des informationss aggrégées. Voici sa structure générale :
- MessageIdentifier est rempli avec le MessageIdentifier présent dans le fichier globalSedaParameters. Il est vide si le fichier n’existe pas.
- dans la balise ReplyOutcome :
- dans Operation, on aura une liste d’events remplis par les différentes opérations KO et ou FATAL. La liste sera forcément remplie avec au moins un event. Cette liste est obtenue par l’interrogation de la collection LogbookOperations.
- dans ArchiveUnitList, on aura une liste d’events en erreur. Cette liste est obtenue par l’interrogation de la collection LogbookLifecycleUnits.
- dans DataObjectList, on aura une liste d’events en erreur. Cette liste est obtenue par l’interrogation de la collection LogbookLifecycleObjectGroups.
Le XML est alors enregistré sur le Workspace.
journalisation : logbook operation? logbook life cycle?¶
Dans le traitement du Handler, le logbook est interrogé : opérations et cycles de vie. Cependant aucune mise à jour est effectuée lors de l’exécution de ce handler.
modules utilisés¶
Le Handler utilise les modules suivants :
- Workspace (récupération / copie de fichiers)
- Logbook (partie server) : pour le moment la partie server du logbook est utilisée pour récupérer les différents journaux (opérations et cycles de vie).
- Storage : permettant de stocker l’ATR.
cas d’erreur¶
Les différentes exceptions pouvant être rencontrées :
- Logbook*Exception : si un problème est rencontré lors de l’interrogation du logbook
- Content*Exception : si un problème est rencontré lors de l’interrogation du workspace
- XML*Exception : si un souci est rencontré sur la génération du XML
- ProcessingException : si un problème plus général est rencontré dans le Handler
Détail du handler : AccessionRegisterActionHandler¶
Description¶
AccessionRegisterActionHandler permet de fournir une vue globale et dynamique des archives
sous la responsabilité du service d’archives, pour chaque tenant.
Détail des maps utilisées¶
Map<String, String> objectGroupIdToGuid
contenu : cette map contient l’id du groupe d’objet relié à son guid
Map<String, String> archiveUnitIdToGuid
contenu : cette map contient l’id du groupe d’objet relié à son guid
Map<String, Object> dataObjectIdToDetailDataObject
contenu : cette map contient l’id du data object relié à ses informations
Exécution¶
L’alimentation du registre des fonds a lieu pendant la phase de finalisation de l’entrée,
une fois que les objets et les units sont rangés. (« stepName »: « STP_INGEST_FINALISATION »)
Le Registre des Fonds est alimenté de la manière suivante:
– un identifiant unique – des informations sur le service producteur (OriginatingAgency) – des informations sur le service versant (SubmissionAgency), si différent du service producteur—des informations sur le contrat (ArchivalAgreement)
– date de début de l’enregistrement (Start Date) – date de fin de l’enregistrement (End Date) – date de dernière mise à jour de l’enregistrement (Last update) – nombre d’units (Total Units) – nombre de GOT (Total ObjectGroups) – nombre d’Objets (Total Objects) – volumétrie des objets (Object Size) – id opération d’entrée associée [pour l’instant, ne comprend que l’evIdProc de l’opération d’entrée concerné] – status (ItemStatus)
Détail du handler : CheckIngestContractActionHandler¶
Description¶
CheckIngestContractHandler permet de vérifier la présence et contrôler le contrat d’entrée du SIP à télécharger.
Détail des données utilisées¶
globalSEDAParameters.json Ce handler prend ce fichier comme le parametre d’entrée. Le fichier contient des données gobales sur l’ensemble des parametrès du bordereau et il a été généré à l’étape de l’ExtractSedeActionHandler (CHECK_MANIFEST).
Exécution¶
Le handler cherche d’abord dans globalSEDAParameters.json le nom du contrat déclaré dans le SIP associé au balise <ArchivalAgreement>. Si il n’y as pas de déclaration de contrat d’entrée, le handler retourne le status OK. Si il y a un déclaration de contrat, une liste des opérations suivantes sera effectué :
recherche du contrat d’entrée déclaré dans la référentiel de contrat
vérification de contrat :
si le contrat non trouvé ou contrat trouvé mais en status INACTIVE, le handler retourne le status KO si le contrat trouvé et en status ACTIVE, le handler retourne le status OK
L’exécution de l’algorithme est présenté dans le preudo-code ci-dessous:
Si (il y as pas de déclaration de contrat)
handler retourne OK
Autrement
recherche du contrat dans la base via le client AdminManagementClient
Si (contrat nou trouvé OU contrat trouvé mais INACTIVE)
handler retourne KO
Autrement
handler retourne OK
Fin Si
Fin Si
Détail du handler : CheckNoObjectsActionHandler¶
Description¶
CheckNoObjectsActionHandler permet de vérifier s’il y a des objects numériques dans le SIP à verser dans le système.
Détail des données utilisées¶
Le handler prend ce fichier manifest extrait du WORKSPACE comme le parametre d’entrée.
exécution¶
Le fichier manifest sera lu pour vérifier s’il y a des TAG « BinaryDataObject » ou « PhysicalDataObject ». S’il en y a, le handler retourne KO, sinon OK.
Détail du plugin : CheckArchiveUnitSchema¶
Description¶
CheckArchiveUnitSchema permet d’exécuter un contrôle intelligent des archive unit en vérifiant la conformité du JSON généré dans le process pour chaque archive unit, par rapport à un schéma défini.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 | {
"$schema": "http:\/\/vitam-json-schema.org\/draft-04\/schema#",
"id": "http:\/\/example.com\/root.json",
"type": "object",
"additionalProperties": true,
"anyOf": [
{
"required": [
"_id",
"Management",
"DescriptionLevel",
"Title"
]
},
{
"required": [
"_id",
"Management",
"DescriptionLevel",
"Title_"
]
}
],
"properties": {
"_id": {
"type": "string"
},
"_og": {
"type": "string"
},
"Management": {
"id": "http:\/\/example.com\/root.json\/ArchiveUnit\/Management",
"additionalProperties": true,
"properties": {
"AccessRule": {
"type": "object",
"id": "http://example.com/root.json/ArchiveUnit/Management/AccessRule",
"properties": {
"Rules": {
"type": "array",
"id": "http://example.com/root.json/ArchiveUnit/Management/AccessRule/Rules",
"description": "An explanation about the purpose of this instance.",
"items": {
"id": "http://example.com/root.json/ArchiveUnit/Management/AccessRule/Rules/Item/0",
"type": "object",
"properties": {
"Rule": {
"description": "NonEmptyTokenType + FIXME: attribute (xsd:ID)",
"title": "The Rule schema.",
"type": "string"
},
"StartDate": {
"title": "The Startdate schema.",
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-8]{1}[0-9]{3}-[0-9]{2}-[0-9]{2}"
}
]
},
"EndDate": {
"title": "The Enddate schema.",
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}"
}
]
}
}
}
},
"Inheritance": {
"id": "http://example.com/root.json/ArchiveUnit/Management/AccessRule/Inheritance",
"type": "object",
"properties": {
"PreventInheritance": {
"id": "http://example.com/root.json/ArchiveUnit/Management/AccessRule/Inheritance/PreventInheritance",
"description": "An explanation about the purpose of this instance.",
"title": "The PreventInheritance schema.",
"type": [
"string",
"boolean"
]
},
"PreventRulesId": {
"type": "array",
"id": "http://example.com/root.json/ArchiveUnit/Management/AccessRule/Inheritance/PreventRulesId",
"items": {
"description": "NonEmptyTokenType + FIXME: attribute (xsd:ID)",
"title": "The PreventRulesId 0 schema.",
"type": "string"
}
}
},
"anyOf": [
{
"required": [
"PreventInheritance"
]
},
{
"required": [
"PreventRulesId"
]
}
]
}
}
},
"AppraisalRule": {
"type": "object",
"id": "http://example.com/root.json/ArchiveUnit/Management/AppraisalRule",
"properties": {
"Rules": {
"type": "array",
"id": "http://example.com/root.json/ArchiveUnit/Management/AppraisalRule/Rules",
"description": "An explanation about the purpose of this instance.",
"items": {
"id": "http://example.com/root.json/ArchiveUnit/Management/AppraisalRule/Rules/Item/0",
"type": "object",
"properties": {
"Rule": {
"description": "NonEmptyTokenType + FIXME: attribute (xsd:ID)",
"title": "The Rule schema.",
"type": "string"
},
"StartDate": {
"title": "The Startdate schema.",
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-8]{1}[0-9]{3}-[0-9]{2}-[0-9]{2}"
}
]
},
"EndDate": {
"title": "The Enddate schema.",
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}"
}
]
}
}
}
},
"FinalAction": {
"enum": [
"Keep",
"Destroy"
]
},
"Inheritance": {
"id": "http://example.com/root.json/ArchiveUnit/Management/AppraisalRule/Inheritance",
"type": "object",
"properties": {
"PreventInheritance": {
"id": "http://example.com/root.json/ArchiveUnit/Management/AppraisalRule/Inheritance/PreventInheritance",
"description": "An explanation about the purpose of this instance.",
"title": "The PreventInheritance schema.",
"type": [
"string",
"boolean"
]
},
"PreventRulesId": {
"type": "array",
"id": "http://example.com/root.json/ArchiveUnit/Management/AppraisalRule/Inheritance/PreventRulesId",
"items": {
"description": "NonEmptyTokenType + FIXME: attribute (xsd:ID)",
"title": "The PreventRulesId 0 schema.",
"type": "string"
}
}
},
"anyOf": [
{
"required": [
"PreventInheritance"
]
},
{
"required": [
"PreventRulesId"
]
}
]
}
}
},
"ArchiveUnit": {
"id": "http:\/\/example.com\/root.json\/ArchiveUnit\/Management\/ArchiveUnit",
"properties": {
"ArchiveUnitRefId": {
"description": "An explanation about the purpose of this instance.",
"title": "The Archiveunitrefid schema.",
"type": "string"
}
},
"type": "object"
},
"ClassificationRule": {
"type": "object",
"id": "http://example.com/root.json/ArchiveUnit/Management/ClassificationRule",
"properties": {
"Rules": {
"type": "array",
"id": "http://example.com/root.json/ArchiveUnit/Management/ClassificationRule/Rules",
"description": "An explanation about the purpose of this instance.",
"items": {
"id": "http://example.com/root.json/ArchiveUnit/Management/ClassificationRule/Rules/Item/0",
"type": "object",
"properties": {
"Rule": {
"description": "NonEmptyTokenType + FIXME: attribute (xsd:ID)",
"title": "The Rule schema.",
"type": "string"
},
"StartDate": {
"title": "The Startdate schema.",
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-8]{1}[0-9]{3}-[0-9]{2}-[0-9]{2}"
}
]
},
"EndDate": {
"title": "The Enddate schema.",
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}"
}
]
},
"ClassificationReassessingDate": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"NeedReassessingAuthorization": {
"type": "boolean"
}
}
}
},
"ClassificationLevel": {
"type": "string"
},
"ClassificationOwner": {
"type": "string"
},
"Inheritance": {
"id": "http://example.com/root.json/ArchiveUnit/Management/ClassificationRule/Inheritance",
"type": "object",
"properties": {
"PreventInheritance": {
"id": "http://example.com/root.json/ArchiveUnit/Management/ClassificationRule/Inheritance/PreventInheritance",
"description": "An explanation about the purpose of this instance.",
"title": "The PreventInheritance schema.",
"type": [
"string",
"boolean"
]
},
"PreventRulesId": {
"type": "array",
"id": "http://example.com/root.json/ArchiveUnit/Management/ClassificationRule/Inheritance/PreventRulesId",
"items": {
"description": "NonEmptyTokenType + FIXME: attribute (xsd:ID)",
"title": "The PreventRulesId 0 schema.",
"type": "string"
}
}
},
"anyOf": [
{
"required": [
"PreventInheritance"
]
},
{
"required": [
"PreventRulesId"
]
}
]
}
},
"anyOf": [ {"required":["ClassificationLevel", "ClassificationOwner"]}]
},
"DisseminationRule": {
"type": "object",
"id": "http://example.com/root.json/ArchiveUnit/Management/DisseminationRule",
"properties": {
"Rules": {
"type": "array",
"id": "http://example.com/root.json/ArchiveUnit/Management/DisseminationRule/Rules",
"description": "An explanation about the purpose of this instance.",
"items": {
"id": "http://example.com/root.json/ArchiveUnit/Management/DisseminationRule/Rules/Item/0",
"type": "object",
"properties": {
"Rule": {
"description": "NonEmptyTokenType + FIXME: attribute (xsd:ID)",
"title": "The Rule schema.",
"type": "string"
},
"StartDate": {
"title": "The Startdate schema.",
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-8]{1}[0-9]{3}-[0-9]{2}-[0-9]{2}"
}
]
},
"EndDate": {
"title": "The Enddate schema.",
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}"
}
]
}
}
}
},
"Inheritance": {
"id": "http://example.com/root.json/ArchiveUnit/Management/DisseminationRule/Inheritance",
"type": "object",
"properties": {
"PreventInheritance": {
"id": "http://example.com/root.json/ArchiveUnit/Management/DisseminationRule/Inheritance/PreventInheritance",
"description": "An explanation about the purpose of this instance.",
"title": "The PreventInheritance schema.",
"type": [
"string",
"boolean"
]
},
"PreventRulesId": {
"type": "array",
"id": "http://example.com/root.json/ArchiveUnit/Management/DisseminationRule/Inheritance/PreventRulesId",
"items": {
"description": "NonEmptyTokenType + FIXME: attribute (xsd:ID)",
"title": "The PreventRulesId 0 schema.",
"type": "string"
}
}
},
"anyOf": [
{
"required": [
"PreventInheritance"
]
},
{
"required": [
"PreventRulesId"
]
}
]
}
}
},
"NeedAuthorization": {
"description": "An explanation about the purpose of this instance.",
"title": "The Needauthorization schema.",
"type": "boolean"
},
"ReuseRule": {
"type": "object",
"id": "http://example.com/root.json/ArchiveUnit/Management/ReuseRule",
"properties": {
"Rules": {
"type": "array",
"id": "http://example.com/root.json/ArchiveUnit/Management/ReuseRule/Rules",
"description": "An explanation about the purpose of this instance.",
"items": {
"id": "http://example.com/root.json/ArchiveUnit/Management/ReuseRule/Rules/Item/0",
"type": "object",
"properties": {
"Rule": {
"description": "NonEmptyTokenType + FIXME: attribute (xsd:ID)",
"title": "The Rule schema.",
"type": "string"
},
"StartDate": {
"title": "The Startdate schema.",
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-8]{1}[0-9]{3}-[0-9]{2}-[0-9]{2}"
}
]
},
"EndDate": {
"title": "The Enddate schema.",
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}"
}
]
}
}
}
},
"Inheritance": {
"id": "http://example.com/root.json/ArchiveUnit/Management/ReuseRule/Inheritance",
"type": "object",
"properties": {
"PreventInheritance": {
"id": "http://example.com/root.json/ArchiveUnit/Management/ReuseRule/Inheritance/PreventInheritance",
"description": "An explanation about the purpose of this instance.",
"title": "The PreventInheritance schema.",
"type": [
"string",
"boolean"
]
},
"PreventRulesId": {
"type": "array",
"id": "http://example.com/root.json/ArchiveUnit/Management/ReuseRule/Inheritance/PreventRulesId",
"items": {
"description": "NonEmptyTokenType + FIXME: attribute (xsd:ID)",
"title": "The PreventRulesId 0 schema.",
"type": "string"
}
}
},
"anyOf": [
{
"required": [
"PreventInheritance"
]
},
{
"required": [
"PreventRulesId"
]
}
]
}
}
},
"StorageRule": {
"type": "object",
"id": "http://example.com/root.json/ArchiveUnit/Management/StorageRule",
"properties": {
"Rules": {
"type": "array",
"id": "http://example.com/root.json/ArchiveUnit/Management/StorageRule/Rules",
"description": "An explanation about the purpose of this instance.",
"items": {
"id": "http://example.com/root.json/ArchiveUnit/Management/StorageRule/Rules/Item/0",
"type": "object",
"properties": {
"Rule": {
"description": "NonEmptyTokenType + FIXME: attribute (xsd:ID)",
"title": "The Rule schema.",
"type": "string"
},
"StartDate": {
"title": "The Startdate schema.",
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-8]{1}[0-9]{3}-[0-9]{2}-[0-9]{2}"
}
]
},
"EndDate": {
"title": "The Enddate schema.",
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}"
}
]
}
}
}
},
"FinalAction": {
"enum": [
"RestrictAccess",
"Transfer",
"Copy"
]
},
"Inheritance": {
"id": "http://example.com/root.json/ArchiveUnit/Management/StorageRule/Inheritance",
"type": "object",
"properties": {
"PreventInheritance": {
"id": "http://example.com/root.json/ArchiveUnit/Management/StorageRule/Inheritance/PreventInheritance",
"description": "An explanation about the purpose of this instance.",
"title": "The PreventInheritance schema.",
"type": [
"string",
"boolean"
]
},
"PreventRulesId": {
"type": "array",
"id": "http://example.com/root.json/ArchiveUnit/Management/StorageRule/Inheritance/PreventRulesId",
"items": {
"description": "NonEmptyTokenType + FIXME: attribute (xsd:ID)",
"title": "The PreventRulesId 0 schema.",
"type": "string"
}
}
},
"anyOf": [
{
"required": [
"PreventInheritance"
]
},
{
"required": [
"PreventRulesId"
]
}
]
}
}
},
"UpdateOperation": {
"id": "http:\/\/example.com\/root.json\/ArchiveUnit\/Management\/UpdateOperation",
"properties": {
"SystemId": {
"description": "An explanation about the purpose of this instance.",
"title": "The Systemid schema.",
"type": "string"
},
"ToDelete": {
"id": "http:\/\/example.com\/root.json\/ArchiveUnit\/Management\/UpdateOperation\/ToDelete",
"properties": {
"ArchiveUnitRefId": {
"id": "http:\/\/example.com\/root.json\/ArchiveUnit\/Management\/UpdateOperation\/ToDelete\/ArchiveUnitRefId",
"items": {
"description": "An explanation about the purpose of this instance.",
"title": "The 0 schema.",
"type": "string"
},
"type": "array"
},
"FullUpdate": {
"description": "An explanation about the purpose of this instance.",
"title": "The Fullupdate schema.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"DescriptionLevel": {
"type": "string",
"enum": [
"Fonds",
"Subfonds",
"Class",
"Collection",
"Series",
"Subseries",
"RecordGrp",
"SubGrp",
"File",
"Item"
]
},
"Title": {
"description": "All TitleGroup",
"type": [
"string",
"array",
"number"
],
"minLength": 1,
"minItems": 1
},
"FilePlanPosition": {
"description": "Start of IdentifierGroup",
"type": "array",
"items": {
"type": "string"
}
},
"SystemId": {
"description": "Part of IdentifierGroup",
"type": "array",
"items": {
"type": "string"
}
},
"OriginatingSystemId": {
"description": "Part of IdentifierGroup",
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
},
"ArchivalAgencyArchiveUnitIdentifier": {
"description": "Part of IdentifierGroup",
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
},
"OriginatingAgencyArchiveUnitIdentifier": {
"description": "Part of IdentifierGroup",
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
},
"TransferringAgencyArchiveUnitIdentifier": {
"description": "End of IdentifierGroup",
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
},
"Description": {
"description": "All of DescriptionGroup",
"type": [
"null",
"string",
"array"
]
},
"CustodialHistory": {
"description": "All of CustodialHistoryGroup",
"type": "object",
"properties": {
"CustodialHistoryItem": {
"type": "array",
"items": {
"type": "string"
}
},
"CustodialHistoryFile": {
"type": "object",
"properties": {
"DataObjectReferenceId": {
"description": "xsd:IDREF",
"type": "string"
},
"DataObjectGroupReferenceId": {
"description": "xsd:IDREF",
"type": "string"
}
}
}
},
"required": [
"CustodialHistoryItem"
]
},
"Type": {
"description": "All of TypeGroup",
"type": [
"string",
"object"
]
},
"DocumentType": {
"description": "All of DocumentTypeGroup",
"type": "string"
},
"Language": {
"description": "Start of LanguageGroup",
"type": "array",
"items": {
"type": "string"
}
},
"DescriptionLanguage": {
"description": "End of LanguageGroup",
"type": "string"
},
"Status": {
"description": "All of StatusGroup",
"type": "string"
},
"Version": {
"description": "All of VersionGroup",
"type": "string"
},
"Tag": {
"description": "Start of KeywordsGroup",
"type": "array",
"items": {
"type": "string"
}
},
"Keyword": {
"description": "End of KeywordsGroup",
"type": "array",
"items": {
"type": "object",
"properties": {
"KeywordContent": {
"type": "string"
},
"KeywordReference": {
"type": "string"
},
"KeywordType": {
"description": "How TODO ? listVersionID (attribute) + String: [@listVersionID + $, Only string]?",
"enum": [
"corpname",
"famname",
"geogname",
"name",
"occupation",
"persname",
"subject",
"genreform",
"function"
]
}
}
}
},
"Coverage": {
"type": "object",
"properties": {
"Spatial": {
"type": [
"string",
"array",
"number"
]
},
"Temporal": {
"type": [
"string",
"array",
"number"
]
},
"Juridictional": {
"type": [
"string",
"array",
"number"
]
}
}
},
"OriginatingAgency": {
"description": "All of OriginatingAgencyGroup",
"properties": {
"Identifier": {
"type": "string"
},
"OrganizationDescriptiveMetadata": {
"additionalProperties": true,
"type": "object"
}
},
"type": "object"
},
"SubmissionAgency": {
"description": "All of SubmissionAgencyGroup",
"properties": {
"Identifier": {
"type": "string"
},
"OrganizationDescriptiveMetadata": {
"additionalProperties": true,
"type": "object"
}
},
"type": "object"
},
"AuthorizedAgent": {
"description": "All of AuthorizedAgentGroup",
"type": "array",
"items": {
"type": "object",
"properties": {
"FirstName": {
"type": "string"
},
"BirthName": {
"type": "string"
},
"GivenName": {
"type": "string"
},
"Gender": {
"type": "string"
},
"BirthDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"BirthPlace": {
"description": "LocationGroup",
"type": "object",
"properties": {
"Geogname": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"DeathDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"DeathPlace": {
"description": "LocationGroup",
"type": "object",
"properties": {
"Geogname": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"Nationality": {
"items": {
"type": "string"
},
"type": "array"
},
"Identifier": {
"items": {
"type": "string"
},
"type": "array"
},
"Corpname": {
"type": "string"
}
},
"anyOf": [
{
"anyOf": [
{
"required": [
"FirstName"
]
},
{
"required": [
"BirthName"
]
},
{
"required": [
"GivenName"
]
},
{
"required": [
"Gender"
]
},
{
"required": [
"BirthDate"
]
},
{
"required": [
"DeathDate"
]
},
{
"required": [
"DeathPlace"
]
},
{
"required": [
"Nationality"
]
}
]
},
{
"anyOf": [
{
"required": [
"Corpname"
]
}
]
}
]
}
},
"Writer": {
"type": [
"array",
"object"
],
"items": {
"type": "object",
"properties": {
"FirstName": {
"type": [
"string",
"null"
]
},
"BirthName": {
"type": [
"string",
"null"
]
},
"GivenName": {
"type": [
"string",
"null"
]
},
"Gender": {
"type": [
"string",
"null"
]
},
"BirthDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}[Z]?$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"BirthPlace": {
"description": "LocationGroup",
"type": "object",
"properties": {
"Geogname": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"DeathDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}[Z]?$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"DeathPlace": {
"description": "LocationGroup",
"type": "object",
"properties": {
"Geogname": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"Nationality": {
"items": {
"type": "string"
},
"type": "array"
},
"Identifier": {
"items": {
"type": "string"
},
"type": "array"
},
"Function": {
"type": "array",
"items": {
"type": "string"
}
},
"Activity": {
"type": "array",
"items": {
"type": "string"
}
},
"Position": {
"type": "array",
"items": {
"type": "string"
}
},
"Role": {
"type": "array",
"items": {
"type": "string"
}
},
"Mandate": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"Addressee": {
"description": "All of AddresseeGroup (AudienceGroup)",
"items": {
"type": "object",
"properties": {
"FirstName": {
"type": [
"string",
"null"
]
},
"BirthName": {
"type": [
"string",
"null"
]
},
"GivenName": {
"type": [
"string",
"null"
]
},
"Gender": {
"type": [
"string",
"null"
]
},
"BirthDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"BirthPlace": {
"description": "LocationGroup",
"type": "object",
"properties": {
"Geogname": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"DeathDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"DeathPlace": {
"description": "LocationGroup",
"type": "object",
"properties": {
"Geogname": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"Nationality": {
"items": {
"type": "string"
},
"type": "array"
},
"Identifier": {
"items": {
"type": "string"
},
"type": [
"array",
"string"
]
},
"Corpname": {
"type": "string"
}
},
"anyOf": [
{
"anyOf": [
{
"required": [
"FirstName"
]
},
{
"required": [
"BirthName"
]
},
{
"required": [
"GivenName"
]
},
{
"required": [
"Gender"
]
},
{
"required": [
"BirthDate"
]
},
{
"required": [
"DeathDate"
]
},
{
"required": [
"DeathPlace"
]
},
{
"required": [
"Nationality"
]
}
]
},
{
"anyOf": [
{
"required": [
"Corpname"
]
}
]
}
]
}
},
"Recipient": {
"description": "All of RecipientGroup (AudienceGroup)",
"items": {
"type": "object",
"properties": {
"FirstName": {
"type": [
"string",
"null"
]
},
"BirthName": {
"type": [
"string",
"null"
]
},
"GivenName": {
"type": [
"string",
"null"
]
},
"Gender": {
"type": [
"string",
"null"
]
},
"BirthDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"BirthPlace": {
"description": "LocationGroup",
"type": "object",
"properties": {
"Geogname": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"DeathDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"DeathPlace": {
"description": "LocationGroup",
"type": "object",
"properties": {
"Geogname": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"Nationality": {
"items": {
"type": "string"
},
"type": "array"
},
"Identifier": {
"items": {
"type": "string"
},
"type": [
"array",
"string"
]
},
"Corpname": {
"type": "string"
}
},
"anyOf": [
{
"anyOf": [
{
"required": [
"FirstName"
]
},
{
"required": [
"BirthName"
]
},
{
"required": [
"GivenName"
]
},
{
"required": [
"Gender"
]
},
{
"required": [
"BirthDate"
]
},
{
"required": [
"DeathDate"
]
},
{
"required": [
"DeathPlace"
]
},
{
"required": [
"Nationality"
]
}
]
},
{
"anyOf": [
{
"required": [
"Corpname"
]
}
]
}
]
}
},
"Source": {
"description": "All of SourceGroup",
"type": "string"
},
"RelatedObjectReference": {
"description": "All of RelationGroup",
"type": "object",
"properties": {
"IsVersionOf": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ArchiveUnitRefId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
},
"DataObjectReference": {
"type": "object",
"properties": {
"DataObjectReferenceId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
},
"DataObjectGroupReferenceId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
}
}
},
"RepositoryArchiveUnitPID": {
"description": "NonEmptyTokenType",
"type": "string"
},
"RepositoryObjectPID": {
"description": "NonEmptyTokenType",
"type": "string"
}
}
}
},
"Replaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ArchiveUnitRefId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
},
"DataObjectReference": {
"type": "object",
"properties": {
"DataObjectReferenceId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
},
"DataObjectGroupReferenceId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
}
}
},
"RepositoryArchiveUnitPID": {
"description": "NonEmptyTokenType",
"type": "string"
},
"RepositoryObjectPID": {
"description": "NonEmptyTokenType",
"type": "string"
}
}
}
},
"Requires": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ArchiveUnitRefId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
},
"DataObjectReference": {
"type": "object",
"properties": {
"DataObjectReferenceId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
},
"DataObjectGroupReferenceId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
}
}
},
"RepositoryArchiveUnitPID": {
"description": "NonEmptyTokenType",
"type": "string"
},
"RepositoryObjectPID": {
"description": "NonEmptyTokenType",
"type": "string"
}
}
}
},
"IsPartOf": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ArchiveUnitRefId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
},
"DataObjectReference": {
"type": "object",
"properties": {
"DataObjectReferenceId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
},
"DataObjectGroupReferenceId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
}
}
},
"RepositoryArchiveUnitPID": {
"description": "NonEmptyTokenType",
"type": "string"
},
"RepositoryObjectPID": {
"description": "NonEmptyTokenType",
"type": "string"
}
}
}
},
"References": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ArchiveUnitRefId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
},
"DataObjectReference": {
"type": "object",
"properties": {
"DataObjectReferenceId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
},
"DataObjectGroupReferenceId": {
"description": "TYPE: xsd:IDREF",
"type": "string"
}
}
},
"RepositoryArchiveUnitPID": {
"description": "NonEmptyTokenType",
"type": "string"
},
"RepositoryObjectPID": {
"description": "NonEmptyTokenType",
"type": "string"
}
}
}
}
}
},
"CreatedDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"format": "date-time-vitam"
}
]
},
"TransactedDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"format": "date-time-vitam"
}
]
},
"AcquiredDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"format": "date-time-vitam"
}
]
},
"SentDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"format": "date-time-vitam"
}
]
},
"ReceivedDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"format": "date-time-vitam"
}
]
},
"RegisteredDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"format": "date-time-vitam"
}
]
},
"StartDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"format": "date-time-vitam"
}
]
},
"EndDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"format": "date-time-vitam"
}
]
},
"Event": {
"type": [
"array",
"object"
],
"items": {
"type": "object",
"properties": {
"EventIdentifier": {
"description": "NonEmptyTokenType",
"type": "string"
},
"EventType": {
"description": "NonEmptyTokenType",
"type": "string"
},
"EventDateTime": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"format": "date-time-vitam"
}
]
},
"EventDetail": {
"description": "TextType",
"type": "string"
}
}
}
},
"Signature": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Signer": {
"type": "array",
"items": {
"type": "object",
"properties": {
"FirstName": {
"type": "string"
},
"BirthName": {
"type": "string"
},
"FullName" : {
"type": "string"
},
"GivenName": {
"type": "string"
},
"Gender": {
"type": "string"
},
"BirthDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"BirthPlace": {
"description": "LocationGroup",
"type": "object",
"properties": {
"Geogname": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"DeathDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"DeathPlace": {
"description": "LocationGroup",
"type": "object",
"properties": {
"Geogname": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"Nationality": {
"items": {
"type": "string"
},
"type": "array"
},
"Identifier": {
"items": {
"type": "string"
},
"type": "array"
},
"Corpname": {
"type": "string"
},
"SigningTime": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}"
}
]
},
"Function": {
"type": "array",
"items": {
"type": "string"
}
},
"Activity": {
"type": "array",
"items": {
"type": "string"
}
},
"Position": {
"type": "array",
"items": {
"type": "string"
}
},
"Role": {
"type": "array",
"items": {
"type": "string"
}
},
"Mandate": {
"type": "array",
"items": {
"type": "string"
}
}
},
"anyOf": [
{
"anyOf": [
{
"required": [
"FirstName"
]
},
{
"required": [
"BirthName"
]
},
{
"required": [
"FullName"
]
},
{
"required": [
"GivenName"
]
},
{
"required": [
"Gender"
]
},
{
"required": [
"BirthDate"
]
},
{
"required": [
"DeathDate"
]
},
{
"required": [
"DeathPlace"
]
},
{
"required": [
"Nationality"
]
}
]
},
{
"anyOf": [
{
"required": [
"Corpname"
]
}
]
}
]
}
},
"Validator": {
"type": "object",
"properties": {
"FirstName": {
"type": "string"
},
"BirthName": {
"type": "string"
},
"FullName" : {
"type": "string"
},
"GivenName": {
"type": "string"
},
"Gender": {
"type": "string"
},
"BirthDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"BirthPlace": {
"description": "LocationGroup",
"type": "object",
"properties": {
"Geogname": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"DeathDate": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
{
"type": "string",
"format": "date-time"
}
]
},
"DeathPlace": {
"description": "LocationGroup",
"type": "object",
"properties": {
"Geogname": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"Nationality": {
"items": {
"type": "string"
},
"type": "array"
},
"Identifier": {
"items": {
"type": "string"
},
"type": "array"
},
"Corpname": {
"type": "string"
},
"ValidationTime": {
"description": "pattern: Date",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}"
}
]
},
"Function": {
"type": "array",
"items": {
"type": "string"
}
},
"Activity": {
"type": "array",
"items": {
"type": "string"
}
},
"Position": {
"type": "array",
"items": {
"type": "string"
}
},
"Role": {
"type": "array",
"items": {
"type": "string"
}
},
"Mandate": {
"type": "array",
"items": {
"type": "string"
}
}
},
"anyOf": [
{
"anyOf": [
{
"required": [
"FirstName"
]
},
{
"required": [
"BirthName"
]
},
{
"required": [
"FullName"
]
},
{
"required": [
"GivenName"
]
},
{
"required": [
"Gender"
]
},
{
"required": [
"BirthDate"
]
},
{
"required": [
"DeathDate"
]
},
{
"required": [
"DeathPlace"
]
},
{
"required": [
"Nationality"
]
}
]
},
{
"anyOf": [
{
"required": [
"Corpname"
]
}
]
}
]
},
"Masterdata": {
"description": "Type: CodeType (NonEmptyTokenType)",
"type": "object",
"properties": {
"Value": {
"description": "CodeType value",
"type": "string"
}
}
},
"ReferencedObject": {
"type": "object",
"properties": {
"SignedObjectId": {
"description": "xsd:IDREF",
"type": "string"
},
"SignedObjectDigest": {
"description": "String type: (FIXME: Check xsd:base64Binary OR xsd:hexBinary, can specify Format for those ?) \/ + FIXME: Attributes (How to do)",
"type": "object"
}
}
}
}
}
}
},
"Gps": {
"type": "object",
"properties": {
"GpsVersionID": {
"type": "string"
},
"GpsAltitude": {
"type": "integer"
},
"GpsAltitudeRef": {
"type": "string"
},
"GpsLatitude": {
"type": "string"
},
"GpsLatitudeRef": {
"type": "string"
},
"GpsLongitude": {
"type": "string"
},
"GpsLongitudeRef": {
"type": "string"
},
"GpsDateStamp": {
"type": "string"
}
}
}
}
|
Détail des données utilisées¶
Le plugin récupère l’id de l’Archive Unit à vérifier.
exécution¶
A partir de l’Id de l’id de l’Archive Unit à vérifier, le plugin va télécharger le fichier json associé dans le Workspace. Par la suite, il va vérifier la validation de ce Json par rapport au schéma json de Vitam.
détail des vérifications¶
Dans le schéma Json Vitam défini, voici les spécificités qui ont été ajoutées pour différents champs :
- StartDate pour les Rules : une date contenant une année égale à ou au dessus de l’année 9000 sera refusée.
- Content / Title : peut être de type String, Array ou number (on pourra avoir des titres traduits ainsi que des nombres si besoin)
Détail du handler : CheckArchiveProfileActionHandler¶
Description¶
Ce handler permet de vérifier le profil dans manifeste
exécution¶
Le format du profil est XSD ou RNG. L’exécution de l’algorithme est présenté dans le preudo-code ci-dessous:
Si le format du profil est équal à XSD
retourne true si XSD valide le fichier manifest.xml
Fin Si
Si le format du profil est équal à RNG
retourne true si RNG valide le fichier manifest.xml
Fin Si
Détail du handler : CheckArchiveProfileRelationActionHandler¶
Description¶
Ce handler permet de vérifier la relation entre le contrat d’entrée et le profil dans manifeste
exécution¶
Si le champ « ArchiveProfiles » dans le contrat d’entrée contient l’identifiant du profil, retourne true
Select select = new Select();
select.setQuery(QueryHelper.eq(IngestContract.NAME, contractName));
JsonNode queryDsl = select.getFinalSelect();
RequestResponse<IngestContractModel> referenceContracts = adminClient.findIngestContracts(queryDsl);
if (referenceContracts.isOk()) {
IngestContractModel contract = ((RequestResponseOK<IngestContractModel> ) referenceContracts).getResults().get(0);
isValid = contract.getArchiveProfiles().contains(profileIdentifier);
}
Détail du handler : ListArchiveUnitsActionHandler¶
Description¶
Ce handler permet de lister les unités archivistiques qui devront être mises à jour.
exécution¶
Il prend en entrée un fichier json représentant la liste règles de gestion ayant été modifiés dans le référentiel. Pour chaque règle mise à jour, une requête vers la collection units est effectuée. Le but de cette recherche est de générer une liste d’units avec les règles de gestion associées ayant été modifiées. En sortie, pour chaque unité archivistique, on aura un fichier GUID_AU.json (dans un sous répertoire GUIDOpération/UnitsWithoutLevel/) contenant un tableau des règles de gestion modifiées.
Détail du handler : ListRunningIngestsActionHandler¶
Description¶
Ce handler permet de lister les ingests toujours en cours d’exécution (processState RUNNING ou PAUSE).
exécution¶
Une requête est effectuée sur ProcessManagement, pour récupérer la liste des ingests en cours.
ProcessQuery pq = new ProcessQuery();
List<String> listStates = new ArrayList<>();
listStates.add(ProcessState.RUNNING.name());
listStates.add(ProcessState.PAUSE.name());
pq.setStates(listStates);
List<String> listProcessTypes = new ArrayList<>();
listProcessTypes.add(LogbookTypeProcess.INGEST.toString());
listProcessTypes.add(LogbookTypeProcess.HOLDINGSCHEME.toString());
listProcessTypes.add(LogbookTypeProcess.FILINGSCHEME.toString());
pq.setListProcessTypes(listProcessTypes);
RequestResponseOK<ProcessDetail> response =
(RequestResponseOK<ProcessDetail>) processManagementClient.listOperationsDetails(pq);
Suite à cette requête, la liste des opérations d’Ingest est enregistrée dans un fichier JSON : PROCESSING/runningIngests.json.
Détail du plugin : ArchiveUnitRulesUpdateActionPlugin¶
Description¶
Ce plugin permet de mettre à jour les règles de gestion d’une unité archivistique. Il s’agit ici de mettre à jour le champ endDate pour les règles de gestion impactées. On se trouve ici en mode distribué, cela veut donc dire que l’on traite les mises à jour, unité par unité.
exécution¶
Le fichier json pour l’unité archivistique, généré dans le Handler « ListArchiveUnitsActionHandler » est récupéré. A partir de ce dernier, on va faire une première requète pour récupérer l’unité archivistique telle qu’enregistrée en base.
Ensuite, catégorie par catégorie, des requêtes de mises à jour vont être créées. Une requête finale sera aggrégée, comprenant les différentes catégories mises à jour. Enfin, l’update final de la base de données sera exécuté, tel que ci-dessous :
query.addActions(UpdateActionHelper.push(VitamFieldsHelper.operations(), params.getProcessId()));
JsonNode updateResultJson = metaDataClient.updateUnitbyId(query.getFinalUpdate(), archiveUnitId);
String diffMessage = archiveUnitUpdateUtils.getDiffMessageFor(updateResultJson, archiveUnitId);
itemStatus.setEvDetailData(diffMessage);
Le différentiel (résumant les champs modifiés, principalement les endDate des règles de gestion) sera enregistré également dans les cycles de vie de l’unité archivistique.
//do some things
archiveUnitUpdateUtils.logLifecycle(params, archiveUnitId, StatusCode.OK, diffMessage, logbookLifeCycleClient);
Détail du plugin : RunningIngestsUpdateActionPlugin¶
Description¶
Ce plugin permet de mettre à jour les règles de gestion des unités archivistiques des ingests en cours.
exécution¶
Le fichier json décrivant les ingests en cours, généré dans le Handler « ListRunningIngestsActionHandler » est récupéré. Il va permettre, de traiter au fur et à mesure les ingests n’ayant pas été encore impactés par la mise à jour du référentiel des règles de gestion.
La manière de procéder est la suivante :
Une boucle while(true) va permettre de boucler continuellement sur une liste d’ingest.
Une boucle interne sur un iterator obtenu à partir de la liste des ingests va permettre de traiter les différents processus.
- Si l’ingest est finalisé (entre le moment de l’exécution du Handler ListRunningIngestsActionHandler, et l’exécution du plugin) alors on va vérifier la liste des règles de gestion pour chaque unité archivistique, puis procéder à des mises à jour (code commun avec le plugin ArchiveUnitRulesUpdateActionPlugin). L’ingest est alors, au final, supprimé de l’iterator.
- Si l’ingest est toujours en cours, alors on passe au suivant.
Tant que l’iterator contient des éléments, la boucle continue. (une pause de 10 secondes est prévue avant de reboucler sur l’iterator)
Enfin quand l’iterator est vide, le plugin, renverra un statut OK notifiant la gestion de tous les ingests.
A l’heure actuelle, pour éviter un nombre d’essais illimité, une limite d’essais à été positionné (NB_TRY = 600). A l’avenir, il conviendra certainement de ne pas avoir cette limite.
Il est aussi prévu d’améliorer les performances de l’exécution de ce plugin. Il apparait pertinent de rendre parallélisable le traitement des ingests en cours.
Détail du handler : ListLifecycleTraceabilityActionHandler¶
Description¶
Ce handler permet de préparer les listes de cycles de vie des groupes d’objets, et des unités archivistiques. Il permet aussi la récupération des informations de la dernière opération de sécurisation des cycles de vie.
exécution¶
Une première requête permet de récupérer la dernière opération de sécurisation des cycles de vie. S’il en existe une, on en tire les informations importantes (date d’exécution, etc.), l’opération sera exportée dans un fichier json. S’il n’en existe pas, une date minimale (LocalDateTime.MIN) sera utilisée pour la suite du process.
A partir de cette date obtenue, on va interroger Mongo et récupérer 2 listes de cycles de vie (groupes d’objets et units) qui n’ont pas encore été sécurisés.
final Query parentQuery = QueryHelper.gte("evDateTime", startDate.toString());
final Query sonQuery = QueryHelper.gte(LogbookDocument.EVENTS + ".evDateTime", startDate.toString());
final Select select = new Select();
select.setQuery(QueryHelper.or().add(parentQuery, sonQuery));
select.addOrderByAscFilter("evDateTime");
A partir de ces 2 listes, on va créer X (X étant le nombre de GoT ou d’units) fichiers dans les sous répertoires GUID/ObjectGroup et GUID/UnitsWithoutLevel. Ces fichiers json seront utilisés plus tard dans le workflow, dans le cadre de la distribution.
En traitant les différents cycles de vie, on en conclut les informations suivantes :
- date maximum d’un cycle de vie traité
- nombre de cycles de vie liés aux groupes d’objets traités
- nombre de cycles de vie liés aux units traités
Ces informations, combinées à la startDate obtenue précédemment, sont enregistrées dans un fichier json Operations/traceabilityInformation.json.
En résumé, voici les output de ce handler :
- GUID/Operations/lastOperation.json -> informations sur la dernière opération de sécurisation des cycles de vie
- GUID/Operations/traceabilityInformation.json -> informations sur la sécurisation en cours
- GUID/ObjectGroup/GUID_OG_n.json -> n fichiers json représentant n cycles de vie des groupes d’objets
- GUID/UnitsWithoutLevel/GUID_AU_n.json -> n fichiers json représentant n cycles de vie des units.
Détail du plugin : CreateObjectSecureFileActionPlugin¶
Description¶
Ce plugin permet de traiter, groupe d’objet par groupe d’objet, et de créer un fichier sécurisé. Chaque fichier sécurisé créé, sera par la suite, dans l’étape de finalisation, traité et intégré dans un fichier global.
exécution¶
La première étape de ce plugin, consiste à récupérer le fichier json GUID/ObjectGroup/GUID_OG_n.json. A partir de ce json, représentant le cycle de vie devant être traité, on va créer un fichier sécurisé. Ce fichier sécurisé contient une ligne unique, organisée de la façon suivante :
- [ID de l’opération provoquant la création du cycle de vie] | [Type du process (INGEST / UPDATE)] | [Date de l’évenement] | [ID du cycle de vie]
- [Statut final du cycle de vie] | [Hash global du cycle de vie] | [Hash du groupe d’objet associé] | [Liste des versions de l’objet]
Ce fichier généré est ensuite sauvegardé sur le workspace dans : LFCObjects.
Voici l’output de ce plugin : - GUID/LFCObjects/GUID_OG.json
Détail du plugin : CreateUnitSecureFileActionPlugin¶
Description¶
Ce plugin permet de traiter, cycle de vie unit par cycle de vie unit, et de créer un fichier sécurisé. Chaque fichier sécurisé créé, sera par la suite, dans l’étape de finalisation, traité et intégré dans un fichier global.
exécution¶
La première étape de ce plugin, consiste à récupérer le fichier json GUID/UnitsWithoutLevel/GUID_AU_n.json. A partir de ce json, représentant le cycle de vie devant être traité, on va créer un fichier sécurisé. Ce fichier sécurisé contient une ligne unique, organisée de la façon suivante :
- [ID de l’opération provoquant la création du cycle de vie] | [Type du process (INGEST / UPDATE)] | [Date de l’évenement] | [ID du cycle de vie]
- [Statut final du cycle de vie] | [Hash global du cycle de vie] | [Hash de l’archive unit associé] |
Ce fichier généré est ensuite sauvegardé sur le workspace dans : LFCObjects.
Voici l’output de ce plugin :
- GUID/LFCUnits/GUID_AU.json
Détail du plugin : CheckClassificationLevelActionPlugin¶
Description¶
Ce plugin permet de vérifier que le niveau de classification déclaré par les ArchiveUnit du manifeste est conforme à ceux attendus dans la configuration de la plate-forme
exécution¶
A partir de l’Id de l’id de l’Archive Unit à vérifier, le plugin va télécharger le fichier json associé dans le Workspace. Par la suite, il va vérifier le champ ClassificationLevel par rapport au celui dans ClassificationLevelService
Détail du handler : FinalizeLifecycleTraceabilityActionHandler¶
Description¶
Ce handler permet de finaliser la sécurisation des cycles de vie, en générant un fichier zip, et en le sauvegardant sur les offres de stockage.
exécution¶
Le Handler va tout d’abord récupérer les fichiers json qui ont été générés dans l’étape 1 :
- le fichier json de la dernière opération de sécurisation
- le fichier json contenant les informations de la sécurisation en cours
Ensuite, un objet TraceabilityFile va être généré. Cet objet représente un ZipArchiveOutputStream contenant 4 fichiers :
- global_lifecycles.txt : contenant l’aggrégation des informations des cycles de vie sécurisés.
- additional_information.txt : contenant des informations génériques (nombre de cycles de vie traités, startDate + endDate)
- computing_information.txt : contenant les informations de hachage (hash actuel, hash de la dernière opération de sécurisation, hash d’il y a un mois, et d’il y a un an)
- token.tsp : tampon d’horodatage du fichier de sécurisation
Les informations nécessaires sont récupérées pour générer et remplir les 4 différents fichiers :
global_lifecycles.txt : Ce fichier va être obtenu de la manière suivante :
- On récupère la liste des fichiers présents dans les 2 sous-répertoires (GUID/LFCUnits/ et GUID/LFCObjects/).
- Pour chaque fichier récupéré, on récupère son contenu et on ajoute une ligne au fichier global_lifecycles.txt
- Le premier élément traité sera utilisé pour en conclure un hash, qui sera identifié étant comme le hashRoot du fichier.
additional_information.txt : Le fichier json Operations/traceabilityInformation.json va être utilisé pour construire le fichier de la manière suivante :
- numberOfElements : nombre de cycles de vie traités
- startDate : startDate (soit égale à LocalDateTime.MIN, soit à la plus petite date des cycles de vie traités)
- endDate : plus grande date des cycles de vie traités.
- securisationVersion : version du format du fichier de traçabilité
computing_information.txt : Ce fichier va être rempli de la manière suivante : - currentHash : le hash du cycle de vie traité en premier - previousTimestampToken : le tampon d’horodatage de la dernière opération de sécurisation (sera obtenu en analysant le fichier json Operations/lastOperation.json) - peut être vide. - previousTimestampTokenMinusOneMonth : le tampon d’horodatage de la dernière opération de sécurisation datant d’un mois. Une recherche dans la base LogbookOperations est effectuée. - previousTimestampTokenMinusOneYear : le tampon d’horodatage de la dernière opération de sécurisation datant d’un an. Une recherche dans la base LogbookOperations est effectuée.
token.tsp : Le fichier token.tsp, contiendra simplement le tampon d’horodatage de l’opération de sécurisation en cours. Le tampon d’horodatage est obtenu en utilisant le timestampGenerator de Vitam. Cela nécéssite d’avoir un certificat présent dans la configuration du worker (configuration via verify-timestamp.conf spécifiant le p12 + le password). Les différents hash nécessaires sont : - rootHash : hash du premier cycle de vie traité dans l’opération en cours - hash1 : hash de la dernière opération de sécurisation - hash2 : hash de la dernière opération de sécurisation datant d’un mois - hash3 : hash de la dernière opération de sécurisation datant d’un an (hash1, hash2 et hash3 peuvent être null, si aucune opération n’a été effectué dans le passé)
final String hash = joiner.join(rootHash, hash1, hash2, hash3);
final DigestType digestType = VitamConfiguration.getDefaultTimestampDigestType();
final Digest digest = new Digest(digestType);
digest.update(hash);
final byte[] hashDigest = digest.digest();
final byte[] timeStampToken = timestampGenerator.generateToken(hashDigest, digestType, null);
Le fichier zip est finalement créé et sauvegardé sur le Workspace. Ensuite, il sera sauvegardé sur les offres de stockage.
Bien évidemment l’opération est enregistré dans le logbook. Les informations de Traceability sont enregistrés dans le champ evDetData. Elles seront utilisés par la suite, pour les sécurisations futures.
Détail du handler : GenerateAuditReportActionHandler¶
Description¶
Ce handler permet de générer le rapport d’audit
exécution¶
La rapport commence par une partie généraliste contenant : * Le GUID de l’opération d’audit à l’origine de ce rapport * Le tenant sur lequel s’est exécuté l’audit * Le message (outMessg) du JDO de l’opération de la dernière étape (succès ou échec de l’audit) * Le statut final (outcome) de l’opération * La date et l’heure du début de la génération du rapport (evDateTime de l’evénement) * L’identifiant de ce sur quoi porte l’audit (tenant/SP/opération)
Deuxièmement, la rapport contient les cas OK, KO, Warning et Fatal de toutes les actions d’audit sur les objets
//le cas OK
source.add(JsonHandler.createObjectNode().put(_TENANT, res.get(_TENANT).asText())
.put(ORIGINATING_AGENCY, agIdExtNode.get("originatingAgency").asText())
.put(EV_ID_PROC, res.get(EV_ID_PROC).asText()));
//le cas KO
reportKO.add(JsonHandler.createObjectNode().put("IdOp", event.get(EV_ID_PROC).asText())
.put(ID_GOT, event.get("obId").asText())
.put(ID_OBJ, error.get(ID_OBJ).asText())
.put(USAGE, error.get(USAGE).asText())
.put(ORIGINATING_AGENCY, originatingAgency)
.put(OUT_DETAIL, event.get("outDetail").asText()));
Détail du plugin : AuditCheckObjectPlugin¶
Description¶
Ce plugin permet de contrôler les objets dans le cadre d’un audit consultatif
exécution¶
Selon le parametre auditActions, il va appeler le plugin, soit CheckExistenceObjectPlugin, soit CheckIntegrityObjectPlugin
Détail du plugin : CheckExistenceObjectPlugin¶
Description¶
Ce plugin permet de contrôler l’existence d’un objet dans le cadre d’un audit
exécution¶
Le plugin va tester l’existence de la cohérence entre les offres de stockages déclarées dans un GOT et les offres de stockages relatives à la stratégie de stockage connue du moteur de stockage
JsonNode storageInformation = version.get("_storage");
final String strategy = storageInformation.get("strategyId").textValue();
final List<String> offerIds = new ArrayList<>();
for (JsonNode offerId : storageInformation.get("offerIds")) {
offerIds.add(offerId.textValue());
}
if (!storageClient.exists(strategy, StorageCollectionType.OBJECTS,
version.get("_id").asText(), offerIds)) {
nbObjectKO += 1;
} else {
nbObjectOK += 1;
}
Détail du plugin : CheckIntegrityObjectPlugin¶
Description¶
Ce plugin permet de contrôler l’intégrité d’un objet archivé dans le cadre d’un audit
exécution¶
Dans le cadre de l’audit, on va vérifier une empreinte d’un objet est bien celle de l’objet audité, en fonction de son offre de stockage.
JsonNode offerToMetadata = storageClient.getObjectInformation(strategy, version.get("_id").asText(), offerIds);
for (String offerId : offerIds) {
String digest = null;
JsonNode metadata = offerToMetadata.findValue(offerId);
if (metadata != null){
digest = metadata.get("digest").asText();
} else {
checkDigest = false;
continue;
}
if (messageDigest.equals(digest)) {
checkDigest = true;
} else {
checkDigest = false;
}
}
Worker-common¶
Le worker-common contient majoritairement des classes utilitaires. A terme, il faudra que SedaUtils notamment soit « retravaillé » pour que les différentes méthodes soit déplacées dans les bons Handlers.
Worker-client¶
Le worker client contient le code permettant l’appel vers les API Rest offert par le worker. Pour le moment une seule méthode est offerte : submitStep. Pour plus de détail, voir la partie worker-client.