fr.gouv.vitam.logbook.lifecycles.core

Class LogbookLifeCyclesImpl

java.lang.Object

fr.gouv.vitam.logbook.lifecycles.core.LogbookLifeCyclesImpl

All Implemented Interfaces:

LogbookLifeCycles

public class LogbookLifeCyclesImpl
extends Object
implements LogbookLifeCycles

Logbook LifeCycles implementation base class

Constructor Summary

Constructors

Constructor and Description
LogbookLifeCyclesImpl(LogbookDbAccess mongoDbAccess) Constructor
LogbookLifeCyclesImpl(LogbookDbAccess mongoDbAccess, boolean disablePurge) Constructor

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 idObjectGroup) 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogbookLifeCyclesImpl

public LogbookLifeCyclesImpl(LogbookDbAccess mongoDbAccess)

Constructor

Parameters:

mongoDbAccess - of logbook

LogbookLifeCyclesImpl

public LogbookLifeCyclesImpl(LogbookDbAccess mongoDbAccess,
                             boolean disablePurge)

Constructor

Parameters:

mongoDbAccess - of logbook

Method Detail

createUnit

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

Description copied from interface: LogbookLifeCycles

Create and insert logbook LifeCycle entries

Specified by:

createUnit in interface LogbookLifeCycles

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

IllegalArgumentException

createObjectGroup

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

Description copied from interface: LogbookLifeCycles

Create and insert logbook LifeCycle entries

Specified by:

createObjectGroup in interface LogbookLifeCycles

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

IllegalArgumentException

updateUnit

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

Description copied from interface: LogbookLifeCycles

Update logbook LifeCycle entries

Specified by:

updateUnit in interface LogbookLifeCycles

Parameters:

idOperation - the operation identifier

idLc - the lifecycle identifier

parameters - the logbook lifecycle parameters

Throws:

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

LogbookNotFoundException - if no LifeCycle with the same eventIdentifierProcess exists

LogbookAlreadyExistsException - if the entry already exists

IllegalArgumentException

updateUnit

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

Description copied from interface: LogbookLifeCycles

Update logbook LifeCycle entries committed or in progress

Specified by:

updateUnit in interface LogbookLifeCycles

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

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

Description copied from interface: LogbookLifeCycles

Update logbook LifeCycle entries

Specified by:

updateObjectGroup in interface LogbookLifeCycles

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

IllegalArgumentException

updateObjectGroup

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

Description copied from interface: LogbookLifeCycles

Update logbook LifeCycle entries

Specified by:

updateObjectGroup in interface LogbookLifeCycles

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

IllegalArgumentException

getUnitByOperationIdAndByUnitId

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

Description copied from interface: LogbookLifeCycles

Select logbook LifeCycle entry by operation

Specified by:

getUnitByOperationIdAndByUnitId in interface LogbookLifeCycles

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

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

Description copied from interface: LogbookLifeCycles

Select logbook LifeCycle entry by operation

Specified by:

getObjectGroupByOperationIdAndByObjectGroupId in interface LogbookLifeCycles

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

IllegalArgumentException

selectUnit

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

Description copied from interface: LogbookLifeCycles

Select logbook LifeCycle entries

Specified by:

selectUnit in interface LogbookLifeCycles

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:

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

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

selectObjectGroup

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

Description copied from interface: LogbookLifeCycles

Selects object group life cycle entries

Specified by:

selectObjectGroup in interface LogbookLifeCycles

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:

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

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

selectObjectGroup

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

Description copied from interface: LogbookLifeCycles

Selects object group life cycle entries

Specified by:

selectObjectGroup in interface LogbookLifeCycles

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:

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

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

rollbackUnit

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

Description copied from interface: LogbookLifeCycles

Rollback logbook LifeCycle entries

Specified by:

rollbackUnit in interface LogbookLifeCycles

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

IllegalArgumentException

rollbackObjectGroup

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

Description copied from interface: LogbookLifeCycles

Rollback logbook LifeCycle entries

Specified by:

rollbackObjectGroup in interface LogbookLifeCycles

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

