Class LogbookOperationTraceabilityHelper
java.lang.Object
fr.gouv.vitam.logbook.administration.core.LogbookOperationTraceabilityHelper
- All Implemented Interfaces:
LogbookTraceabilityHelper
-
Field Summary
Fields inherited from interface fr.gouv.vitam.logbook.common.traceability.LogbookTraceabilityHelper
INITIAL_START_DATE
-
Constructor Summary
ConstructorDescriptionLogbookOperationTraceabilityHelper
(LogbookOperations logbookOperations, GUID operationID, int temporizationDelayInSeconds, int traceabilityExpirationInSeconds) -
Method Summary
Modifier and TypeMethodDescriptionvoid
createLogbookOperationEvent
(Integer tenantId, String eventType, StatusCode status, TraceabilityEvent event) Update or finalize the traceability entry in the logbook collectionlong
Warning: This method MUST be used after "saveDataInZip" witch initialize traceabilityIteratorboolean
Get the first traceability (in logbook) one month before the given currentDate and return the startDate of the entrybyte[]
Get the first traceability (in logbook) one month before the given currentDate and return the timestampToken of the entryGet the last traceability (in logbook) event and return the startDate of the entrybyte[]
Get the last traceability (in logbook) event and return the timestampToken of the entryGet the first traceability (in logbook) one year before the given currentDate and return the startDate of the entrybyte[]
Get the first traceability (in logbook) one year before the given currentDate and return the timestampToken of the entryvoid
boolean
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
Save the close master event if neededvoid
Prepare and start the traceability operationvoid
storeAndDeleteZip
(Integer tenant, String strategyId, File zipFile, String fileName, TraceabilityEvent event) Store the temporary zip.
-
Field Details
-
STP_OP_SECURISATION
- See Also:
-
-
Constructor Details
-
LogbookOperationTraceabilityHelper
public LogbookOperationTraceabilityHelper(LogbookOperations logbookOperations, GUID operationID, int temporizationDelayInSeconds, int traceabilityExpirationInSeconds) - Parameters:
logbookOperations
- used to search the operation to secureoperationID
- guid of the traceability operationtemporizationDelayInSeconds
- temporization delay (in seconds) for recent logbook operation events.traceabilityExpirationInSeconds
-
-
-
Method Details
-
initialize
- Throws:
TraceabilityException
-
isTraceabilityOperationRequired
- Throws:
TraceabilityException
-
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 interfaceLogbookTraceabilityHelper
- 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 traceabilityFileTraceabilityException
- for any other errors specifically in the search / data transformation
-
getPreviousStartDate
Description copied from interface:LogbookTraceabilityHelper
Get the last traceability (in logbook) event and return the startDate of the entry- Specified by:
getPreviousStartDate
in interfaceLogbookTraceabilityHelper
- Returns:
- the start date of the last traceability entry
- Throws:
InvalidParseOperationException
- if any errors occurs while deserializing entry's data.
-
getPreviousTimestampToken
Description copied from interface:LogbookTraceabilityHelper
Get the last traceability (in logbook) event and return the timestampToken of the entry- Specified by:
getPreviousTimestampToken
in interfaceLogbookTraceabilityHelper
- 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() throws InvalidParseOperationException, TraceabilityExceptionDescription 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 interfaceLogbookTraceabilityHelper
- Returns:
- the start date of the matching entry or null if no matching entry
- Throws:
InvalidParseOperationException
- if any errors occurs while deserializing entry's data.TraceabilityException
- if any other error occurs
-
getPreviousMonthTimestampToken
public byte[] getPreviousMonthTimestampToken() throws InvalidParseOperationException, TraceabilityExceptionDescription 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 interfaceLogbookTraceabilityHelper
- Returns:
- the timestamp token of the matching entry or null if no matching entry
- Throws:
InvalidParseOperationException
- if any errors occurs while deserializing entry's data.TraceabilityException
- if any other error occurs
-
getPreviousYearStartDate
public String getPreviousYearStartDate() throws InvalidParseOperationException, TraceabilityExceptionDescription 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 interfaceLogbookTraceabilityHelper
- Returns:
- the start date of the matching entry or null if no matching entry
- Throws:
InvalidParseOperationException
- if any errors occurs while deserializing entry's data.TraceabilityException
- if any other error occurs
-
getPreviousYearTimestampToken
public byte[] getPreviousYearTimestampToken() throws InvalidParseOperationException, TraceabilityExceptionDescription 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 interfaceLogbookTraceabilityHelper
- Returns:
- the timestamp token of the matching entry or null if no matching entry
- Throws:
InvalidParseOperationException
- if any errors occurs while deserializing entry's data.TraceabilityException
- if any other error occurs
-
startTraceability
Description copied from interface:LogbookTraceabilityHelper
Prepare and start the traceability operation- Specified by:
startTraceability
in interfaceLogbookTraceabilityHelper
- 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 interfaceLogbookTraceabilityHelper
- Parameters:
tenantId
- tenant used for the operationeventType
- code of the eventType for the entrystatus
- status of the entryevent
- data of the entry- Throws:
TraceabilityException
- if any error occurs
-
saveEmpty
Description copied from interface:LogbookTraceabilityHelper
Save the close master event if needed- Specified by:
saveEmpty
in interfaceLogbookTraceabilityHelper
- Parameters:
tenantId
- the tenant used for log- Throws:
TraceabilityException
-
storeAndDeleteZip
public void storeAndDeleteZip(Integer tenant, String strategyId, File zipFile, String fileName, TraceabilityEvent event) throws TraceabilityException Description copied from interface:LogbookTraceabilityHelper
Store the temporary zip.- Specified by:
storeAndDeleteZip
in interfaceLogbookTraceabilityHelper
- Parameters:
tenant
- tenant used for the operationstrategyId
- strategy used for the storagezipFile
- file containing multiple information about the traceability operation (data, merkle, computingData, ...)fileName
- name of the file on the destinationevent
- traceability event that should be updated by this operation- Throws:
TraceabilityException
- if any error occurs
-
getStepName
- Specified by:
getStepName
in interfaceLogbookTraceabilityHelper
- Returns:
- the main eventType code for the specific implementation class
-
getTimestampStepName
- Specified by:
getTimestampStepName
in interfaceLogbookTraceabilityHelper
- Returns:
- the timestamp eventType code for the specific implementation class
-
getZipName
- Specified by:
getZipName
in interfaceLogbookTraceabilityHelper
- Returns:
- the name of the tmp zip file
-
getTraceabilityType
- Specified by:
getTraceabilityType
in interfaceLogbookTraceabilityHelper
- Returns:
- the traceabilityType of the implementation class
-
getMaxEntriesReached
public boolean getMaxEntriesReached()- Specified by:
getMaxEntriesReached
in interfaceLogbookTraceabilityHelper
- Returns:
- true if max entries reached (unit & object group lifecycle traceability operation are limited in size)
-
getTraceabilityStatistics
- Specified by:
getTraceabilityStatistics
in interfaceLogbookTraceabilityHelper
-
getDataSize
Description copied from interface:LogbookTraceabilityHelper
Warning: This method MUST be used after "saveDataInZip" witch initialize traceabilityIterator- Specified by:
getDataSize
in interfaceLogbookTraceabilityHelper
- Returns:
- the number of items secured in traceabilityIterator
- Throws:
TraceabilityException
- if the traceabilityIterator isn't yet initialized
-
getTraceabilityStartDate
- Specified by:
getTraceabilityStartDate
in interfaceLogbookTraceabilityHelper
- Returns:
- the start date of the traceability (computed from the end date of the last traceability)
-
getTraceabilityEndDate
- Specified by:
getTraceabilityEndDate
in interfaceLogbookTraceabilityHelper
- Returns:
- the end date of the traceability (now)
-