Package fr.gouv.vitam.worker.core.plugin
Class GenericReportGenerationHandler
- java.lang.Object
-
- fr.gouv.vitam.worker.core.handler.ActionHandler
-
- fr.gouv.vitam.worker.core.plugin.GenericReportGenerationHandler
-
- All Implemented Interfaces:
VitamAutoCloseable
,WorkerAction
,java.lang.AutoCloseable
- Direct Known Subclasses:
EliminationActionReportGenerationHandler
,TransferReplyReportGenerationHandler
public abstract class GenericReportGenerationHandler extends ActionHandler
Generate the report :
- compute data from batch-report
- store the report file
- clean the batch-report data
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
GenericReportGenerationHandler(CommonReportService<?> reportService)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description ItemStatus
execute(WorkerParameters param, HandlerIO handler)
Execute an actionprotected Report
generateReport(WorkerParameters param, LogbookOperation logbook)
protected abstract java.lang.String
getLogbookActionKey()
protected abstract LogbookOperation
getLogbookInformation(WorkerParameters param)
protected OperationSummary
getOperationSummary(LogbookOperation logbook, java.lang.String processId)
protected abstract java.lang.String
getPluginId()
protected ReportSummary
getReport(LogbookOperation logbook)
protected abstract ReportType
getReportType()
protected java.util.Map<StatusCode,java.lang.Integer>
getStatusStatistic(LogbookEvent logbookEvent)
-
Methods inherited from class fr.gouv.vitam.worker.core.handler.ActionHandler
checkMandatoryParameters, close, updateDetailItemStatus
-
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.worker.core.api.WorkerAction
checkMandatoryIOParameter, executeList
-
-
-
-
Constructor Detail
-
GenericReportGenerationHandler
protected GenericReportGenerationHandler(CommonReportService<?> reportService)
-
-
Method Detail
-
execute
public ItemStatus execute(WorkerParameters param, HandlerIO handler) throws ProcessingException
Description copied from interface:WorkerAction
Execute an action- Parameters:
param
-WorkerParameters
handler
- the handlerIo- Returns:
- CompositeItemStatus:response contains a list of functional message and status code
- Throws:
ProcessingException
- if an error is encountered when executing the action
-
getOperationSummary
protected OperationSummary getOperationSummary(LogbookOperation logbook, java.lang.String processId) throws InvalidParseOperationException
- Throws:
InvalidParseOperationException
-
generateReport
protected Report generateReport(WorkerParameters param, LogbookOperation logbook) throws InvalidParseOperationException
- Throws:
InvalidParseOperationException
-
getReport
protected ReportSummary getReport(LogbookOperation logbook)
-
getStatusStatistic
protected java.util.Map<StatusCode,java.lang.Integer> getStatusStatistic(LogbookEvent logbookEvent)
-
getPluginId
protected abstract java.lang.String getPluginId()
-
getReportType
protected abstract ReportType getReportType()
-
getLogbookActionKey
protected abstract java.lang.String getLogbookActionKey()
-
getLogbookInformation
protected abstract LogbookOperation getLogbookInformation(WorkerParameters param) throws ProcessingException
- Throws:
ProcessingException
-
-