fr.gouv.vitam.storage.engine.server.storagetraceability

Class LogbookStorageTraceabilityHelper

java.lang.Object

fr.gouv.vitam.storage.engine.server.storagetraceability.LogbookStorageTraceabilityHelper

All Implemented Interfaces:

LogbookTraceabilityHelper

public class LogbookStorageTraceabilityHelper
extends Object
implements LogbookTraceabilityHelper

Handle specific steps of the traceability process for Storage

Field Summary

Fields inherited from interface fr.gouv.vitam.logbook.common.traceability.LogbookTraceabilityHelper

INITIAL_START_DATE

Constructor Summary

Constructors

Constructor and Description
LogbookStorageTraceabilityHelper(LogbookOperationsClient logbookOperations, WorkspaceClient workspaceClient, TraceabilityStorageService traceabilityLogbookService, GUID operationID, int overlapDelayInSeconds)

Method Summary

Modifier and Type	Method and Description
void	createLogbookOperationEvent(Integer tenantId, String eventType, StatusCode status, TraceabilityEvent event) Update or finalize the traceability entry in the logbook collection
void	createLogbookOperationStructure() initialize the traceability entry in the logbook collection
Long	getDataSize() Warning: This method MUST be used after "saveDataInZip" witch initialize traceabilityIterator
String	getPreviousMonthStartDate() Get the first traceability (in logbook) one month before the given currentDate and return the startDate of the entry
byte[]	getPreviousMonthTimestampToken() Get the first traceability (in logbook) one month before the given currentDate and return the timestampToken of the entry
String	getPreviousStartDate() Get the last traceability (in logbook) event and return the startDate of the entry
byte[]	getPreviousTimestampToken() Get the last traceability (in logbook) event and return the timestampToken of the entry
String	getPreviousYearStartDate() Get the first traceability (in logbook) one year before the given currentDate and return the startDate of the entry
byte[]	getPreviousYearTimestampToken() Get the first traceability (in logbook) one year before the given currentDate and return the timestampToken of the entry
String	getStepName()
String	getTimestampStepName()
String	getTraceabilityEndDate()
String	getTraceabilityStartDate()
TraceabilityType	getTraceabilityType()
String	getUriName()
String	getZipName()
void	initialize() Initialize traceability.
void	saveDataInZip(MerkleTreeAlgo algo, TraceabilityFile file) Search for entries to secure with the traceability process and store data in the given Traceability zip file. Also, Merkle Algorithm should be updated by adding each wanted entry as a leaf of the tree.
void	saveEmpty(Integer tenantId) Save the close master event if needed
void	saveEvent(TraceabilityEvent event) Save the finalized event if needed
void	storeAndDeleteZip(Integer tenant, File zipFile, String fileName, String uri, TraceabilityEvent event) Store the temporary zip in the final destination (on a specific offer for example) and delete tmp file.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogbookStorageTraceabilityHelper

public LogbookStorageTraceabilityHelper(LogbookOperationsClient logbookOperations,
                                        WorkspaceClient workspaceClient,
                                        TraceabilityStorageService traceabilityLogbookService,
                                        GUID operationID,
                                        int overlapDelayInSeconds)

Parameters:

logbookOperations - used to search the operation to secure

operationID - guid of the traceability operation

overlapDelayInSeconds - the overlap delay in second used to avoid to forgot logbook operation for traceability

Method Detail

initialize

public void initialize()
                throws TraceabilityException

Description copied from interface: LogbookTraceabilityHelper

Initialize traceability. Sets traceability start date and end date.

Specified by:

initialize in interface LogbookTraceabilityHelper

Throws:

TraceabilityException - for any error

saveDataInZip

public void saveDataInZip(MerkleTreeAlgo algo,
                          TraceabilityFile file)
                   throws IOException,
                          TraceabilityException

Description copied from interface: LogbookTraceabilityHelper

Search for entries to secure with the traceability process and store data in the given Traceability zip file.
Also, Merkle Algorithm should be updated by adding each wanted entry as a leaf of the tree.

Specified by:

saveDataInZip in interface LogbookTraceabilityHelper

Parameters:

algo - algorithm used to generate MerkleTree with data.

file - output zip to store data (in some TYPE_COLLECTION.json)

Throws:

IOException - if any error occurs while writing in traceabilityFile

TraceabilityException - for any other errors specifically in the search / data transformation

getPreviousStartDate

public String getPreviousStartDate()
                            throws InvalidParseOperationException

Description copied from interface: LogbookTraceabilityHelper

Get the last traceability (in logbook) event and return the startDate of the entry

Specified by:

getPreviousStartDate in interface LogbookTraceabilityHelper

Returns:

the start date of the last traceability entry

Throws:

InvalidParseOperationException - if any errors occurs while deserializing entry's data.

getPreviousTimestampToken

public byte[] getPreviousTimestampToken()
                                 throws InvalidParseOperationException

Description copied from interface: LogbookTraceabilityHelper

Get the last traceability (in logbook) event and return the timestampToken of the entry

Specified by:

getPreviousTimestampToken in interface LogbookTraceabilityHelper

Returns:

the timestamp token of the last traceability entry or null if no previous traceability OK for that type

Throws:

InvalidParseOperationException - if any errors occurs while deserializing entry's data.

getPreviousMonthStartDate

