Package fr.gouv.vitam.logbook.operations.core

Class LogbookOperationsImpl

java.lang.Object

fr.gouv.vitam.logbook.operations.core.LogbookOperationsImpl

All Implemented Interfaces:

LogbookOperations

public class LogbookOperationsImpl
extends java.lang.Object
implements LogbookOperations

Logbook Operations implementation base class

Constructor Summary

Constructors

Constructor	Description
LogbookOperationsImpl(LogbookDbAccess mongoDbAccess, ElasticsearchLogbookIndexManager indexManager)
LogbookOperationsImpl(LogbookDbAccess mongoDbAccess, WorkspaceClientFactory workspaceClientFactory, StorageClientFactory storageClientFactory, IndexationHelper indexationHelper, ElasticsearchLogbookIndexManager indexManager)

Method Summary

Modifier and Type	Method	Description
boolean	checkNewEligibleLogbookOperationsSinceLastTraceabilityOperation(java.time.LocalDateTime traceabilityStartDate, java.time.LocalDateTime traceabilityEndDate)
void	create(LogbookOperationParameters parameters)	Create and insert logbook operation entries
void	createBulkLogbookOperation(LogbookOperationParameters[] operationArray)	Create one Logbook Operation with already multiple sub-events
LogbookOperation	findFirstTraceabilityOperationOKAfterDate(java.time.LocalDateTime date)	Find One logbook TraceabilityOperation after a given date
LogbookOperation	findLastLifecycleTraceabilityOperation(java.lang.String eventType, boolean traceabilityWithZipOnly)	Find last OK or WARNING LFC traceability operation (even if no traceability zip has been generated)
java.util.Optional<LogbookOperation>	findLastOperationByType(java.lang.String operationType)	FInd last event of last operation by type
LogbookOperation	findLastTraceabilityOperationOK()	Find last successful traceability operation
LogbookOperation	getById(java.lang.String idProcess)
LogbookOperation	getById(java.lang.String idProcess, com.fasterxml.jackson.databind.JsonNode query, boolean sliced, boolean crossTenant)	Select logbook operation by the operation's ID
ReindexationResult	reindex(IndexParameters indexParameters)	Reindex one or more collections
java.util.List<LogbookOperation>	selectOperations(com.fasterxml.jackson.databind.JsonNode select)	Select logbook operation entries
java.util.List<LogbookOperation>	selectOperations(com.fasterxml.jackson.databind.JsonNode select, boolean sliced, boolean crossTenant)
RequestResponseOK<LogbookOperation>	selectOperationsAsRequestResponse(com.fasterxml.jackson.databind.JsonNode select, boolean sliced, boolean crossTenant)
com.mongodb.client.MongoCursor<LogbookOperation>	selectOperationsByLastPersistenceDateInterval(java.time.LocalDateTime startDate, java.time.LocalDateTime endDate)	Select all logbook operations entries persisted within provided interval
SwitchIndexResult	switchIndex(java.lang.String alias, java.lang.String newIndexName)	Switch indexes for one or more collections
void	update(LogbookOperationParameters parameters)	Update and insert logbook operation entries
void	updateBulkLogbookOperation(LogbookOperationParameters[] operationArray)	Update one Logbook Operation with multiple sub-events It adds this new entry within the very same Logbook Operaton entry in "events" array.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogbookOperationsImpl

public LogbookOperationsImpl(LogbookDbAccess mongoDbAccess,
                             ElasticsearchLogbookIndexManager indexManager)

LogbookOperationsImpl

public LogbookOperationsImpl(LogbookDbAccess mongoDbAccess,
                             WorkspaceClientFactory workspaceClientFactory,
                             StorageClientFactory storageClientFactory,
                             IndexationHelper indexationHelper,
                             ElasticsearchLogbookIndexManager indexManager)

Method Detail

create

public void create(LogbookOperationParameters parameters)
            throws LogbookAlreadyExistsException,
                   LogbookDatabaseException

