Uses of Interface
fr.gouv.vitam.processing.common.parameter.WorkerParameters

Packages that use WorkerParameters

Package	Description
fr.gouv.vitam.processing.common.automation
fr.gouv.vitam.processing.common.parameter	Provides common Parameters classes and utility classes for the Processing module.
fr.gouv.vitam.processing.distributor.api	Provides API classes for the Processing Distributor module
fr.gouv.vitam.processing.distributor.v2
fr.gouv.vitam.processing.engine.api	Provides API classes for the Process Distributor module
fr.gouv.vitam.processing.engine.core	Provides core implementation for the Processing Engine module.
fr.gouv.vitam.processing.management.api	Provides API classes for the Processing Management module
fr.gouv.vitam.processing.management.core	Provides core implementation for the Processing Management module.
fr.gouv.vitam.worker.common	Provides common classes for the Worker module.
fr.gouv.vitam.worker.common.utils	Provides common utility classes for the Worker module.
fr.gouv.vitam.worker.core.api	Provides API definition for the Worker Core module.
fr.gouv.vitam.worker.core.handler	Provides Handler classes for the Worker Core module
fr.gouv.vitam.worker.core.impl	Provides
fr.gouv.vitam.worker.core.plugin	Plugin package in worker module
fr.gouv.vitam.worker.core.plugin.dip

Uses of WorkerParameters in fr.gouv.vitam.processing.common.automation

Methods in fr.gouv.vitam.processing.common.automation with parameters of type WorkerParameters

Modifier and Type	Method and Description
void	IEventsState.next(WorkerParameters workerParameters) Like a resume but pause at the next step
void	IEventsProcessEngine.onComplete(ItemStatus itemStatus, WorkerParameters workerParameters) The ProcessEngine callback on complete step (for any status code)
void	IEventsProcessEngine.onError(Throwable throwable, WorkerParameters workerParameters) The ProcessEngine callback on system error occurred
void	IEventsProcessEngine.onPauseOrCancel(PauseOrCancelAction pauseOrCancelAction, WorkerParameters workerParameters) The ProcessEngine callback onPauseOrCancel when the step is paused or cancelled
void	IEventsState.replay(WorkerParameters workerParameters) Replay the last executed step, or if it s stated, the step passed as a parameter
void	IEventsState.resume(WorkerParameters workerParameters) Do an evaluation of the State RUNNING If the state is not permitted a StateNotAllowedException is thrown Else call doRunning method

Uses of WorkerParameters in fr.gouv.vitam.processing.common.parameter

Classes in fr.gouv.vitam.processing.common.parameter that implement WorkerParameters

Modifier and Type	Class and Description
class	DefaultWorkerParameters Default parameters for worker

Methods in fr.gouv.vitam.processing.common.parameter that return WorkerParameters

Modifier and Type	Method and Description
WorkerParameters	WorkerParameters.putParameterValue(WorkerParameterName parameterName, String parameterValue) Put parameterValue on mapParameters with parameterName key If parameterKey already exists, then override it (no check)
WorkerParameters	WorkerParameters.setContainerName(String containerName) Set the container name value
WorkerParameters	WorkerParameters.setCurrentStep(String currentStep) Set the current step value
WorkerParameters	WorkerParameters.setFromParameters(WorkerParameters parameters) Set parameters from another WorkerParameters
WorkerParameters	WorkerParameters.setLogbookTypeProcess(LogbookTypeProcess logbookTypeProcess) Set the logbook Type Process
WorkerParameters	WorkerParameters.setMap(Map<String,String> map) Set from map using String as Key
WorkerParameters	WorkerParameters.setMetadataRequest(String metadataRequest) Set the request metadata request value
WorkerParameters	WorkerParameters.setObjectId(String objectId) Set the object id value
WorkerParameters	WorkerParameters.setObjectName(String objectName) Set the object name value
WorkerParameters	WorkerParameters.setObjectNameList(List<String> objectNameList) Set the object name value
WorkerParameters	WorkerParameters.setPreviousStep(String previousStep) Set the previous step value
WorkerParameters	WorkerParameters.setProcessId(String processId) Set the process id value
WorkerParameters	WorkerParameters.setUrlMetadata(String urlMetadata) Set the url of metadata resource value
WorkerParameters	WorkerParameters.setUrlWorkspace(String urlWorkspace) Set the url of workspace resource value
WorkerParameters	WorkerParameters.setWorkerGUID(GUID workerGUID) Set the worker GUID value

Methods in fr.gouv.vitam.processing.common.parameter with parameters of type WorkerParameters

