fr.gouv.vitam.logbook.lifecycles.api

Interface LogbookLifeCycles

All Known Implementing Classes:

LogbookLifeCyclesImpl

public interface LogbookLifeCycles

Core API for LifeCycles

Method Summary

Modifier and Type	Method and Description
void	bulk(LogbookCollections collections, String idOp, List<? extends LogbookLifeCycleModel> logbookLifeCycleModels) Bulk method
void	commitObjectGroup(String idOperation, String idLc) Commits ObjectGroup lifeCycle
void	commitUnit(String idOperation, String idLc) Commits Unit lifeCycle
void	createBulkLogbookLifecycle(String idOp, LogbookLifeCycleParameters[] lifecycleArray) Create one Logbook Lifecycle with already multiple sub-events
void	createObjectGroup(String idOperation, String idLc, LogbookLifeCycleObjectGroupParameters parameters) Create and insert logbook LifeCycle entries
void	createUnit(String idOperation, String idLc, LogbookLifeCycleUnitParameters parameters) Create and insert logbook LifeCycle entries
LogbookLifeCycleObjectGroup	getObjectGroupById(String idObject) Select logbook life cycle by the lifecycle's ID
LogbookLifeCycleObjectGroup	getObjectGroupByOperationIdAndByObjectGroupId(String idOperation, String idLc) Select logbook LifeCycle entry by operation
LifeCycleStatusCode	getObjectGroupLifeCycleStatus(String objectGroupId) Returns the LifeCycle Status for a given objectGroup Id
LogbookLifeCycle	getUnitById(com.fasterxml.jackson.databind.JsonNode queryDsl, LogbookCollections collection) Selects logbook life cycle by lifecycle ID (using a queryDsl)
LogbookLifeCycleUnit	getUnitById(String idUnit) Select logbook life cycle by the lifecycle's ID
LogbookLifeCycleUnit	getUnitByOperationIdAndByUnitId(String idOperation, String idLc) Select logbook LifeCycle entry by operation
LifeCycleStatusCode	getUnitLifeCycleStatus(String unitId) Returns the LifeCycle Status for a given unit Id
void	rollbackObjectGroup(String idOperation, String idLc) Rollback logbook LifeCycle entries
void	rollBackObjectGroupsByOperation(String idOperation) Removes the created object groups lifeCycles during a given operation
void	rollbackUnit(String idOperation, String idLc) Rollback logbook LifeCycle entries
void	rollBackUnitsByOperation(String idOperation) Removes the created unit lifeCycles during a given operation
List<LogbookLifeCycle>	selectObjectGroup(com.fasterxml.jackson.databind.JsonNode select, boolean sliced, LogbookCollections collection) Selects object group life cycle entries
List<LogbookLifeCycle>	selectObjectGroup(com.fasterxml.jackson.databind.JsonNode select, LogbookCollections collection) Selects object group life cycle entries
List<LogbookLifeCycle>	selectUnit(com.fasterxml.jackson.databind.JsonNode select, boolean sliced, LogbookCollections collection) Select logbook LifeCycle entries
void	updateBulkLogbookLifecycle(String idOp, LogbookLifeCycleParameters[] lifecycleArray) Update one Logbook Lifecycle with multiple sub-events It adds this new entry within the very same Logbook Lifecycle entry in "events" array.
void	updateObjectGroup(String idOperation, String idLc, LogbookLifeCycleObjectGroupParameters parameters) Update logbook LifeCycle entries
void	updateObjectGroup(String idOperation, String idLc, LogbookLifeCycleObjectGroupParameters parameters, boolean commit) Update logbook LifeCycle entries
void	updateUnit(String idOperation, String idLc, LogbookLifeCycleUnitParameters parameters) Update logbook LifeCycle entries
void	updateUnit(String idOperation, String idLc, LogbookLifeCycleUnitParameters parameters, boolean commit) Update logbook LifeCycle entries committed or in progress

Method Detail

createUnit

void createUnit(String idOperation,
                String idLc,
                LogbookLifeCycleUnitParameters parameters)
         throws LogbookAlreadyExistsException,
                LogbookDatabaseException

Create and insert logbook LifeCycle entries

Parameters:

idOperation - the operation identifier

idLc - the lifecycle unit identifier

parameters - the logbook lifecycle parameters

Throws:

LogbookAlreadyExistsException - if an LifeCycle with the same eventIdentifierProcess and outcome="Started" already exists

LogbookDatabaseException - if errors occur while connecting or writing to the database

