fr.gouv.vitam.logbook.operations.client

Class LogbookOperationsClientMock

java.lang.Object

fr.gouv.vitam.common.client.AbstractMockClient

fr.gouv.vitam.logbook.operations.client.LogbookOperationsClientMock

All Implemented Interfaces:

BasicClient, MockOrRestClient, VitamAutoCloseable, LogbookOperationsClient, AutoCloseable

public class LogbookOperationsClientMock
extends AbstractMockClient
implements LogbookOperationsClient

Mock client implementation for logbook operation

Nested Class Summary

Nested classes/interfaces inherited from class fr.gouv.vitam.common.client.AbstractMockClient

AbstractMockClient.FakeInboundResponse

Field Summary

Fields inherited from class fr.gouv.vitam.common.client.AbstractMockClient

INTERNAL_SERVER_ERROR

Fields inherited from interface fr.gouv.vitam.common.client.BasicClient

STATUS_URL

Constructor Summary

Constructors

Constructor and Description
LogbookOperationsClientMock()

Method Summary

Modifier and Type	Method and Description
void	bulkCreate(String eventIdProc, Iterable<LogbookOperationParameters> queue) Bulk Create To be used ONLY once at top level of process startup (where eventIdentifierProcess is set for the first time).
void	bulkUpdate(String eventIdProc, Iterable<LogbookOperationParameters> queue) Bulk Update To be used everywhere except very first time (when eventIdentifierProcess already used once)
LifecycleTraceabilityStatus	checkLifecycleTraceabilityWorkflowStatus(String operationId) Check life cycle traceability status (unit / got)
LogbookCheckResult	checkLogbookCoherence() checkLogbookCoherence
void	close() Close the underneath http client
void	commitCreateDelegate(String eventIdProc) Finalize logbook entry using delegation To be used ONLY once at top level of process startup (where eventIdentifierProcess is set for the first time).
void	commitUpdateDelegate(String eventIdProc) Finalize logbook entry using delegation To be used everywhere except very first time (when eventIdentifierProcess already used once)
void	create(LogbookOperationParameters parameters) Create logbook entry To be used ONLY once at top level of process startup (where eventIdentifierProcess is set for the first time).
void	createDelegate(LogbookOperationParameters parameters) Create logbook entry using delegation To be used ONLY once at top level of process startup (where eventIdentifierProcess is set for the first time).
com.fasterxml.jackson.databind.JsonNode	reindex(IndexParameters indexParam) Reindex a collection with parameters
com.fasterxml.jackson.databind.JsonNode	selectOperation(com.fasterxml.jackson.databind.JsonNode select)
com.fasterxml.jackson.databind.JsonNode	selectOperationById(String id)
com.fasterxml.jackson.databind.JsonNode	switchIndexes(SwitchIndexParameters switchIndexParam) Switch indexes
RequestResponseOK	traceability() Call traceability logbook operation
void	traceabilityAudit(int tenant, AuditLogbookOptions options)
RequestResponseOK	traceabilityLfcObjectGroup() Starts Object Group logbook lifecycle traceability
RequestResponseOK	traceabilityLfcUnit() Starts Unit logbook lifecycle traceability
void	update(LogbookOperationParameters parameters) Update logbook entry To be used everywhere except very first time (when eventIdentifierProcess already used once)
void	updateDelegate(LogbookOperationParameters parameters) Update logbook entry using delegation To be used everywhere except very first time (when eventIdentifierProcess already used once)

Methods inherited from class fr.gouv.vitam.common.client.AbstractMockClient

checkStatus, checkStatus, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.gouv.vitam.common.client.MockOrRestClient

checkStatus, checkStatus, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Constructor Detail

LogbookOperationsClientMock

public LogbookOperationsClientMock()

Method Detail

create

public void create(LogbookOperationParameters parameters)
            throws LogbookClientBadRequestException,
                   LogbookClientAlreadyExistsException,
                   LogbookClientServerException