Description copied from interface: LogbookOperations

Create and insert logbook operation entries

Specified by:

create in interface LogbookOperations

Parameters:

parameters - the entry parameters

Throws:

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

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

update

public void update(LogbookOperationParameters parameters)
            throws LogbookNotFoundException,
                   LogbookDatabaseException

Description copied from interface: LogbookOperations

Update and insert logbook operation entries

Specified by:

update in interface LogbookOperations

Parameters:

parameters - the entry parameters

Throws:

LogbookNotFoundException - if no operation with the same eventIdentifierProcess exists

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

selectOperations

public java.util.List<LogbookOperation> selectOperations(com.fasterxml.jackson.databind.JsonNode select)
                                                  throws VitamDBException,
                                                         LogbookDatabaseException

Description copied from interface: LogbookOperations

Select logbook operation entries

Specified by:

selectOperations in interface LogbookOperations

Parameters:

select - the select request in format of JsonNode

Returns:

List of the logbook operation

Throws:

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

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

selectOperations

public java.util.List<LogbookOperation> selectOperations(com.fasterxml.jackson.databind.JsonNode select,
                                                         boolean sliced,
                                                         boolean crossTenant)
                                                  throws VitamDBException,
                                                         LogbookDatabaseException

Specified by:

selectOperations in interface LogbookOperations

Throws:

VitamDBException

LogbookDatabaseException

selectOperationsAsRequestResponse

public RequestResponseOK<LogbookOperation> selectOperationsAsRequestResponse(com.fasterxml.jackson.databind.JsonNode select,
                                                                             boolean sliced,
                                                                             boolean crossTenant)
                                                                      throws VitamDBException,
                                                                             LogbookDatabaseException

Specified by:

selectOperationsAsRequestResponse in interface LogbookOperations

Throws:

VitamDBException

LogbookDatabaseException

getById

public LogbookOperation getById(java.lang.String idProcess)
                         throws LogbookDatabaseException,
                                LogbookNotFoundException

Specified by:

getById in interface LogbookOperations

Throws:

LogbookDatabaseException

LogbookNotFoundException

getById

public LogbookOperation getById(java.lang.String idProcess,
                                com.fasterxml.jackson.databind.JsonNode query,
                                boolean sliced,
                                boolean crossTenant)
                         throws LogbookDatabaseException,
                                LogbookNotFoundException

Description copied from interface: LogbookOperations

Select logbook operation by the operation's ID

Specified by:

getById in interface LogbookOperations

Parameters:

idProcess - the operation identifier

Returns:

the logbook operation found by the ID

Throws:

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

LogbookNotFoundException - if no operation selected cannot be found

createBulkLogbookOperation

public final void createBulkLogbookOperation(LogbookOperationParameters[] operationArray)
                                      throws LogbookDatabaseException,
                                             LogbookAlreadyExistsException

Description copied from interface: LogbookOperations

Create one Logbook Operation with already multiple sub-events

Specified by:

createBulkLogbookOperation in interface LogbookOperations

Parameters:

operationArray - with first and next events to add/update

Throws:

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

LogbookAlreadyExistsException - if logbook already exists

updateBulkLogbookOperation

public final void updateBulkLogbookOperation(LogbookOperationParameters[] operationArray)
                                      throws LogbookDatabaseException,
                                             LogbookNotFoundException

Description copied from interface: LogbookOperations

Update one Logbook Operation with multiple sub-events

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

Specified by:

updateBulkLogbookOperation in interface LogbookOperations

Parameters:

operationArray - containing all operations Logbook in order

Throws:

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

LogbookNotFoundException - if no operation selected cannot be found

selectOperationsByLastPersistenceDateInterval

public com.mongodb.client.MongoCursor<LogbookOperation> selectOperationsByLastPersistenceDateInterval(java.time.LocalDateTime startDate,
                                                                                                      java.time.LocalDateTime endDate)
                                                                                               throws LogbookDatabaseException,
                                                                                                      InvalidCreateOperationException,
                                                                                                      InvalidParseOperationException