createObjectGroup

void createObjectGroup(String idOperation,
                       String idLc,
                       LogbookLifeCycleObjectGroupParameters parameters)
                throws LogbookAlreadyExistsException,
                       LogbookDatabaseException

Create and insert logbook LifeCycle entries

Parameters:

idOperation - the operation identifier

idLc - the lifecycle identifier

parameters - the logbook lifecycle parameters

Throws:

LogbookAlreadyExistsException - if an LifeCycle with the same eventIdentifierProcess and outcome="Started" already exists

LogbookDatabaseException - if errors occur while connecting or writing to the database

updateUnit

void updateUnit(String idOperation,
                String idLc,
                LogbookLifeCycleUnitParameters parameters)
         throws LogbookNotFoundException,
                LogbookDatabaseException,
                LogbookAlreadyExistsException

Update logbook LifeCycle entries

Parameters:

idOperation - the operation identifier

idLc - the lifecycle identifier

parameters - the logbook lifecycle parameters

Throws:

LogbookNotFoundException - if no LifeCycle with the same eventIdentifierProcess exists

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookAlreadyExistsException - if the entry already exists

updateUnit

void updateUnit(String idOperation,
                String idLc,
                LogbookLifeCycleUnitParameters parameters,
                boolean commit)
         throws LogbookNotFoundException,
                LogbookDatabaseException,
                LogbookAlreadyExistsException

Update logbook LifeCycle entries committed or in progress

Parameters:

idOperation - the operation identifier

idLc - the lifecycle identifier

parameters - the logbook lifecycle parameters

commit - if false update in progress collection else update committed LFC

Throws:

LogbookNotFoundException - if no LifeCycle with the same eventIdentifierProcess exists

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookAlreadyExistsException - if the entry already exists

updateObjectGroup

void updateObjectGroup(String idOperation,
                       String idLc,
                       LogbookLifeCycleObjectGroupParameters parameters)
                throws LogbookNotFoundException,
                       LogbookDatabaseException,
                       LogbookAlreadyExistsException

Update logbook LifeCycle entries

Parameters:

idOperation - the operation identifier

idLc - the lifecycle identifier

parameters - the logbook lifecycle parameters

Throws:

LogbookNotFoundException - if no LifeCycle with the same eventIdentifierProcess exists

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookAlreadyExistsException - if the entry already exists

updateObjectGroup

void updateObjectGroup(String idOperation,
                       String idLc,
                       LogbookLifeCycleObjectGroupParameters parameters,
                       boolean commit)
                throws LogbookNotFoundException,
                       LogbookDatabaseException,
                       LogbookAlreadyExistsException

Update logbook LifeCycle entries

Parameters:

idOperation - the operation identifier

idLc - the lifecycle identifier

parameters - the logbook lifecycle parameters

commit - if true update is done on committed collection otherwise on inProcess one

Throws:

LogbookNotFoundException - if no LifeCycle with the same eventIdentifierProcess exists

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookAlreadyExistsException - if the entry already exists

selectUnit

List<LogbookLifeCycle> selectUnit(com.fasterxml.jackson.databind.JsonNode select,
                                  boolean sliced,
                                  LogbookCollections collection)
                           throws LogbookDatabaseException,
                                  LogbookNotFoundException,
                                  InvalidParseOperationException,
                                  VitamDBException

Select logbook LifeCycle entries

Parameters:

select - the select request in format of JsonNode

sliced - the boolean sliced filtering events or not

collection - the collection on which the select operation will be done : Production collection (LIFECYCLE_UNIT) or Working collection (LIFECYCLE_UNIT_IN_PROCESS)

Returns:

List of the logbook LifeCycle

Throws:

LogbookNotFoundException - if no LifeCycle selected cannot be found

LogbookDatabaseException - if errors occur while connecting or writing to the database

InvalidParseOperationException - if invalid parse for selecting the LifeCycle

VitamDBException - in case a desynchro is recorded between Mongo and ES

selectObjectGroup

List<LogbookLifeCycle> selectObjectGroup(com.fasterxml.jackson.databind.JsonNode select,
                                         LogbookCollections collection)
                                  throws LogbookDatabaseException,
                                         LogbookNotFoundException,
                                         InvalidParseOperationException,
                                         VitamDBException

Selects object group life cycle entries

Parameters:

select - the select request in format of JsonNode

collection - the collection on which the select operation will be done : Production collection (LIFECYCLE_OBJECT_GROUP) or Working collection (LIFECYCLE_OBJECT_GROUP_IN_PROCESS)