Description copied from interface: LogbookOperationsClient

Create logbook entry

To be used ONLY once at top level of process startup (where eventIdentifierProcess is set for the first time).

Specified by:

create in interface LogbookOperationsClient

Parameters:

parameters - the entry parameters

Throws:

LogbookClientBadRequestException - if the argument is incorrect

LogbookClientAlreadyExistsException - if the element already exists

LogbookClientServerException - if the Server got an internal error

update

public void update(LogbookOperationParameters parameters)
            throws LogbookClientBadRequestException,
                   LogbookClientNotFoundException,
                   LogbookClientServerException

Description copied from interface: LogbookOperationsClient

Update logbook entry

To be used everywhere except very first time (when eventIdentifierProcess already used once)

Specified by:

update in interface LogbookOperationsClient

Parameters:

parameters - the entry parameters

Throws:

LogbookClientBadRequestException - if the argument is incorrect

LogbookClientNotFoundException - if the element was not created before

LogbookClientServerException - if the Server got an internal error

selectOperation

public com.fasterxml.jackson.databind.JsonNode selectOperation(com.fasterxml.jackson.databind.JsonNode select)
                                                        throws LogbookClientException,
                                                               InvalidParseOperationException

Specified by:

selectOperation in interface LogbookOperationsClient

Returns:

logbook operation as JsonNode

Throws:

LogbookClientException

InvalidParseOperationException

selectOperationById

public com.fasterxml.jackson.databind.JsonNode selectOperationById(String id)
                                                            throws LogbookClientException,
                                                                   InvalidParseOperationException

Specified by:

selectOperationById in interface LogbookOperationsClient

Parameters:

id - identifier

Returns:

logbook operation as String

Throws:

LogbookClientException - LogbookClientException

InvalidParseOperationException - InvalidParseOperationException

traceability

public RequestResponseOK traceability()
                               throws InvalidParseOperationException

Description copied from interface: LogbookOperationsClient

Call traceability logbook operation

Specified by:

traceability in interface LogbookOperationsClient

Returns:

logbook operation as String

Throws:

InvalidParseOperationException

createDelegate

public void createDelegate(LogbookOperationParameters parameters)
                    throws LogbookClientAlreadyExistsException

Description copied from interface: LogbookOperationsClient

Create logbook entry using delegation

To be used ONLY once at top level of process startup (where eventIdentifierProcess is set for the first time).

Specified by:

createDelegate in interface LogbookOperationsClient

Parameters:

parameters - the entry parameters (can be reused and modified after without impacting the one created)

Throws:

LogbookClientAlreadyExistsException - if the element already exists

updateDelegate

public void updateDelegate(LogbookOperationParameters parameters)
                    throws LogbookClientNotFoundException

Description copied from interface: LogbookOperationsClient

Update logbook entry using delegation

To be used everywhere except very first time (when eventIdentifierProcess already used once)

Specified by:

updateDelegate in interface LogbookOperationsClient

Parameters:

parameters - the entry parameters (can be reused and modified after without impacting the one updated)

Throws:

LogbookClientNotFoundException - if the element does not yet exists (createDeletage not called before)

bulkCreate

public void bulkCreate(String eventIdProc,
                       Iterable<LogbookOperationParameters> queue)
                throws LogbookClientBadRequestException

Description copied from interface: LogbookOperationsClient

Bulk Create

To be used ONLY once at top level of process startup (where eventIdentifierProcess is set for the first time).

Specified by:

bulkCreate in interface LogbookOperationsClient

Parameters:

eventIdProc - event Process Identifier

queue - queue of LogbookOperationParameters to create

Throws:

LogbookClientBadRequestException - if the argument is incorrect

bulkUpdate

public void bulkUpdate(String eventIdProc,
                       Iterable<LogbookOperationParameters> queue)
                throws LogbookClientBadRequestException

Description copied from interface: LogbookOperationsClient

Bulk Update