Modifier and Type	Method and Description
WorkerParameters	WorkerParameters.setFromParameters(WorkerParameters parameters) Set parameters from another WorkerParameters

Uses of WorkerParameters in fr.gouv.vitam.processing.distributor.api

Methods in fr.gouv.vitam.processing.distributor.api with parameters of type WorkerParameters

Modifier and Type	Method and Description
ItemStatus	ProcessDistributor.distribute(WorkerParameters workParams, Step step, String operationId, PauseRecover pauseRecover) Distribute different steps (execute a workflow actions step by step)

Uses of WorkerParameters in fr.gouv.vitam.processing.distributor.v2

Methods in fr.gouv.vitam.processing.distributor.v2 with parameters of type WorkerParameters

Modifier and Type	Method and Description
ItemStatus	ProcessDistributorImpl.distribute(WorkerParameters workParams, Step step, String operationId, PauseRecover pauseRecover) Temporary method for distribution supporting multi-list

Uses of WorkerParameters in fr.gouv.vitam.processing.engine.api

Methods in fr.gouv.vitam.processing.engine.api with parameters of type WorkerParameters

Modifier and Type	Method and Description
void	ProcessEngine.start(ProcessStep step, WorkerParameters workerParameters, Map<String,String> params, PauseRecover pauseRecover) Start the execution of the given step

Uses of WorkerParameters in fr.gouv.vitam.processing.engine.core

Methods in fr.gouv.vitam.processing.engine.core with parameters of type WorkerParameters

Modifier and Type	Method and Description
ProcessEngineImpl	ProcessEngineFactory.create(WorkerParameters workParams, ProcessDistributor processDistributor)
void	ProcessEngineImpl.start(ProcessStep step, WorkerParameters workerParameters, Map<String,String> params, PauseRecover pauseRecover)

Constructors in fr.gouv.vitam.processing.engine.core with parameters of type WorkerParameters

Constructor and Description
ProcessEngineImpl(WorkerParameters workerParameters, ProcessDistributor processDistributor)

Uses of WorkerParameters in fr.gouv.vitam.processing.management.api

Methods in fr.gouv.vitam.processing.management.api with parameters of type WorkerParameters

Modifier and Type	Method and Description
ProcessWorkflow	ProcessManagement.init(WorkerParameters workerParameters, String workflowId, LogbookTypeProcess logbookTypeProcess, Integer tenantId, String contextId) Init a new process workflow
ItemStatus	ProcessManagement.next(WorkerParameters workerParameters, Integer tenantId) Handle a next action for the corresponding process workflow
ItemStatus	ProcessManagement.replay(WorkerParameters workerParameters, Integer tenantId) Handle a replay action for the corresponding process workflow
ItemStatus	ProcessManagement.resume(WorkerParameters workerParameters, Integer tenantId) Handle a resume action for the corresponding process workflow

Uses of WorkerParameters in fr.gouv.vitam.processing.management.core

Methods in fr.gouv.vitam.processing.management.core with parameters of type WorkerParameters

Modifier and Type	Method and Description
protected void	StateMachine.doReplay(WorkerParameters workerParameters, ProcessState targetState) Change state of the process to running Can be called only from pause state
protected void	StateMachine.doRunning(WorkerParameters workerParameters, ProcessState targetState) Change state of the process to running Can be called only from pause state
protected void	StateMachine.executeFinallyStep(WorkerParameters workerParameters) Execute the finally step of the workflow Update global status of the workflow Persist the process workflow
protected void	StateMachine.executeSteps(WorkerParameters workerParameters, PauseRecover pauseRecover, boolean backwards) Execute steps of the workflow and manage index of the current step Call engine to execute the current step
protected void	StateMachine.finalizeLogbook(WorkerParameters workParams) Create the final logbook entry for the corresponding process workflow This entry was created in ingest internal and as the process is full async we moved it to here
ProcessWorkflow	ProcessManagementImpl.init(WorkerParameters workerParameters, String workflowId, LogbookTypeProcess logbookTypeProcess, Integer tenantId, String contextId)
void	StateMachine.next(WorkerParameters workerParameters)
ItemStatus	ProcessManagementImpl.next(WorkerParameters workerParameters, Integer tenantId)
void	StateMachine.onComplete(ItemStatus itemStatus, WorkerParameters workerParameters)
void	StateMachine.onError(Throwable throwable, WorkerParameters workerParameters)
void	StateMachine.onPauseOrCancel(PauseOrCancelAction pauseCancelAction, WorkerParameters workerParameters)
void	StateMachine.replay(WorkerParameters workerParameters)
ItemStatus	ProcessManagementImpl.replay(WorkerParameters workerParameters, Integer tenantId)
void	StateMachine.resume(WorkerParameters workerParameters)
ItemStatus	ProcessManagementImpl.resume(WorkerParameters workerParameters, Integer tenantId)

