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
void	deleteLifeCycleObjectGroups(List<String> objectGroupIds) delete LifeCycle ObjectGroups
void	deleteLifeCycleUnits(List<String> unitsIdentifier) delete LifeCycle Units
LifeCycleStatusCode	getObjectGroupLifeCycleStatus(String objectGroupId) Returns the LifeCycle Status for a given objectGroup Id
com.fasterxml.jackson.databind.JsonNode	getRawObjectGroupLifeCycleById(String id) returns the raw version of object group life cycle
List<com.fasterxml.jackson.databind.JsonNode>	getRawObjectGroupLifeCycleByIds(List<String> ids) returns the raw version of object group life cycle
List<com.fasterxml.jackson.databind.JsonNode>	getRawObjectGroupLifecyclesByLastPersistedDate(String startDate, String endDate, int limit) Gets a list of raw object group life cycles by request
com.fasterxml.jackson.databind.JsonNode	getRawUnitLifeCycleById(String id) returns the raw version of unit life cycle
List<com.fasterxml.jackson.databind.JsonNode>	getRawUnitLifeCycleByIds(List<String> ids) returns the raw version of unit life cycle
List<com.fasterxml.jackson.databind.JsonNode>	getRawUnitLifecyclesByLastPersistedDate(String startDate, String endDate, int limit) Gets a list of raw unit life cycles by request
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
LogbookLifeCycle	selectLifeCycleById(String lifecycleId, com.fasterxml.jackson.databind.JsonNode queryDsl, boolean sliced, LogbookCollections collection) Selects life cycle entry
List<LogbookLifeCycle>	selectLifeCycles(com.fasterxml.jackson.databind.JsonNode select, boolean sliced, LogbookCollections collection) Selects life cycle 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	updateLogbookLifeCycleBulk(LogbookCollections lifecycleUnitInProcess, List<LogbookLifeCycleParametersBulk> logbookLifeCycleParametersBulk) updateLogbookLifeCycleBulk
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

selectLifeCycles

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

Selects 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/LIFECYCLE_UNIT) or Working collection (LIFECYCLE_OBJECT_GROUP_IN_PROCESS/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

selectLifeCycleById

LogbookLifeCycle selectLifeCycleById(String lifecycleId,
                                     com.fasterxml.jackson.databind.JsonNode queryDsl,
                                     boolean sliced,
                                     LogbookCollections collection)
                              throws LogbookDatabaseException,
                                     LogbookNotFoundException,
                                     InvalidParseOperationException,
                                     VitamDBException,
                                     InvalidCreateOperationException

Selects life cycle entry

Parameters:

lifecycleId - the lifecycle id

queryDsl - the select projection 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/LIFECYCLE_UNIT) or Working collection (LIFECYCLE_OBJECT_GROUP_IN_PROCESS/LIFECYCLE_UNIT_IN_PROCESS)

Returns:

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

InvalidParseOperationException - if invalid parse for selecting the LifeCycle

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

InvalidCreateOperationException

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

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

getRawUnitLifecyclesByLastPersistedDate

List<com.fasterxml.jackson.databind.JsonNode> getRawUnitLifecyclesByLastPersistedDate(String startDate,
                                                                                      String endDate,
                                                                                      int limit)
                                                                               throws InvalidParseOperationException

Gets a list of raw unit life cycles by request

Parameters:

startDate - the selection start date

endDate - the selection end date

limit - the max limit

Throws:

InvalidParseOperationException

getRawObjectGroupLifecyclesByLastPersistedDate

List<com.fasterxml.jackson.databind.JsonNode> getRawObjectGroupLifecyclesByLastPersistedDate(String startDate,
                                                                                             String endDate,
                                                                                             int limit)
                                                                                      throws InvalidParseOperationException

Gets a list of raw object group life cycles by request

Parameters:

startDate - the selection start date

endDate - the selection end date

limit - the max limit

Throws:

InvalidParseOperationException

getRawUnitLifeCycleById

com.fasterxml.jackson.databind.JsonNode getRawUnitLifeCycleById(String id)
                                                         throws LogbookNotFoundException,
                                                                InvalidParseOperationException

returns the raw version of unit life cycle

Parameters:

id - the id to retrieve

Returns:

the unit life cycle

Throws:

LogbookNotFoundException

InvalidParseOperationException

getRawUnitLifeCycleByIds

List<com.fasterxml.jackson.databind.JsonNode> getRawUnitLifeCycleByIds(List<String> ids)
                                                                throws LogbookNotFoundException,
                                                                       InvalidParseOperationException

returns the raw version of unit life cycle

Parameters:

ids - the ids to retrieve

Returns:

the unit life cycle

Throws:

LogbookNotFoundException

InvalidParseOperationException

getRawObjectGroupLifeCycleById

com.fasterxml.jackson.databind.JsonNode getRawObjectGroupLifeCycleById(String id)
                                                                throws LogbookNotFoundException,
                                                                       InvalidParseOperationException

returns the raw version of object group life cycle

Parameters:

id - the id to retrieve

Returns:

the object group life cycle

Throws:

LogbookNotFoundException

InvalidParseOperationException

getRawObjectGroupLifeCycleByIds

List<com.fasterxml.jackson.databind.JsonNode> getRawObjectGroupLifeCycleByIds(List<String> ids)
                                                                       throws LogbookNotFoundException,
                                                                              InvalidParseOperationException

returns the raw version of object group life cycle

Parameters:

ids - the ids to retrieve

Returns:

the object group life cycle

Throws:

LogbookNotFoundException

InvalidParseOperationException

updateLogbookLifeCycleBulk

void updateLogbookLifeCycleBulk(LogbookCollections lifecycleUnitInProcess,
                                List<LogbookLifeCycleParametersBulk> logbookLifeCycleParametersBulk)

updateLogbookLifeCycleBulk

Parameters:

lifecycleUnitInProcess - lifecycleUnitInProcess

logbookLifeCycleParametersBulk - logbookLifeCycleParametersBulk

deleteLifeCycleObjectGroups

void deleteLifeCycleObjectGroups(List<String> objectGroupIds)
                          throws DatabaseException

delete LifeCycle ObjectGroups

Parameters:

objectGroupIds - objectGroupIds

Throws:

DatabaseException - DatabaseException

deleteLifeCycleUnits

void deleteLifeCycleUnits(List<String> unitsIdentifier)
                   throws DatabaseException

delete LifeCycle Units

Parameters:

unitsIdentifier - units lfc Identifier

Throws:

DatabaseException - DatabaseException