To be used everywhere except very first time (when eventIdentifierProcess already used once)

Specified by:

bulkUpdate in interface LogbookOperationsClient

Parameters:

eventIdProc - event Process Identifier

queue - queue of LogbookOperationParameters to update

Throws:

LogbookClientBadRequestException - if the argument is incorrect

commitCreateDelegate

public void commitCreateDelegate(String eventIdProc)
                          throws LogbookClientBadRequestException

Description copied from interface: LogbookOperationsClient

Finalize logbook entry using delegation

To be used ONLY once at top level of process startup (where eventIdentifierProcess is set for the first time).

Specified by:

commitCreateDelegate in interface LogbookOperationsClient

Parameters:

eventIdProc - event Process Identifier

Throws:

LogbookClientBadRequestException - if the argument is incorrect

commitUpdateDelegate

public void commitUpdateDelegate(String eventIdProc)
                          throws LogbookClientBadRequestException

Description copied from interface: LogbookOperationsClient

Finalize logbook entry using delegation

To be used everywhere except very first time (when eventIdentifierProcess already used once)

Specified by:

commitUpdateDelegate in interface LogbookOperationsClient

Parameters:

eventIdProc - event Process Identifier

Throws:

LogbookClientBadRequestException - if the argument is incorrect

close

public void close()

Description copied from interface: MockOrRestClient

Close the underneath http client

Specified by:

close in interface MockOrRestClient

Specified by:

close in interface VitamAutoCloseable

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractMockClient

traceabilityLfcUnit

public RequestResponseOK traceabilityLfcUnit()

Description copied from interface: LogbookOperationsClient

Starts Unit logbook lifecycle traceability

Specified by:

traceabilityLfcUnit in interface LogbookOperationsClient

Returns:

logbook lifecycles as String

traceabilityLfcObjectGroup

public RequestResponseOK traceabilityLfcObjectGroup()

Description copied from interface: LogbookOperationsClient

Starts Object Group logbook lifecycle traceability

Specified by:

traceabilityLfcObjectGroup in interface LogbookOperationsClient

Returns:

logbook lifecycles as String

reindex

public com.fasterxml.jackson.databind.JsonNode reindex(IndexParameters indexParam)
                                                throws InvalidParseOperationException,
                                                       LogbookClientServerException

Description copied from interface: LogbookOperationsClient

Reindex a collection with parameters

Specified by:

reindex in interface LogbookOperationsClient

Parameters:

indexParam - reindexation parameters

Returns:

JsonObject containing information about the newly created index

Throws:

InvalidParseOperationException

LogbookClientServerException

switchIndexes

public com.fasterxml.jackson.databind.JsonNode switchIndexes(SwitchIndexParameters switchIndexParam)
                                                      throws InvalidParseOperationException,
                                                             LogbookClientServerException

Description copied from interface: LogbookOperationsClient

Switch indexes

Specified by:

switchIndexes in interface LogbookOperationsClient

Parameters:

switchIndexParam - switch index parameters

Returns:

JsonObject containing information about the newly created index

Throws:

InvalidParseOperationException

LogbookClientServerException

traceabilityAudit

public void traceabilityAudit(int tenant,
                              AuditLogbookOptions options)

Specified by:

traceabilityAudit in interface LogbookOperationsClient

checkLogbookCoherence

public LogbookCheckResult checkLogbookCoherence()

Description copied from interface: LogbookOperationsClient

checkLogbookCoherence

Specified by:

checkLogbookCoherence in interface LogbookOperationsClient

Returns:

result

checkLifecycleTraceabilityWorkflowStatus

public LifecycleTraceabilityStatus checkLifecycleTraceabilityWorkflowStatus(String operationId)

Description copied from interface: LogbookOperationsClient

Check life cycle traceability status (unit / got)

Specified by:

checkLifecycleTraceabilityWorkflowStatus in interface LogbookOperationsClient

Parameters:

operationId - the process id

Returns:

lifecycle traceability status