Package fr.gouv.vitam.worker.core.plugin.purge

Class PurgeUnitPlugin

java.lang.Object

fr.gouv.vitam.worker.core.handler.ActionHandler

fr.gouv.vitam.worker.core.plugin.purge.PurgeUnitPlugin

All Implemented Interfaces:

VitamAutoCloseable, WorkerAction, java.lang.AutoCloseable

Direct Known Subclasses:

EliminationActionDeleteUnitPlugin, TransferReplyDeleteUnitPlugin

public class PurgeUnitPlugin
extends ActionHandler

Purge unit plugin.

Constructor Summary

Constructors

Modifier	Constructor	Description
	PurgeUnitPlugin(java.lang.String actionId)	Default constructor
protected	PurgeUnitPlugin(java.lang.String actionId, PurgeDeleteService purgeDeleteService, MetaDataClientFactory metaDataClientFactory, PurgeReportService purgeReportService, LogbookLifeCyclesClientFactory llfcClientFactory)	Test only constructor

Method Summary

Modifier and Type	Method	Description
void	checkMandatoryIOParameter(HandlerIO handler)	Check mandatory parameter
ItemStatus	execute(WorkerParameters param, HandlerIO handler)	Execute an action
java.util.List<ItemStatus>	executeList(WorkerParameters param, HandlerIO handler)

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

Constructor Detail

PurgeUnitPlugin

public PurgeUnitPlugin(java.lang.String actionId)

Default constructor

Parameters:

actionId -

PurgeUnitPlugin

protected PurgeUnitPlugin(java.lang.String actionId,
                          PurgeDeleteService purgeDeleteService,
                          MetaDataClientFactory metaDataClientFactory,
                          PurgeReportService purgeReportService,
                          LogbookLifeCyclesClientFactory llfcClientFactory)

Test only constructor

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

executeList

public java.util.List<ItemStatus> executeList(WorkerParameters param,
                                              HandlerIO handler)

Returns:

checkMandatoryIOParameter

public void checkMandatoryIOParameter(HandlerIO handler)
                               throws ProcessingException

Description copied from interface: WorkerAction

Check mandatory parameter

Parameters:

handler - input output list

Throws:

ProcessingException - when handler io is not complete