Description copied from interface: LogbookOperations

Select all logbook operations entries persisted within provided interval

Specified by:

selectOperationsByLastPersistenceDateInterval in interface LogbookOperations

Parameters:

startDate - the start date

endDate - the end date

Returns:

the Closeable MongoCursor of LogbookOperation

Throws:

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

InvalidCreateOperationException - if the query could not be created

InvalidParseOperationException - if invalid parse for selecting the operation

findFirstTraceabilityOperationOKAfterDate

public LogbookOperation findFirstTraceabilityOperationOKAfterDate(java.time.LocalDateTime date)
                                                           throws InvalidCreateOperationException,
                                                                  LogbookDatabaseException

Description copied from interface: LogbookOperations

Find One logbook TraceabilityOperation after a given date

Specified by:

findFirstTraceabilityOperationOKAfterDate in interface LogbookOperations

Parameters:

date - the select request in format of JsonNode

Returns:

the LogbookOperation

Throws:

InvalidCreateOperationException - if the query could not be created

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

findLastTraceabilityOperationOK

public LogbookOperation findLastTraceabilityOperationOK()
                                                 throws InvalidCreateOperationException,
                                                        LogbookDatabaseException,
                                                        InvalidParseOperationException

Description copied from interface: LogbookOperations

Find last successful traceability operation

Specified by:

findLastTraceabilityOperationOK in interface LogbookOperations

Returns:

the last valid traceability operation

Throws:

InvalidCreateOperationException - if the query could not be created

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

InvalidParseOperationException - if the query could not be created

findLastLifecycleTraceabilityOperation

public LogbookOperation findLastLifecycleTraceabilityOperation(java.lang.String eventType,
                                                               boolean traceabilityWithZipOnly)
                                                        throws VitamException

Description copied from interface: LogbookOperations

Find last OK or WARNING LFC traceability operation (even if no traceability zip has been generated)

Specified by:

findLastLifecycleTraceabilityOperation in interface LogbookOperations

Parameters:

eventType - Logbook event type

traceabilityWithZipOnly - if true, skip operation without Zip (empty operations)

Returns:

the last valid traceability operation

Throws:

VitamException - if errors occur while retrieving data

findLastOperationByType

public java.util.Optional<LogbookOperation> findLastOperationByType(java.lang.String operationType)
                                                             throws InvalidCreateOperationException,
                                                                    LogbookDatabaseException,
                                                                    InvalidParseOperationException

Description copied from interface: LogbookOperations

FInd last event of last operation by type

Specified by:

findLastOperationByType in interface LogbookOperations

Returns:

Throws:

InvalidCreateOperationException

LogbookDatabaseException

InvalidParseOperationException

reindex

public ReindexationResult reindex(IndexParameters indexParameters)

Description copied from interface: LogbookOperations

Reindex one or more collections

Specified by:

reindex in interface LogbookOperations

Parameters:

indexParameters - the parameters specifying what to reindex

Returns:

the reindexation result as a IndexationResult Object

switchIndex

public SwitchIndexResult switchIndex(java.lang.String alias,
                                     java.lang.String newIndexName)
                              throws DatabaseException

Description copied from interface: LogbookOperations

Switch indexes for one or more collections

Specified by:

switchIndex in interface LogbookOperations

Parameters:

alias - the alias name

newIndexName - the new index to be pointed on

Returns:

Throws:

DatabaseException - in case error with database occurs

checkNewEligibleLogbookOperationsSinceLastTraceabilityOperation

public boolean checkNewEligibleLogbookOperationsSinceLastTraceabilityOperation(java.time.LocalDateTime traceabilityStartDate,
                                                                               java.time.LocalDateTime traceabilityEndDate)
                                                                        throws LogbookDatabaseException

Specified by:

checkNewEligibleLogbookOperationsSinceLastTraceabilityOperation in interface LogbookOperations

Throws:

LogbookDatabaseException