Package fr.gouv.vitam.worker.core.handler

Class CommitLifeCycleActionHandler

java.lang.Object

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

fr.gouv.vitam.worker.core.handler.CommitLifeCycleActionHandler

All Implemented Interfaces:

VitamAutoCloseable, WorkerAction, java.lang.AutoCloseable

Direct Known Subclasses:

CommitLifeCycleObjectGroupActionHandler, CommitLifeCycleUnitActionHandler

public abstract class CommitLifeCycleActionHandler
extends ActionHandler

CommitLifeCycle Handler

Constructor Summary

Constructors

Constructor	Description
CommitLifeCycleActionHandler()	Default Constructor

Method Summary

Modifier and Type	Method	Description
abstract ItemStatus	buildFinalItemStatus(ItemStatus itemStatus)	Returns the final ItemStatus related to the current actionHandler execution based on a given one
void	checkMandatoryIOParameter(HandlerIO handler)	Check mandatory parameter
abstract void	commitLifeCycle(HandlerIO handlerIO, java.lang.String objectID, java.lang.String operationId)	Runs a commit process for the given object (Unit or ObjectGroup) and a given operation
ItemStatus	execute(WorkerParameters params, HandlerIO handlerIO)	Execute an action
abstract ItemStatus	getItemStatus()	Returns an ItemStatus

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

executeList

Constructor Detail

CommitLifeCycleActionHandler

public CommitLifeCycleActionHandler()

Default Constructor

Method Detail

execute

public ItemStatus execute(WorkerParameters params,
                          HandlerIO handlerIO)

Description copied from interface: WorkerAction

Execute an action

Parameters:

params - WorkerParameters

handlerIO - the handlerIo

Returns:

CompositeItemStatus:response contains a list of functional message and status code

getItemStatus

public abstract ItemStatus getItemStatus()

Returns an ItemStatus

Returns:

an ItemStatus

buildFinalItemStatus

public abstract ItemStatus buildFinalItemStatus(ItemStatus itemStatus)

Returns the final ItemStatus related to the current actionHandler execution based on a given one

Parameters:

itemStatus - a given ItemStatus

Returns:

the final ActionHandler ItemStatus

commitLifeCycle

public abstract void commitLifeCycle(HandlerIO handlerIO,
                                     java.lang.String objectID,
                                     java.lang.String operationId)
                              throws ProcessingException,
                                     LogbookClientBadRequestException,
                                     LogbookClientNotFoundException,
                                     LogbookClientServerException

Runs a commit process for the given object (Unit or ObjectGroup) and a given operation

Parameters:

handlerIO - a HandlerIO instance

objectID - the object id to commit

operationId - the operation id

Throws:

ProcessingException - if processing exception occurred when commit unit lifecycle

LogbookClientBadRequestException - if the argument is incorrect when commit unit lifecycle

LogbookClientNotFoundException - if the element was not created before when commit unit lifecycle

LogbookClientServerException - if the Server got an internal error when commit unit lifecycle

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