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 Object
implements LogbookOperations

Logbook Operations implementation base class

Field Summary

Fields

Modifier and Type	Field and Description
static String	STRATEGY_ID

Constructor Summary

Constructors

Constructor and Description
LogbookOperationsImpl(LogbookDbAccess mongoDbAccess) Constructor
LogbookOperationsImpl(LogbookDbAccess mongoDbAccess, WorkspaceClientFactory workspaceClientFactory)

Method Summary

Modifier and Type	Method and Description
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(LocalDateTime date) Find One logbook TraceabilityOperation after a given date
LogbookOperation	findLastTraceabilityOperationOK() Find last successful traceability operation
LogbookOperation	getById(String idProcess) Select logbook operation by the operation's ID
IndexationResult	reindex(IndexParameters indexParameters) Reindex one or more collections
List<LogbookOperation>	select(com.fasterxml.jackson.databind.JsonNode select) Select logbook operation entries
List<LogbookOperation>	select(com.fasterxml.jackson.databind.JsonNode select, boolean sliced) Select logbook operation entries
com.mongodb.client.MongoCursor<LogbookOperation>	selectOperationsPersistedAfterDate(LocalDateTime date) Select all logbook operations entries after a given date
void	switchIndex(String alias, 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

Field Detail

STRATEGY_ID

public static final String STRATEGY_ID

See Also:

Constant Field Values

Constructor Detail

LogbookOperationsImpl

public LogbookOperationsImpl(LogbookDbAccess mongoDbAccess)

Constructor

Parameters:

mongoDbAccess - of logbook

LogbookOperationsImpl

public LogbookOperationsImpl(LogbookDbAccess mongoDbAccess,
                             WorkspaceClientFactory workspaceClientFactory)

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

select

public List<LogbookOperation> select(com.fasterxml.jackson.databind.JsonNode select)
                              throws LogbookDatabaseException,
                                     LogbookNotFoundException,
                                     InvalidParseOperationException,
                                     VitamDBException

Description copied from interface: LogbookOperations

Select logbook operation entries

Specified by:

select in interface LogbookOperations

Parameters:

select - the select request in format of JsonNode

Returns:

List of the logbook operation

Throws:

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

LogbookNotFoundException - if no operation selected cannot be found

InvalidParseOperationException - if invalid parse for selecting the operation

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

select

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

Description copied from interface: LogbookOperations

Select logbook operation entries

Specified by:

select in interface LogbookOperations

Parameters:

select - the select request in format of JsonNode

sliced - the boolean sliced to filter events or not

Returns:

List of the logbook operation

Throws:

LogbookNotFoundException - if no operation selected cannot be found

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

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

getById

public LogbookOperation getById(String idProcess)
                         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

selectOperationsPersistedAfterDate

public com.mongodb.client.MongoCursor<LogbookOperation> selectOperationsPersistedAfterDate(LocalDateTime date)
                                                                                    throws LogbookDatabaseException,
                                                                                           LogbookNotFoundException,
                                                                                           InvalidCreateOperationException,
                                                                                           InvalidParseOperationException

Description copied from interface: LogbookOperations

Select all logbook operations entries after a given date

Specified by:

selectOperationsPersistedAfterDate in interface LogbookOperations

Parameters:

date - the select request in format of JsonNode

Returns:

the Closeable MongoCursor of LogbookOperation

Throws:

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

LogbookNotFoundException - if no operation selected cannot be found

InvalidCreateOperationException - if the query could not be created

InvalidParseOperationException - if invalid parse for selecting the operation

findFirstTraceabilityOperationOKAfterDate

public LogbookOperation findFirstTraceabilityOperationOKAfterDate(LocalDateTime date)
                                                           throws InvalidCreateOperationException,
                                                                  LogbookNotFoundException,
                                                                  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

LogbookNotFoundException - if no operation selected cannot be found

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

findLastTraceabilityOperationOK

public LogbookOperation findLastTraceabilityOperationOK()
                                                 throws InvalidCreateOperationException,
                                                        LogbookNotFoundException,
                                                        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

LogbookNotFoundException - if no operation selected cannot be found

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

InvalidParseOperationException - if the query could not be created

reindex

public IndexationResult 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 void switchIndex(String alias,
                        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

Throws:

DatabaseException - in case error with database occurs