Skip navigation links

Vitam API Reference (2.6.1)

This Javadoc contains the Java API for Vitam software.

See: Description

Ihm Demo 
Package Description
fr.gouv.vitam.ihmdemo.appserver
Provides the web server application and configuration for the IHM Demo module and the rest resource it uses
fr.gouv.vitam.ihmdemo.common.api
Provides IHM Demo API Common classes
fr.gouv.vitam.ihmdemo.common.pagination
Provides IHM Demo Pagination Common classes
fr.gouv.vitam.ihmdemo.common.utils  
fr.gouv.vitam.ihmdemo.core
Provides IHM core classes
Ihm Recette 
Package Description
fr.gouv.vitam.ihmrecette.appserver
Provides the web server application and configuration for the IHM Recette module and the rest resource it uses
fr.gouv.vitam.ihmrecette.appserver.applicativetest  
fr.gouv.vitam.ihmrecette.appserver.performance
Provides the web server application and configuration for the IHM Recette module and the rest resource it uses
fr.gouv.vitam.ihmrecette.appserver.populate
Provides the web server application and configuration for the IHM Recette module and the rest resource it uses
Ingest External Client 
Package Description
fr.gouv.vitam.ingest.external.client
Provides Ingest External Client interface, factory and implementations.
Ingest 
Package Description
fr.gouv.vitam.ingest.external.api
Provides the API interface and an exception class for the Ingest External module
fr.gouv.vitam.ingest.external.api.exception
Package Ingest External Exception
fr.gouv.vitam.ingest.external.common.config
Provides Ingest external common configuration classes
fr.gouv.vitam.ingest.external.common.exception  
fr.gouv.vitam.ingest.external.common.model.response
Provides Ingest external common model response classes
fr.gouv.vitam.ingest.external.common.util
Provides Ingest external common utility classes
fr.gouv.vitam.ingest.external.core
Provides core implementation for the Ingest External module.
fr.gouv.vitam.ingest.external.rest
Provides the web server application for the Ingest External module and the rest resources it uses.
fr.gouv.vitam.ingest.internal.api.response
Provides Internal Ingest Response model classes
fr.gouv.vitam.ingest.internal.client
Provides Ingest Internal Client interface, configuration, factory and implementations.
fr.gouv.vitam.ingest.internal.common.exception
Provides Ingest Internal common exception classes
fr.gouv.vitam.ingest.internal.upload.rest
Provides the web server application and configuration for the Ingest Internal module and the rest resources it uses.
Access External Client 
Package Description
fr.gouv.vitam.access.external.client
Provides
fr.gouv.vitam.access.external.client.v2  
Access 
Package Description
fr.gouv.vitam.access.external.api
Provides :
fr.gouv.vitam.access.external.common.exception
Provides exception classes used for the Access External module.
fr.gouv.vitam.access.external.rest
Provides the web server application for the Access External module and the rest resources it uses.
fr.gouv.vitam.access.external.rest.v2.rest  
fr.gouv.vitam.access.internal.api
Provides module and resource interfaces and a binary data POJO for the Access Internal module.
fr.gouv.vitam.access.internal.client
Provides access internal client interface, factory and implementations.
fr.gouv.vitam.access.internal.common.exception
Provides exception classes used for the Access Internal module.
fr.gouv.vitam.access.internal.common.model
Provides common configuration classes for the Access Internal module.
fr.gouv.vitam.access.internal.core
Provides core implementation for the Access Internal module.
fr.gouv.vitam.access.internal.rest
Provides the web server application for the Access Internal module and the rest resources it uses.
fr.gouv.vitam.access.internal.serve.exception  
fr.gouv.vitam.access.internal.serve.filter  
Common 
Package Description
fr.gouv.vitam.common
General utility classes as FileUtil, SystemPropertyUtil and UUID support
fr.gouv.vitam.common.accesslog  
fr.gouv.vitam.common.alert  
fr.gouv.vitam.common.auth.core.authc
Shiro x509 VitamAuthentication Modules
fr.gouv.vitam.common.auth.core.realm
Shiro Realm X509
fr.gouv.vitam.common.auth.web.filter
Shiro Filter for x509 client certificate authentication
fr.gouv.vitam.common.cache  
fr.gouv.vitam.common.client
Contains generic VitamClient and associated basic implementation used as base for every specific client module.
fr.gouv.vitam.common.client.configuration
Contains Client configuration classes
fr.gouv.vitam.common.collection
Some specific Vitam Collection
fr.gouv.vitam.common.configuration  
fr.gouv.vitam.common.database.api
Provides common database API
fr.gouv.vitam.common.database.api.impl
Provides common database API implementations
fr.gouv.vitam.common.database.builder.facet
Provides facet classes
fr.gouv.vitam.common.database.builder.query
Provides query classes
fr.gouv.vitam.common.database.builder.query.action
Provides classes for DSL operations
fr.gouv.vitam.common.database.builder.request
Provides an abstract request class
fr.gouv.vitam.common.database.builder.request.configuration
Provides configuration classes containing GlobalDatas and ParserTokens
fr.gouv.vitam.common.database.builder.request.exception
Provides exception classes that could be thrown during Requests construction
fr.gouv.vitam.common.database.builder.request.multiple
Provides database builders for multiple query requests
fr.gouv.vitam.common.database.builder.request.single
Provides database builders for single query requests
fr.gouv.vitam.common.database.collections
Provides common database collection
fr.gouv.vitam.common.database.facet.model
Facet Model Package containing POJO for facet results
fr.gouv.vitam.common.database.index.model
Index Model Package containing POJO for indexing results
fr.gouv.vitam.common.database.model  
fr.gouv.vitam.common.database.offset
Provides common database for offset collection
fr.gouv.vitam.common.database.parameter
Database parameter package
fr.gouv.vitam.common.database.parser.facet
Provides facets to be used within the Vitam DSL
fr.gouv.vitam.common.database.parser.query
Provides queries to be used within the Vitam DSL
fr.gouv.vitam.common.database.parser.query.action
Provides actions to be used within the Vitam DSL
fr.gouv.vitam.common.database.parser.query.helper
Provides a query helper
fr.gouv.vitam.common.database.parser.request
Provides a global and an abstract parser in order to parse requests
fr.gouv.vitam.common.database.parser.request.adapter
Provides database parser adapters for request
fr.gouv.vitam.common.database.parser.request.multiple
Provides database parsers for multiple query requests
fr.gouv.vitam.common.database.parser.request.single
Provides database parsers for single query requests
fr.gouv.vitam.common.database.server
Database server package in vitam
fr.gouv.vitam.common.database.server.elasticsearch
Elasticsearch server package in Vitam
fr.gouv.vitam.common.database.server.elasticsearch.model  
fr.gouv.vitam.common.database.server.mongodb
MongoDB server package in Vitam
fr.gouv.vitam.common.database.server.query  
fr.gouv.vitam.common.database.translators
Provides translators from Vitam DSL to native DSL
fr.gouv.vitam.common.database.translators.elasticsearch
Provides translators for Elasticsearch
fr.gouv.vitam.common.database.translators.mongodb
Provides translators for MongoDB
fr.gouv.vitam.common.database.utils  
fr.gouv.vitam.common.digest
Digest support package for Vitam
fr.gouv.vitam.common.dsl.schema  
fr.gouv.vitam.common.dsl.schema.meta  
fr.gouv.vitam.common.dsl.schema.validator  
fr.gouv.vitam.common.elasticsearch  
fr.gouv.vitam.common.error
Contains
- services codes and their name
- domains codes and their name
- public Vitam codes
fr.gouv.vitam.common.exception
Common Exception package
fr.gouv.vitam.common.external.client
Contains generic VitamClient and associated basic implementation used as base for every specific client module.
fr.gouv.vitam.common.external.client.configuration
Contains Client configuration classes
fr.gouv.vitam.common.format.identification
Provides common interface, factory and implementations for the Format Identification module
fr.gouv.vitam.common.format.identification.exception
Provides Exception classes that could be thrown in the Format Identification module
fr.gouv.vitam.common.format.identification.model
Provides common configuration and response classes for the Format Identification module
fr.gouv.vitam.common.format.identification.siegfried
Provides the Siegfried implementation for the Format Identification module
fr.gouv.vitam.common.graph
Graph package contains classes of cycle detection and indexing order (longestPath)
fr.gouv.vitam.common.guid
Global Unique Identifier support for Vitam
fr.gouv.vitam.common.i18n
Vitam Internationalization package
fr.gouv.vitam.common.iterables  
fr.gouv.vitam.common.json
Json support
fr.gouv.vitam.common.junit
Specific Package for Junit Support
fr.gouv.vitam.common.lifecycle  
fr.gouv.vitam.common.logging
Logging Module largely inspired from Netty
fr.gouv.vitam.common.lru
LRU HashMap implementation
fr.gouv.vitam.common.mapping.dip  
fr.gouv.vitam.common.mapping.serializer  
fr.gouv.vitam.common.metrics
This package contains the metric classes used in VITAM
fr.gouv.vitam.common.model
This package contains simple POJOs and DTOs that may be shared commonly by all vitam internal components
fr.gouv.vitam.common.model.administration
Provides common public Model classes for the administration module.
fr.gouv.vitam.common.model.administration.preservation  
fr.gouv.vitam.common.model.dip  
fr.gouv.vitam.common.model.elimination  
fr.gouv.vitam.common.model.logbook
Provides common public Model classes for the Logbook module.
fr.gouv.vitam.common.model.massupdate  
fr.gouv.vitam.common.model.objectgroup  
fr.gouv.vitam.common.model.preservation  
fr.gouv.vitam.common.model.processing
Provides common public Model classes for the Processing module.
fr.gouv.vitam.common.model.unit  
fr.gouv.vitam.common.mongo  
fr.gouv.vitam.common.parameter
Contains all classes related to parameter objects
fr.gouv.vitam.common.performance  
fr.gouv.vitam.common.security
Security package for Vitam
fr.gouv.vitam.common.security.codec
Encode/decode URL using platform secret
fr.gouv.vitam.common.security.filter
Security Filters
fr.gouv.vitam.common.security.merkletree  
fr.gouv.vitam.common.security.rest  
fr.gouv.vitam.common.security.waf
Web application firewall package which uses owasp esapi Filter for header, body (json and inputstream) and parameter
fr.gouv.vitam.common.server
Contains generic VitamServer and associated basic implementation to be used as a base for every module specific application server.
fr.gouv.vitam.common.server.application
Contains generic VitamApplication interface and an abstract implementation to be used as a base for every module specific web application.
fr.gouv.vitam.common.server.application.configuration
Contains the VitamApplicationConfiguration and all basic configuration sub-interface and implementations such as DbConfiguration and DbConfigurationImpl.
fr.gouv.vitam.common.server.application.junit
Helper for Junit tests using Vitam Applications
fr.gouv.vitam.common.server.application.resources
Standard Vitam Application Standard Resources
fr.gouv.vitam.common.serverv2  
fr.gouv.vitam.common.serverv2.application  
fr.gouv.vitam.common.serverv2.metrics  
fr.gouv.vitam.common.shiro.junit
Helpers for Junit tests using Shiro
fr.gouv.vitam.common.storage
Provides an abstract core, implementation and configuration for the common Storage module.
fr.gouv.vitam.common.storage.cas.container.api
Provides API classes for the Workspace module
fr.gouv.vitam.common.storage.cas.container.jcloud  
fr.gouv.vitam.common.storage.compress
Provides a factory dealing with archives in different formats for the Workspace module.
fr.gouv.vitam.common.storage.constants
Provides classes contains constants values for the common storage Module module.
fr.gouv.vitam.common.storage.exception  
fr.gouv.vitam.common.storage.filesystem
Provides a FileSystem implementation for storage modules.
fr.gouv.vitam.common.storage.filesystem.v2
Provides a FileSystem implementation for storage modules have to manage up to 500 millions of files
fr.gouv.vitam.common.storage.filesystem.v2.metadata  
fr.gouv.vitam.common.storage.filesystem.v2.metadata.object
Manages the metadata of the object
fr.gouv.vitam.common.storage.s3
Provides S3 implementations for the storage modules.
fr.gouv.vitam.common.storage.swift
Provides a Swift implementation for the storage modules.
fr.gouv.vitam.common.storage.tapelibrary  
fr.gouv.vitam.common.storage.utils
Provides Utils classes for the common
fr.gouv.vitam.common.stream
This package concerns Common Stream handling as Helpers for common actions or MultipleInputStream multiplexer.
fr.gouv.vitam.common.tenant.filter
Tenant Filters
fr.gouv.vitam.common.thread
Vitam Thread package facility
fr.gouv.vitam.common.timestamp
Vitam time stamp generation package
fr.gouv.vitam.common.tmp  
fr.gouv.vitam.common.utils  
fr.gouv.vitam.common.xml  
fr.gouv.vitam.common.xsrf.filter
Security Filters
Functional administration 
Package Description
fr.gouv.vitam.functional.administration.accession.register.core
Provides core for the Accession register module
fr.gouv.vitam.functional.administration.accession.register.symbolic  
fr.gouv.vitam.functional.administration.agencies.api  
fr.gouv.vitam.functional.administration.archiveunitprofiles.api  
fr.gouv.vitam.functional.administration.archiveunitprofiles.api.impl  
fr.gouv.vitam.functional.administration.archiveunitprofiles.core  
fr.gouv.vitam.functional.administration.client
Provides Functional administration client interface, factory and implementations.
fr.gouv.vitam.functional.administration.common
Provides common classes for the Functional Administration module.
fr.gouv.vitam.functional.administration.common.api  
fr.gouv.vitam.functional.administration.common.counter  
fr.gouv.vitam.functional.administration.common.exception
Provides Exception classes for the Functional Administration module.
fr.gouv.vitam.functional.administration.common.impl  
fr.gouv.vitam.functional.administration.common.server
Provides common server classes for the Functional Administration module
fr.gouv.vitam.functional.administration.context.api  
fr.gouv.vitam.functional.administration.context.core  
fr.gouv.vitam.functional.administration.contract.api  
fr.gouv.vitam.functional.administration.contract.core  
fr.gouv.vitam.functional.administration.format.core
Provides core classes of functional administration format module
fr.gouv.vitam.functional.administration.format.model  
fr.gouv.vitam.functional.administration.griffin  
fr.gouv.vitam.functional.administration.migration.r7r8  
fr.gouv.vitam.functional.administration.ontologies.api
Service interface for validating and managing ontologies.
fr.gouv.vitam.functional.administration.ontologies.api.impl
Service implementation for validating and managing ontologies.
fr.gouv.vitam.functional.administration.ontologies.client
Provides Functional administration ontologies client interface, factory and implementations.
fr.gouv.vitam.functional.administration.ontologies.core
Management and validation of ontologies.
fr.gouv.vitam.functional.administration.profile.api  
fr.gouv.vitam.functional.administration.profile.api.impl  
fr.gouv.vitam.functional.administration.profile.core  
fr.gouv.vitam.functional.administration.rest
Provides the web server application and configuration for the Functional administration module and the rest resource it uses
fr.gouv.vitam.functional.administration.rules.core
Provides core classes of functional administration rules module
fr.gouv.vitam.functional.administration.rules.main
Provides core classes of functional administration rules module
fr.gouv.vitam.functional.administration.security.profile.core  
Logbook 
Package Description
fr.gouv.vitam.logbook.administration.audit.core
Provides the core classes for the Logbook Administration module
fr.gouv.vitam.logbook.administration.audit.exception  
fr.gouv.vitam.logbook.administration.audit.main
Provides the core classes for the Logbook Administration module
fr.gouv.vitam.logbook.administration.core
Provides the core classes for the Logbook Administration module
fr.gouv.vitam.logbook.administration.core.api  
fr.gouv.vitam.logbook.administration.core.impl  
fr.gouv.vitam.logbook.administration.main
Povides command line (main) to control Traceability lifecycle process for the Logbook Administration Lifecycle module
fr.gouv.vitam.logbook.common  
fr.gouv.vitam.logbook.common.client
Provides client common classes for the Logbook module
fr.gouv.vitam.logbook.common.exception
Provides common Exception classes for the Logbook module
fr.gouv.vitam.logbook.common.model
logbook model package
fr.gouv.vitam.logbook.common.model.coherence  
fr.gouv.vitam.logbook.common.model.reconstruction
Provides model classes for Logbook module reconstruction
fr.gouv.vitam.logbook.common.parameters
Provides common parameters, helpers and factory classes used for the Logbook module
fr.gouv.vitam.logbook.common.server
Provides Common Server classes for the Logbook module
fr.gouv.vitam.logbook.common.server.database.collections
Provides Logbook collection classes
fr.gouv.vitam.logbook.common.server.database.collections.request
Provides specific Request classes for the Logbook module
fr.gouv.vitam.logbook.common.server.exception
Provides Server Exception classes for the Logbook module
fr.gouv.vitam.logbook.common.server.reconstruction
Provides reconstruction service classes for Logbook server module
fr.gouv.vitam.logbook.common.traceability  
fr.gouv.vitam.logbook.lifecycles.api
Provides API classes for the Logbook Lifecycles module
fr.gouv.vitam.logbook.lifecycles.client
Provides Logbook Lifecycles client interface, factory and implementations.
fr.gouv.vitam.logbook.lifecycles.core
Provides core implementation for the Logbook Lifecycles module.
fr.gouv.vitam.logbook.operations.api
Provides API classes for the Logbook Operations module
fr.gouv.vitam.logbook.operations.client
Provides Logbook Operations client interface, factory and implementations.
fr.gouv.vitam.logbook.operations.core
Provides core implementation for the Logbook Operations module.
fr.gouv.vitam.logbook.rest
Provides the web server application for the Logbook module and the rest resources it uses.
Metadata 
Package Description
fr.gouv.vitam.metadata.api
Provides API classes for the Metadata module
fr.gouv.vitam.metadata.api.config
Provides API configuration classes for the Metadata module
fr.gouv.vitam.metadata.api.exception
Provides exception classes used for the Metadata module.
fr.gouv.vitam.metadata.api.model  
fr.gouv.vitam.metadata.client
Provides Metadata client interface, factory and implementations.
fr.gouv.vitam.metadata.core
Provides
fr.gouv.vitam.metadata.core.database.collections
Provides
fr.gouv.vitam.metadata.core.database.configuration
Provides Database configuration class for Metadata module
fr.gouv.vitam.metadata.core.graph  
fr.gouv.vitam.metadata.core.graph.api  
fr.gouv.vitam.metadata.core.migration  
fr.gouv.vitam.metadata.core.model
Provides model classes for Metadata module
fr.gouv.vitam.metadata.core.reconstruction
Provides reconstruction classes for Metadata module
fr.gouv.vitam.metadata.core.rules  
fr.gouv.vitam.metadata.core.rules.model  
fr.gouv.vitam.metadata.core.trigger  
fr.gouv.vitam.metadata.core.utils
Provides utility classes for the Metadata module
fr.gouv.vitam.metadata.rest
Provides the web server application for the Metadata module and the rest resources it uses.
Processing 
Package Description
fr.gouv.vitam.processing.common
Provides common classes for the Processing module.
fr.gouv.vitam.processing.common.automation  
fr.gouv.vitam.processing.common.config
Provides common Configuration classes for the Processing module.
fr.gouv.vitam.processing.common.exception
Provides common Exception classes for the Processing module.
fr.gouv.vitam.processing.common.model
Provides common Model classes for the Processing module.
fr.gouv.vitam.processing.common.parameter
Provides common Parameters classes and utility classes for the Processing module.
fr.gouv.vitam.processing.common.utils
Provides common utility classes for the Processing module.
fr.gouv.vitam.processing.data.core
Provides core interface and implementation for the Processing Data module.
fr.gouv.vitam.processing.data.core.management  
fr.gouv.vitam.processing.distributor
Provides API classes for the Processing Engine module
fr.gouv.vitam.processing.distributor.api
Provides API classes for the Processing Distributor module
fr.gouv.vitam.processing.distributor.rest
Provides rest resource implementation for the Processing Distributor module.
fr.gouv.vitam.processing.distributor.v2  
fr.gouv.vitam.processing.engine
Processing Engine Package
fr.gouv.vitam.processing.engine.api
Provides API classes for the Process Distributor module
fr.gouv.vitam.processing.engine.core
Provides core implementation for the Processing Engine module.
fr.gouv.vitam.processing.engine.core.monitoring
Provides core interface and implementation for the Processing Monitoring module.
fr.gouv.vitam.processing.engine.rest
Processing Engine Rest Package
fr.gouv.vitam.processing.management.api
Provides API classes for the Processing Management module
fr.gouv.vitam.processing.management.client
Provides Processing Management client interface, factory and implementations.
fr.gouv.vitam.processing.management.core
Provides core implementation for the Processing Management module.
fr.gouv.vitam.processing.management.rest
Provides the web server application and configuration for the Processing Management module and the rest resource it uses
fr.gouv.vitam.processing.model
Specific model class for the distributor
Storage Driver / Offer 
Package Description
fr.gouv.vitam.driver.fake
Provides a fake Driver implementation for tests purpose
fr.gouv.vitam.storage.driver
Provides interface describing how drivers should be implemented for the Storage driver module
fr.gouv.vitam.storage.driver.constants
Provides constants, enums and other kind of constants that may be used globally by the drivers for the Storage driver module
fr.gouv.vitam.storage.driver.exception
Provides Exception classes for the Storage driver module
fr.gouv.vitam.storage.driver.model
Provides Model classes such as Requests and Results classes for the Storage driver module
fr.gouv.vitam.storage.offers.core
Provides core implementation (Workspace based) for the Storage Offer Default module
fr.gouv.vitam.storage.offers.database
Provides core implementation for default offer mongo acces.
fr.gouv.vitam.storage.offers.rest
Provides the web server application and configuration for the for the Storage Offer Default module and the rest resources it uses.
fr.gouv.vitam.storage.offers.tape  
fr.gouv.vitam.storage.offers.tape.cas  
fr.gouv.vitam.storage.offers.tape.dto  
fr.gouv.vitam.storage.offers.tape.exception  
fr.gouv.vitam.storage.offers.tape.impl  
fr.gouv.vitam.storage.offers.tape.impl.catalog  
fr.gouv.vitam.storage.offers.tape.impl.drive  
fr.gouv.vitam.storage.offers.tape.impl.queue  
fr.gouv.vitam.storage.offers.tape.impl.readwrite  
fr.gouv.vitam.storage.offers.tape.impl.robot  
fr.gouv.vitam.storage.offers.tape.inmemoryqueue  
fr.gouv.vitam.storage.offers.tape.parser  
fr.gouv.vitam.storage.offers.tape.pool  
fr.gouv.vitam.storage.offers.tape.process  
fr.gouv.vitam.storage.offers.tape.rest  
fr.gouv.vitam.storage.offers.tape.retry  
fr.gouv.vitam.storage.offers.tape.spec  
fr.gouv.vitam.storage.offers.tape.utils  
fr.gouv.vitam.storage.offers.tape.worker  
fr.gouv.vitam.storage.offers.tape.worker.tasks  
fr.gouv.vitam.storage.offers.workspace.driver
Provides implementation of the driver for the Workspace Driver module.
Storage Engine 
Package Description
fr.gouv.vitam.storage.engine.client
Provides Storage Engine client interface, factory and implementations.
fr.gouv.vitam.storage.engine.client.exception
Provides Storage Engine client Exception classes.
fr.gouv.vitam.storage.engine.common
Provides common constants classes for the Storage Engine module
fr.gouv.vitam.storage.engine.common.collection  
fr.gouv.vitam.storage.engine.common.exception
Provides common Exception classes for the Storage Engine module.
fr.gouv.vitam.storage.engine.common.header
Contains Storage common header processing
fr.gouv.vitam.storage.engine.common.model
Provides common Model classes for the Storage Engine module.
fr.gouv.vitam.storage.engine.common.model.request
Provides common Request classes for the Storage Engine module.
fr.gouv.vitam.storage.engine.common.model.response
Provides common Response classes for the Storage Engine module.
fr.gouv.vitam.storage.engine.common.referential
Provides common Referential interfaces and factories for the Storage Engine module :
fr.gouv.vitam.storage.engine.common.referential.model
Provides common Referential Model classes for the Storage Engine module.
fr.gouv.vitam.storage.engine.common.utils  
fr.gouv.vitam.storage.engine.server.accesslogger  
fr.gouv.vitam.storage.engine.server.distribution
Provides a Distribution interface for the Storage Engine Server module
fr.gouv.vitam.storage.engine.server.distribution.impl
Provides a Distribution implementation for the Storage Engine Server module
fr.gouv.vitam.storage.engine.server.distribution.impl.bulk  
fr.gouv.vitam.storage.engine.server.exception  
fr.gouv.vitam.storage.engine.server.offersynchronization  
fr.gouv.vitam.storage.engine.server.rest
Provides the web server application and configuration for the Storage Engine Server module and the rest resources it uses.
fr.gouv.vitam.storage.engine.server.spi
Provides the SPI implementation and configuration for the Storage Engine Server module
fr.gouv.vitam.storage.engine.server.spi.mapper
Provides the SPI mapper implementation and configuration for the Storage Engine Server module, allowing the persistence of association between drivers and offers
fr.gouv.vitam.storage.engine.server.storagelog  
fr.gouv.vitam.storage.engine.server.storagelog.parameters
Provides logbook parameters classes used for the Storage Engine Server module
fr.gouv.vitam.storage.engine.server.storagetraceability  
Worker 
Package Description
fr.gouv.vitam.worker.client
Provides Worker client interface, configuration, factory and implementations.
fr.gouv.vitam.worker.client.exception
Provides exception classes used for the Worker Client module
fr.gouv.vitam.worker.common
Provides common classes for the Worker module.
fr.gouv.vitam.worker.common.utils
Provides common utility classes for the Worker module.
fr.gouv.vitam.worker.core
Provides core classes for the Worker Core module.
fr.gouv.vitam.worker.core.api
Provides API definition for the Worker Core module.
fr.gouv.vitam.worker.core.distribution  
fr.gouv.vitam.worker.core.exception  
fr.gouv.vitam.worker.core.extractseda  
fr.gouv.vitam.worker.core.handler
Provides Handler classes for the Worker Core module
fr.gouv.vitam.worker.core.impl
Provides
fr.gouv.vitam.worker.core.mapping  
fr.gouv.vitam.worker.core.plugin
Plugin package in worker module
fr.gouv.vitam.worker.core.plugin.audit
Provides classes for the Audit Workflow.
fr.gouv.vitam.worker.core.plugin.audit.exception  
fr.gouv.vitam.worker.core.plugin.audit.model  
fr.gouv.vitam.worker.core.plugin.dip  
fr.gouv.vitam.worker.core.plugin.elimination  
fr.gouv.vitam.worker.core.plugin.elimination.exception  
fr.gouv.vitam.worker.core.plugin.elimination.model  
fr.gouv.vitam.worker.core.plugin.elimination.report  
fr.gouv.vitam.worker.core.plugin.evidence  
fr.gouv.vitam.worker.core.plugin.evidence.exception  
fr.gouv.vitam.worker.core.plugin.evidence.report  
fr.gouv.vitam.worker.core.plugin.lfc_traceability  
fr.gouv.vitam.worker.core.plugin.massprocessing  
fr.gouv.vitam.worker.core.plugin.migration  
fr.gouv.vitam.worker.core.plugin.preservation  
fr.gouv.vitam.worker.core.plugin.preservation.model  
fr.gouv.vitam.worker.core.plugin.preservation.service  
fr.gouv.vitam.worker.core.plugin.probativevalue  
fr.gouv.vitam.worker.core.plugin.probativevalue.pojo  
fr.gouv.vitam.worker.core.plugin.reclassification  
fr.gouv.vitam.worker.core.plugin.reclassification.dsl  
fr.gouv.vitam.worker.core.plugin.reclassification.exception  
fr.gouv.vitam.worker.core.plugin.reclassification.model  
fr.gouv.vitam.worker.core.plugin.reclassification.utils  
fr.gouv.vitam.worker.core.utils  
fr.gouv.vitam.worker.server
Worker Server Package
fr.gouv.vitam.worker.server.registration
Provides classes used for registration of current worker to the processing.
fr.gouv.vitam.worker.server.rest
Provides the web server application for the Worker Server module and the rest resources it uses.
Workspace 
Package Description
fr.gouv.vitam.workspace.api.exception
Provides Exception classes for the Workspace module
fr.gouv.vitam.workspace.api.model
Provides Model classes for the Workspace module
fr.gouv.vitam.workspace.client
Provides Workspace client factory and implementations.
fr.gouv.vitam.workspace.common
Provides common classes for the Workspace module.
fr.gouv.vitam.workspace.common.compress
Provides a factory dealing with archives in different formats for the Workspace module.
fr.gouv.vitam.workspace.rest
Provides the web server application for the Workspace module and the rest resources it uses.
Other Packages 
Package Description
fr.gouv.vitam.batch.report.client  
fr.gouv.vitam.batch.report.exception  
fr.gouv.vitam.batch.report.model  
fr.gouv.vitam.batch.report.model.entry  
fr.gouv.vitam.batch.report.rest  
fr.gouv.vitam.batch.report.rest.repository  
fr.gouv.vitam.batch.report.rest.resource  
fr.gouv.vitam.batch.report.rest.server  
fr.gouv.vitam.batch.report.rest.service  
fr.gouv.vitam.cas.container.builder
Provides the Blob store contexts builder
fr.gouv.vitam.cas.container.swift
Package used to host cas container swift implementation
fr.gouv.vitam.client  
fr.gouv.vitam.elastic.kibana.interceptor.rest  
fr.gouv.vitam.functional.administration  
fr.gouv.vitam.functionaltest.configuration  
fr.gouv.vitam.functionaltest.cucumber.report  
fr.gouv.vitam.functionaltest.cucumber.service  
fr.gouv.vitam.functionaltest.cucumber.step  
fr.gouv.vitam.security.internal.client  
fr.gouv.vitam.security.internal.common.exception  
fr.gouv.vitam.security.internal.common.model  
fr.gouv.vitam.security.internal.common.service  
fr.gouv.vitam.security.internal.exception  
fr.gouv.vitam.security.internal.filter  
fr.gouv.vitam.security.internal.rest  
fr.gouv.vitam.security.internal.rest.mapper
Provides core classes of functional administration rules module
fr.gouv.vitam.security.internal.rest.repository
Provides core classes of functional administration rules module
fr.gouv.vitam.security.internal.rest.resource
Provides core classes of functional administration rules module
fr.gouv.vitam.security.internal.rest.server
Provides core classes of functional administration rules module
fr.gouv.vitam.security.internal.rest.service
Provides core classes of functional administration rules module
fr.gouv.vitam.security.internal.rest.service.migration  
fr.gouv.vitam.storage.accesslog.backup
Copyright French Prime minister Office/SGMAP/DINSIC/Vitam Program (2015-2019) contact.vitam@culture.gouv.fr This software is a computer program whose purpose is to implement a digital archiving back-office system managing high volumetry securely and efficiently.
fr.gouv.vitam.storage.log.backup
Provides logbook interface, factory and implementation for the Storage Engine Server module in order to log every object written on different storage offers
fr.gouv.vitam.storage.log.traceability
Provides logbook interface, factory and implementation for the Storage Engine Server module in order to log every object written on different storage offers
fr.gouv.vitam.tools  
fr.vitam.plugin.custom  

This Javadoc contains the Java API for Vitam software. Most of them are intend for internal use only.

However two packages are of interest for external developpers using Vitam as a Backoffice: Access External Client and Ingest External Client.


Ihm Demo : Ihm Demo module, the default VITAM IHM application
Ihm Recette : Ihm Recette module, the non production Vitam IHM reserved to test only
Ingest External Client : Default external client for Ingest
Ingest : Ingest module
Access External Client : Default external client for Access for all actions, except Ingest
Access : Acces module
Common : Common module
Functional administration : Functional administration module
Logbook : Logbook module
Metadata : Metadata module
Processing : Processing module
Storage Driver / Offer : Storage Driver / Offer modules
Storage Engine : Storage Engine module
Worker : Worker module
Workspace : Workspace module
Other Packages : Other Packages
Skip navigation links

Copyright © 2019 Vitam. All rights reserved.