Uses of WorkerParameters in fr.gouv.vitam.worker.common

Methods in fr.gouv.vitam.worker.common that return WorkerParameters

Modifier and Type	Method and Description
WorkerParameters	DescriptionStep.getWorkParams() Get the workParams

Methods in fr.gouv.vitam.worker.common with parameters of type WorkerParameters

Modifier and Type	Method and Description
void	DescriptionStep.setWorkParams(WorkerParameters workParams) Set the workParams

Constructors in fr.gouv.vitam.worker.common with parameters of type WorkerParameters

Constructor and Description
DescriptionStep(Step step, WorkerParameters workParams) Constructor.

Uses of WorkerParameters in fr.gouv.vitam.worker.common.utils

Methods in fr.gouv.vitam.worker.common.utils with parameters of type WorkerParameters

Modifier and Type	Method and Description
SedaUtils.CheckSedaValidationStatus	SedaUtils.checkSedaValidation(WorkerParameters params, ItemStatus itemStatus) The method is used to validate SEDA by XSD
Map<String,Map<String,String>>	SedaUtils.checkSupportedDataObjectVersion(WorkerParameters params) check if the version list of the manifest.xml in workspace is valid
long	SedaUtils.computeTotalSizeOfObjectsInManifest(WorkerParameters params) Compute the total size of objects listed in the manifest.xml file
Map<String,Object>	SedaUtils.getMandatoryValues(WorkerParameters params) get Message Identifier from seda
long	SedaUtils.getManifestSize(WorkerParameters params) Get the size of the manifest file
static String	LogbookLifecycleWorkerHelper.getObjectID(WorkerParameters params)
void	ArchiveUnitUpdateUtils.logLifecycle(WorkerParameters params, String auGuid, StatusCode code, String evDetData, LogbookLifeCyclesClient logbookLifeCycleClient) Method used to log lifecycles unit
static void	LogbookLifecycleWorkerHelper.updateLifeCycleForBegining(LogbookLifeCyclesClientHelper helper, LogbookLifeCycleParameters logbookLifecycleParameters, WorkerParameters params, LogbookTypeProcess logbookTypeProcess)
static void	LogbookLifecycleWorkerHelper.updateLifeCycleStep(LogbookLifeCyclesClientHelper helper, LogbookLifeCycleParameters logbookLifecycleParameters, WorkerParameters params, String lfcEventType, LogbookTypeProcess logbookTypeProcess, StatusCode statusCode, String... additionalParams)

Uses of WorkerParameters in fr.gouv.vitam.worker.core.api

Methods in fr.gouv.vitam.worker.core.api with parameters of type WorkerParameters

Modifier and Type	Method and Description
ItemStatus	WorkerAction.execute(WorkerParameters param, HandlerIO handler) Execute an action
ItemStatus	Worker.run(WorkerParameters workParams, Step step) Worker execute the step's actions

Uses of WorkerParameters in fr.gouv.vitam.worker.core.handler

Methods in fr.gouv.vitam.worker.core.handler with parameters of type WorkerParameters