Returns:

List of the logbook LifeCycle

Throws:

LogbookNotFoundException - if no LifeCycle selected cannot be found

LogbookDatabaseException - if errors occur while connecting or writing to the database

InvalidParseOperationException - if invalid parse for selecting the LifeCycle

VitamDBException - in case a desynchro is recorded between Mongo and ES

selectObjectGroup

List<LogbookLifeCycle> selectObjectGroup(com.fasterxml.jackson.databind.JsonNode select,
                                         boolean sliced,
                                         LogbookCollections collection)
                                  throws LogbookDatabaseException,
                                         LogbookNotFoundException,
                                         InvalidParseOperationException,
                                         VitamDBException

Selects object group life cycle entries

Parameters:

select - the select request in format of JsonNode

sliced - the boolean sliced filtering events or not

collection - the collection on which the select operation will be done : Production collection (LIFECYCLE_OBJECT_GROUP) or Working collection (LIFECYCLE_OBJECT_GROUP_IN_PROCESS)

Returns:

List of the logbook LifeCycle

Throws:

LogbookNotFoundException - if no LifeCycle selected cannot be found

LogbookDatabaseException - if errors occur while connecting or writing to the database

InvalidParseOperationException - if invalid parse for selecting the LifeCycle

VitamDBException - in case a desynchro is recorded between Mongo and ES

getUnitByOperationIdAndByUnitId

LogbookLifeCycleUnit getUnitByOperationIdAndByUnitId(String idOperation,
                                                     String idLc)
                                              throws LogbookDatabaseException,
                                                     LogbookNotFoundException,
                                                     InvalidParseOperationException

Select logbook LifeCycle entry by operation

Parameters:

idOperation - the operation id

idLc - the logbook identifier

Returns:

the Unit Logbook Lifecycle

Throws:

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookNotFoundException - if no LifeCycle selected cannot be found

InvalidParseOperationException - if invalid parse for selecting the LifeCycle

getObjectGroupByOperationIdAndByObjectGroupId

LogbookLifeCycleObjectGroup getObjectGroupByOperationIdAndByObjectGroupId(String idOperation,
                                                                          String idLc)
                                                                   throws LogbookDatabaseException,
                                                                          LogbookNotFoundException,
                                                                          InvalidParseOperationException

Select logbook LifeCycle entry by operation

Parameters:

idOperation - the operation identifier

idLc - the logbook identifier

Returns:

the ObjectGroup Logbook Lifecycle

Throws:

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookNotFoundException - if no LifeCycle selected cannot be found

InvalidParseOperationException - if invalid parse for selecting the LifeCycle

rollbackUnit

void rollbackUnit(String idOperation,
                  String idLc)
           throws LogbookNotFoundException,
                  LogbookDatabaseException

Rollback logbook LifeCycle entries

Parameters:

idOperation - the operation identifier

idLc - the lifecycle identifier

Throws:

LogbookNotFoundException - if no LifeCycle with the same eventIdentifierProcess exists

LogbookDatabaseException - if errors occur while connecting or writing to the database

rollbackObjectGroup

void rollbackObjectGroup(String idOperation,
                         String idLc)
                  throws LogbookNotFoundException,
                         LogbookDatabaseException

Rollback logbook LifeCycle entries

Parameters:

idOperation - the operation identifier

idLc - the lifecycle identifier

Throws:

LogbookNotFoundException - if no LifeCycle with the same eventIdentifierProcess exists

LogbookDatabaseException - if errors occur while connecting or writing to the database

getUnitById

LogbookLifeCycleUnit getUnitById(String idUnit)
                          throws LogbookDatabaseException,
                                 LogbookNotFoundException

Select logbook life cycle by the lifecycle's ID

Parameters:

idUnit - the unit identifier

Returns:

the logbook LifeCycle found by the ID

Throws:

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookNotFoundException - if no LifeCycle selected cannot be found

getUnitById

LogbookLifeCycle getUnitById(com.fasterxml.jackson.databind.JsonNode queryDsl,
                             LogbookCollections collection)
                      throws LogbookDatabaseException,
                             LogbookNotFoundException

Selects logbook life cycle by lifecycle ID (using a queryDsl)

Parameters:

queryDsl - the query as a json

collection - the collection on which the select operation will be done : Production collection (LIFECYCLE_UNIT) or Working collection (LIFECYCLE_UNIT_IN_PROCESS)

Returns:

the logbook LifeCycle found by the ID