IllegalArgumentException

getUnitById

public LogbookLifeCycleUnit getUnitById(String idUnit)
                                 throws LogbookDatabaseException,
                                        LogbookNotFoundException

Description copied from interface: LogbookLifeCycles

Select logbook life cycle by the lifecycle's ID

Specified by:

getUnitById in interface LogbookLifeCycles

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

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

Description copied from interface: LogbookLifeCycles

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

Specified by:

getUnitById in interface LogbookLifeCycles

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

public LogbookLifeCycleObjectGroup getObjectGroupById(String idObjectGroup)
                                               throws LogbookDatabaseException,
                                                      LogbookNotFoundException

Description copied from interface: LogbookLifeCycles

Select logbook life cycle by the lifecycle's ID

Specified by:

getObjectGroupById in interface LogbookLifeCycles

Parameters:

idObjectGroup - 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

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

Description copied from interface: LogbookLifeCycles

Create one Logbook Lifecycle with already multiple sub-events

Specified by:

createBulkLogbookLifecycle in interface LogbookLifeCycles

Parameters:

idOp - Operation Id

lifecycleArray - with first and next events to add/update

Throws:

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

LogbookAlreadyExistsException - if LifeCycle already exists

updateBulkLogbookLifecycle

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

Description copied from interface: LogbookLifeCycles

Update one Logbook Lifecycle with multiple sub-events

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

Specified by:

updateBulkLogbookLifecycle in interface LogbookLifeCycles

Parameters:

idOp - Operation Id

lifecycleArray - containing all Lifecycle Logbook in order

Throws:

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

LogbookNotFoundException - if LifeCycle cannot be found

LogbookAlreadyExistsException - if LifeCycle already exists

commitUnit

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

Description copied from interface: LogbookLifeCycles

Commits Unit lifeCycle

Specified by:

commitUnit in interface LogbookLifeCycles

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

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

Description copied from interface: LogbookLifeCycles

Commits ObjectGroup lifeCycle

Specified by:

commitObjectGroup in interface LogbookLifeCycles

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

public void rollBackUnitsByOperation(String idOperation)
                              throws LogbookNotFoundException,
                                     LogbookDatabaseException

Description copied from interface: LogbookLifeCycles

Removes the created unit lifeCycles during a given operation

Specified by:

rollBackUnitsByOperation in interface LogbookLifeCycles

Parameters:

idOperation - the operation id

Throws:

LogbookNotFoundException - if LifeCycle cannot be found

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

rollBackObjectGroupsByOperation

public void rollBackObjectGroupsByOperation(String idOperation)
                                     throws LogbookNotFoundException,
                                            LogbookDatabaseException

Description copied from interface: LogbookLifeCycles

Removes the created object groups lifeCycles during a given operation

Specified by:

rollBackObjectGroupsByOperation in interface LogbookLifeCycles

Parameters:

idOperation - the operation id

Throws:

LogbookNotFoundException - if LifeCycle cannot be found

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

getUnitLifeCycleStatus

public LifeCycleStatusCode getUnitLifeCycleStatus(String unitId)
                                           throws LogbookDatabaseException,
                                                  LogbookNotFoundException

Description copied from interface: LogbookLifeCycles

Returns the LifeCycle Status for a given unit Id

Specified by:

getUnitLifeCycleStatus in interface LogbookLifeCycles

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

public LifeCycleStatusCode getObjectGroupLifeCycleStatus(String objectGroupId)
                                                  throws LogbookDatabaseException,
                                                         LogbookNotFoundException

Description copied from interface: LogbookLifeCycles

Returns the LifeCycle Status for a given objectGroup Id

Specified by:

getObjectGroupLifeCycleStatus in interface LogbookLifeCycles

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

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

Description copied from interface: LogbookLifeCycles

Bulk method

Specified by:

bulk in interface LogbookLifeCycles

Parameters:

collections - the logbook collections

idOp - operation identifier

logbookLifeCycleModels - lifecycles to be created

Throws:

DatabaseException - if database could not be reached