public String getPreviousMonthStartDate()

Description copied from interface: LogbookTraceabilityHelper

Get the first traceability (in logbook) one month before the given currentDate and return the startDate of the entry

Specified by:

getPreviousMonthStartDate in interface LogbookTraceabilityHelper

Returns:

the start date of the matching entry or null if no matching entry

getPreviousMonthTimestampToken

public byte[] getPreviousMonthTimestampToken()

Description copied from interface: LogbookTraceabilityHelper

Get the first traceability (in logbook) one month before the given currentDate and return the timestampToken of the entry

Specified by:

getPreviousMonthTimestampToken in interface LogbookTraceabilityHelper

Returns:

the timestamp token of the matching entry or null if no matching entry

getPreviousYearStartDate

public String getPreviousYearStartDate()

Description copied from interface: LogbookTraceabilityHelper

Get the first traceability (in logbook) one year before the given currentDate and return the startDate of the entry

Specified by:

getPreviousYearStartDate in interface LogbookTraceabilityHelper

Returns:

the start date of the matching entry or null if no matching entry

getPreviousYearTimestampToken

public byte[] getPreviousYearTimestampToken()

Description copied from interface: LogbookTraceabilityHelper

Get the first traceability (in logbook) one year before the given currentDate and return the timestampToken of the entry

Specified by:

getPreviousYearTimestampToken in interface LogbookTraceabilityHelper

Returns:

the timestamp token of the matching entry or null if no matching entry

createLogbookOperationStructure

public void createLogbookOperationStructure()
                                     throws TraceabilityException

Description copied from interface: LogbookTraceabilityHelper

initialize the traceability entry in the logbook collection

Specified by:

createLogbookOperationStructure in interface LogbookTraceabilityHelper

Throws:

TraceabilityException - if any error occurs

createLogbookOperationEvent

public void createLogbookOperationEvent(Integer tenantId,
                                        String eventType,
                                        StatusCode status,
                                        TraceabilityEvent event)
                                 throws TraceabilityException

Description copied from interface: LogbookTraceabilityHelper

Update or finalize the traceability entry in the logbook collection

Specified by:

createLogbookOperationEvent in interface LogbookTraceabilityHelper

Parameters:

tenantId - tenant used for the operation

eventType - code of the eventType for the entry

status - status of the entry

event - data of the entry

Throws:

TraceabilityException - if any error occurs

saveEvent

public void saveEvent(TraceabilityEvent event)

Description copied from interface: LogbookTraceabilityHelper

Save the finalized event if needed

Specified by:

saveEvent in interface LogbookTraceabilityHelper

Parameters:

event - The TraceabilityEvent of the operation

saveEmpty

public void saveEmpty(Integer tenantId)
               throws TraceabilityException

Description copied from interface: LogbookTraceabilityHelper

Save the close master event if needed

Specified by:

saveEmpty in interface LogbookTraceabilityHelper

Parameters:

tenantId - the tenant used for log

Throws:

TraceabilityException

storeAndDeleteZip

public void storeAndDeleteZip(Integer tenant,
                              File zipFile,
                              String fileName,
                              String uri,
                              TraceabilityEvent event)
                       throws TraceabilityException

Description copied from interface: LogbookTraceabilityHelper

Store the temporary zip in the final destination (on a specific offer for example) and delete tmp file.

Specified by:

storeAndDeleteZip in interface LogbookTraceabilityHelper

Parameters:

tenant - tenant used for the operation

zipFile - file containing multiple information about the traceability operation (data, merkle, computingData, ...)

fileName - name of the file on the destination

uri - uri of the tmp file

event - traceability event that should be updated by this operation

Throws:

TraceabilityException - if any error occurs

getStepName

public String getStepName()

Specified by:

getStepName in interface LogbookTraceabilityHelper

Returns:

the main eventType code for the specific implementation class

getTimestampStepName

public String getTimestampStepName()

Specified by:

getTimestampStepName in interface LogbookTraceabilityHelper

Returns:

the timestamp eventType code for the specific implementation class

getZipName

public String getZipName()

Specified by:

getZipName in interface LogbookTraceabilityHelper

Returns:

the name of the tmp zip file

getUriName

public String getUriName()

Specified by:

getUriName in interface LogbookTraceabilityHelper

Returns:

the uri of the tmp file

getTraceabilityType

public TraceabilityType getTraceabilityType()

Specified by:

getTraceabilityType in interface LogbookTraceabilityHelper

Returns:

the traceabilityType of the implementation class

getDataSize

public Long getDataSize()
                 throws TraceabilityException

Description copied from interface: LogbookTraceabilityHelper

Warning: This method MUST be used after "saveDataInZip" witch initialize traceabilityIterator

Specified by:

getDataSize in interface LogbookTraceabilityHelper

Returns:

the number of items secured in traceabilityIterator

Throws:

TraceabilityException - if the traceabilityIterator isn't yet initialized

getTraceabilityStartDate

public String getTraceabilityStartDate()

Specified by:

getTraceabilityStartDate in interface LogbookTraceabilityHelper

Returns:

the start date of the traceability (computed from the end date of the last traceability)

getTraceabilityEndDate

public String getTraceabilityEndDate()

Specified by:

getTraceabilityEndDate in interface LogbookTraceabilityHelper

Returns:

the end date of the traceability (now)