Throws:

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookNotFoundException - if no LifeCycle selected cannot be found

getObjectGroupById

LogbookLifeCycleObjectGroup getObjectGroupById(String idObject)
                                        throws LogbookDatabaseException,
                                               LogbookNotFoundException

Select logbook life cycle by the lifecycle's ID

Parameters:

idObject - the object group identifier

Returns:

the logbook LifeCycle found by the ID

Throws:

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookNotFoundException - if no LifeCycle selected cannot be found

createBulkLogbookLifecycle

void createBulkLogbookLifecycle(String idOp,
                                LogbookLifeCycleParameters[] lifecycleArray)
                         throws LogbookDatabaseException,
                                LogbookAlreadyExistsException

Create one Logbook Lifecycle with already multiple sub-events

Parameters:

idOp - Operation Id

lifecycleArray - with first and next events to add/update

Throws:

IllegalArgumentException - if first argument is null or null mandatory parameters for all

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookAlreadyExistsException - if LifeCycle already exists

updateBulkLogbookLifecycle

void updateBulkLogbookLifecycle(String idOp,
                                LogbookLifeCycleParameters[] lifecycleArray)
                         throws LogbookDatabaseException,
                                LogbookNotFoundException,
                                LogbookAlreadyExistsException

Update one Logbook Lifecycle with multiple sub-events

It adds this new entry within the very same Logbook Lifecycle entry in "events" array.

Parameters:

idOp - Operation Id

lifecycleArray - containing all Lifecycle Logbook in order

Throws:

IllegalArgumentException - if parameter has null or empty mandatory values

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookNotFoundException - if LifeCycle cannot be found

LogbookAlreadyExistsException - if LifeCycle already exists

commitUnit

void commitUnit(String idOperation,
                String idLc)
         throws LogbookDatabaseException,
                LogbookNotFoundException,
                LogbookAlreadyExistsException

Commits Unit lifeCycle

Parameters:

idOperation - the operation identifier

idLc - the lifecycle identifier

Throws:

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookNotFoundException - if LifeCycle cannot be found

LogbookAlreadyExistsException - if LifeCycle already exists

commitObjectGroup

void commitObjectGroup(String idOperation,
                       String idLc)
                throws LogbookDatabaseException,
                       LogbookNotFoundException,
                       LogbookAlreadyExistsException

Commits ObjectGroup lifeCycle

Parameters:

idOperation - the operation identifier

idLc - the lifecycle identifier

Throws:

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookNotFoundException - if LifeCycle cannot be found

LogbookAlreadyExistsException - if LifeCycle already exists

rollBackUnitsByOperation

void rollBackUnitsByOperation(String idOperation)
                       throws LogbookNotFoundException,
                              LogbookDatabaseException

Removes the created unit lifeCycles during a given operation

Parameters:

idOperation - the operation id

Throws:

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookNotFoundException - if LifeCycle cannot be found

rollBackObjectGroupsByOperation

void rollBackObjectGroupsByOperation(String idOperation)
                              throws LogbookNotFoundException,
                                     LogbookDatabaseException

Removes the created object groups lifeCycles during a given operation

Parameters:

idOperation - the operation id

Throws:

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookNotFoundException - if LifeCycle cannot be found

getUnitLifeCycleStatus

LifeCycleStatusCode getUnitLifeCycleStatus(String unitId)
                                    throws LogbookDatabaseException,
                                           LogbookNotFoundException

Returns the LifeCycle Status for a given unit Id

Parameters:

unitId - the unit Id

Returns:

the lifeCycleStatusCode

Throws:

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookNotFoundException - if LifeCycle cannot be found

getObjectGroupLifeCycleStatus

LifeCycleStatusCode getObjectGroupLifeCycleStatus(String objectGroupId)
                                           throws LogbookDatabaseException,
                                                  LogbookNotFoundException

Returns the LifeCycle Status for a given objectGroup Id

Parameters:

objectGroupId - the objectGroup Id

Returns:

the lifeCycleStatusCode

Throws:

LogbookDatabaseException - if errors occur while connecting or writing to the database

LogbookNotFoundException - if LifeCycle cannot be found

bulk

void bulk(LogbookCollections collections,
          String idOp,
          List<? extends LogbookLifeCycleModel> logbookLifeCycleModels)
   throws DatabaseException

Bulk method

Parameters:

collections - the logbook collections

idOp - operation identifier

logbookLifeCycleModels - lifecycles to be created

Throws:

DatabaseException - if database could not be reached