Modifier and Type	Method and Description
void	ActionHandler.checkMandatoryParameters(WorkerParameters parameters) Check mandatory parameters
ItemStatus	RollBackActionHandler.execute(WorkerParameters params, HandlerIO param)
ItemStatus	FinalizeLifecycleTraceabilityActionHandler.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	CommitLifeCycleActionHandler.execute(WorkerParameters params, HandlerIO param)
ItemStatus	GenerateAuditReportActionHandler.execute(WorkerParameters param, HandlerIO handler)
ItemStatus	ExtractSedaActionHandler.execute(WorkerParameters params, HandlerIO ioParam)
ItemStatus	ListLifecycleTraceabilityActionHandler.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	CheckStorageAvailabilityActionHandler.execute(WorkerParameters params, HandlerIO handlerIO)
ItemStatus	AccessionRegisterActionHandler.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	VerifyTimeStampActionHandler.execute(WorkerParameters param, HandlerIO handler)
ItemStatus	CheckIngestContractActionHandler.execute(WorkerParameters params, HandlerIO ioParam)
ItemStatus	CheckSedaActionHandler.execute(WorkerParameters params, HandlerIO handlerIO)
ItemStatus	ListArchiveUnitsActionHandler.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	CheckHeaderActionHandler.execute(WorkerParameters params, HandlerIO handlerIO)
ItemStatus	CheckNoObjectsActionHandler.execute(WorkerParameters params, HandlerIO handlerIO)
ItemStatus	CheckVersionActionHandler.execute(WorkerParameters params, HandlerIO handlerIO)
ItemStatus	ListRunningIngestsActionHandler.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	DummyHandler.execute(WorkerParameters param, HandlerIO handler)
ItemStatus	TransferNotificationActionHandler.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	CheckArchiveProfileRelationActionHandler.execute(WorkerParameters params, HandlerIO handlerIO)
ItemStatus	VerifyMerkleTreeActionHandler.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	CheckArchiveProfileActionHandler.execute(WorkerParameters params, HandlerIO handlerIO)
ItemStatus	CheckOriginatingAgencyHandler.execute(WorkerParameters param, HandlerIO handler)
ItemStatus	PrepareAuditActionHandler.execute(WorkerParameters param, HandlerIO handler)
ItemStatus	PrepareStorageInfoActionHandler.execute(WorkerParameters params, HandlerIO handlerIO)
ItemStatus	CheckObjectsNumberActionHandler.execute(WorkerParameters params, HandlerIO handlerIO)
ItemStatus	CheckObjectUnitConsistencyActionHandler.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	CheckDataObjectPackageActionHandler.execute(WorkerParameters params, HandlerIO handlerIO)
ItemStatus	PrepareTraceabilityCheckProcessActionHandler.execute(WorkerParameters param, HandlerIO handler)
com.fasterxml.jackson.databind.node.ObjectNode	ExtractSedaActionHandler.extractSEDA(LogbookLifeCyclesClient logbookLifeCycleClient, WorkerParameters params, ItemStatus globalCompositeItemStatus, UnitType workflowUnitType) Split Element from InputStream and write it to workspace

Uses of WorkerParameters in fr.gouv.vitam.worker.core.impl

Methods in fr.gouv.vitam.worker.core.impl with parameters of type WorkerParameters

Modifier and Type	Method and Description
ItemStatus	WorkerImpl.run(WorkerParameters workParams, Step step)

Uses of WorkerParameters in fr.gouv.vitam.worker.core.plugin

Methods in fr.gouv.vitam.worker.core.plugin with parameters of type WorkerParameters

Modifier and Type	Method and Description
ItemStatus	UpdateObjectGroupPlugin.execute(WorkerParameters params, HandlerIO handlerIO)
ItemStatus	StoreMetaDataObjectGroupActionPlugin.execute(WorkerParameters params, HandlerIO actionDefinition)
ItemStatus	CheckClassificationLevelActionPlugin.execute(WorkerParameters param, HandlerIO handler)
ItemStatus	RunningIngestsUpdateActionPlugin.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	CheckIntegrityObjectPlugin.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	CreateObjectSecureFileActionPlugin.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	CreateUnitSecureFileActionPlugin.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	StoreMetaDataUnitActionPlugin.execute(WorkerParameters params, HandlerIO actionDefinition)
ItemStatus	StoreObjectGroupActionPlugin.execute(WorkerParameters params, HandlerIO actionDefinition)
ItemStatus	UnitsRulesComputePlugin.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	CheckConformityActionPlugin.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	AuditCheckObjectPlugin.execute(WorkerParameters param, HandlerIO handler)
ItemStatus	CheckExistenceObjectPlugin.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	IndexUnitActionPlugin.execute(WorkerParameters params, HandlerIO param)
ItemStatus	IndexObjectGroupActionPlugin.execute(WorkerParameters params, HandlerIO actionDefinition)
ItemStatus	CheckArchiveUnitSchemaActionPlugin.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	FormatIdentificationActionPlugin.execute(WorkerParameters params, HandlerIO handler)
ItemStatus	ArchiveUnitRulesUpdateActionPlugin.execute(WorkerParameters params, HandlerIO handler)

Uses of WorkerParameters in fr.gouv.vitam.worker.core.plugin.dip

Methods in fr.gouv.vitam.worker.core.plugin.dip with parameters of type WorkerParameters

Modifier and Type	Method and Description
ItemStatus	CreateManifest.execute(WorkerParameters param, HandlerIO handlerIO)
ItemStatus	PutBinaryOnWorkspace.execute(WorkerParameters param, HandlerIO handler)
ItemStatus	StoreDIP.execute(WorkerParameters params, HandlerIO handler)