Package fr.gouv.vitam.storage.engine.server.storagelog

Interface StorageLog

All Superinterfaces:

java.lang.AutoCloseable, VitamAutoCloseable

All Known Implementing Classes:

StorageLogFactory

public interface StorageLog
extends VitamAutoCloseable

Storage log provider. It describes methods to be implemented.

Method Summary

Modifier and Type	Method	Description
void	appendAccessLog(java.lang.Integer tenant, AccessLogParameters parameters)	Add a storage access operation log entry.
void	appendWriteLog(java.lang.Integer tenant, StorageLogbookParameters parameters)	Add a storage write operation log entry.
java.lang.String	getFileName(boolean isWriteOperation)
void	initializeStorageLogs()
java.util.List<LogInformation>	rotateLogFile(java.lang.Integer tenantId, boolean isWriteOperation)	Rotate log file, and return previous log information

Methods inherited from interface fr.gouv.vitam.common.model.VitamAutoCloseable

close

Method Detail

appendWriteLog

void appendWriteLog(java.lang.Integer tenant,
                    StorageLogbookParameters parameters)
             throws java.io.IOException

Add a storage write operation log entry.

Parameters:

parameters - the entry parameters

Throws:

java.io.IOException - if an error is encountered

appendAccessLog

void appendAccessLog(java.lang.Integer tenant,
                     AccessLogParameters parameters)
              throws java.io.IOException

Add a storage access operation log entry.

Parameters:

parameters - the entry parameters

Throws:

java.io.IOException - if an error is encountered

rotateLogFile

java.util.List<LogInformation> rotateLogFile(java.lang.Integer tenantId,
                                             boolean isWriteOperation)
                                      throws java.io.IOException

Rotate log file, and return previous log information

Parameters:

tenantId - tenant used for the rotation

isWriteOperation -

Throws:

java.io.IOException

initializeStorageLogs

void initializeStorageLogs()
                    throws java.io.IOException

Throws:

java.io.IOException

getFileName

java.lang.String getFileName(boolean isWriteOperation)