Package fr.gouv.vitam.worker.core.api
Interface WorkerAction
- All Known Implementing Classes:
AbstractAccessionRegisterAction,AbstractGraphComputePlugin,ActionHandler,ArchiveUnitRulesUpdateActionPlugin,AuditCheckObjectPlugin,AuditFinalizePlugin,AuditPreparePlugin,BuildObjectGroupTraceabilityActionPlugin,BuildTraceabilityActionPlugin,BuildUnitTraceabilityActionPlugin,BulkAtomicUpdateFinalize,BulkAtomicUpdateProcess,CheckArchiveProfileActionHandler,CheckArchiveProfileRelationActionHandler,CheckArchiveUnitProfileActionPlugin,CheckArchiveUnitSchemaActionPlugin,CheckAtrAndAddItToWorkspacePlugin,CheckAttachementActionHandler,CheckClassificationLevelActionPlugin,CheckConcurrentWorkflowLockHandler,CheckConformityActionPlugin,CheckDataObjectPackageActionHandler,CheckDistributionThreshold,CheckDistributionThresholdBase,CheckHeaderActionHandler,CheckIngestContractActionHandler,CheckNoObjectsActionHandler,CheckObjectGroupSchemaActionPlugin,CheckObjectSizeActionPlugin,CheckObjectsNumberActionHandler,CheckObjectUnitConsistencyActionHandler,CheckOriginatingAgencyHandler,CheckQueriesThreshold,CheckResourceAvailability,CheckSedaActionHandler,ChecksSecureTraceabilityDataHashesPlugin,ChecksSecureTraceabilityDataStoragelogPlugin,CheckStorageAvailabilityActionHandler,CheckVersionActionHandler,CommitLifeCycleActionHandler,CommitLifeCycleObjectGroupActionHandler,CommitLifeCycleUnitActionHandler,ComputedInheritedRulesCheckDistributionThreshold,ComputeInheritedRuleProgenyIdentifierPlugin,ComputeInheritedRulesActionPlugin,ComputeInheritedRulesDeletePlugin,ComputeInheritedRulesFinalizationPlugin,ComputeInheritedRulesInvalidatorPlugin,ComputeInheritedRulesPreparationPlugin,CreateManifest,DataCorrectionFinalize,DataRectificationCheckResourceAvailability,DataRectificationStep,DeleteGotVersionsAccessionRegisterUpdatePlugin,DeleteGotVersionsActionPlugin,DeleteGotVersionsFinalizationPlugin,DeleteGotVersionsPreparationPlugin,DeleteGotVersionsStoragePlugin,DeleteGotVersionsStoreMetadataAndLfcPlugin,DummyHandler,EliminationActionAccessionRegisterPreparationHandler,EliminationActionAccessionRegisterUpdatePlugin,EliminationActionCheckDistributionThresholdHandler,EliminationActionDeleteObjectGroupPlugin,EliminationActionDeleteUnitPlugin,EliminationActionDetachObjectGroupPlugin,EliminationActionFinalizationHandler,EliminationActionObjectGroupPreparationHandler,EliminationActionReportGenerationHandler,EliminationActionUnitPreparationHandler,EliminationAnalysisCheckDistributionThresholdHandler,EliminationAnalysisFinalizationHandler,EliminationAnalysisPreparationHandler,EliminationAnalysisUnitIndexationPlugin,EliminationCheckDistributionThresholdBase,EvidenceAuditDatabaseCheck,EvidenceAuditExtractFromZip,EvidenceAuditFinalize,EvidenceAuditGenerateReports,EvidenceAuditListSecuredFiles,EvidenceAuditPrepare,EvidenceAuditPrepareReport,ExportCheckResourceAvailability,ExtractSecureTraceabilityDataFilePlugin,ExtractSedaActionHandler,FinalizeLifecycleTraceabilityActionPlugin,FinalizeObjectGroupLifecycleTraceabilityActionPlugin,FinalizeUnitLifecycleTraceabilityActionPlugin,FormatIdentificationActionPlugin,GenerateLifecycleTraceabilityActionPlugin,GenerateObjectGroupLifecycleTraceabilityActionPlugin,GenerateUnitLifecycleTraceabilityActionPlugin,GenericReportGenerationHandler,HelloWorldPlugin,IndexObjectGroupActionPlugin,IndexUnitActionPlugin,IngestAccessionRegisterActionHandler,IngestCleanupAccessionRegisterUpdatePlugin,IngestCleanupDeleteObjectGroupPlugin,IngestCleanupDeleteUnitPlugin,IngestCleanupEligibilityValidationPlugin,IngestCleanupFinalizationPlugin,IngestCleanupPreparationPlugin,IngestCleanupRequestValidationPlugin,IngestPrepareActionHandler,ListArchiveUnitsActionHandler,ListRunningIngestsActionHandler,MassUpdateCheck,MassUpdateFinalize,MassUpdateRulesCheck,MassUpdateUnitsProcess,MassUpdateUnitsRulesProcess,MigrationFinalize,MigrationUnitPrepare,MigrationUnits,ObjectGroupGraphComputePlugin,PrepareBulkAtomicUpdate,PrepareLfcTraceabilityActionPlugin,PrepareObjectGroupLfcTraceabilityActionPlugin,PrepareStorageInfoActionHandler,PrepareStorageStrategiesPlugin,PrepareUnitLfcTraceabilityActionPlugin,PrepareUpdateUnits,PreservationAccessionRegisterActionHandler,PreservationActionPlugin,PreservationCheckResourceAvailability,PreservationExtractionAUPlugin,PreservationFinalizationPlugin,PreservationGenerateBinaryHash,PreservationInsertionAuMetadata,PreservationObjectGroupMetadataSecurityChecks,PreservationPreparationInsertionAuMetadata,PreservationPreparationPlugin,PreservationSiegfriedPlugin,PreservationStorageBinaryPlugin,PreservationStorageMetadataAndLfc,PreservationTesseractPlugin,PreservationUnitMetadataSecurityChecks,PreservationUpdateObjectGroupPlugin,ProbativeCreateDistributionFile,ProbativeCreateReport,ProbativeCreateReportEntry,PurgeAccessionRegisterPreparationHandler,PurgeAccessionRegisterUpdatePlugin,PurgeDeleteObjectGroupPlugin,PurgeDetachObjectGroupPlugin,PurgeObjectGroupPreparationHandler,PurgeUnitPlugin,PutBinaryOnWorkspace,ReclassificationFinalizationHandler,ReclassificationPreparationCheckGraphHandler,ReclassificationPreparationCheckHoldRulesHandler,ReclassificationPreparationLoadRequestHandler,ReclassificationPreparationUpdateDistributionHandler,RetrieveSecureTraceabilityDataFilePlugin,RevertUpdateUnitCheckPlugin,RevertUpdateUnitFinalizePlugin,RevertUpdateUnitPlugin,RollBackActionHandler,RunningIngestsUpdateActionPlugin,SaveAtrPlugin,StoreExports,StoreMetadataObjectActionHandler,StoreMetaDataObjectGroupActionPlugin,StoreMetaDataUnitActionPlugin,StoreObjectActionHandler,StoreObjectGroupActionPlugin,TraceabilityFinalizationPlugin,TraceabilityLinkedCheckPreparePlugin,TransferNotificationActionHandler,TransferReplyAccessionRegisterPreparationHandler,TransferReplyAccessionRegisterUpdatePlugin,TransferReplyDeleteObjectGroupPlugin,TransferReplyDeleteSIP,TransferReplyDeleteUnitPlugin,TransferReplyDetachObjectGroupPlugin,TransferReplyFinalizationPlugin,TransferReplyObjectGroupPreparationHandler,TransferReplyReportGenerationHandler,TransferReplyUnitPreparationHandler,UnitAttachmentPlugin,UnitDetachmentPlugin,UnitGraphComputePlugin,UnitMetadataRulesUpdateCheckConsistency,UnitsRulesComputePlugin,UpdateObjectGroupPlugin,UpdateUnitFinalize,UploadSIPActionHandler,VerifyAtrPlugin,VerifyMerkleTreeActionHandler,VerifyTimeStampActionHandler
public interface WorkerAction
Action interface: is a contract for different action Handler event
action handler class must be implement this interface
-
Method Summary
Modifier and TypeMethodDescriptiondefault voidcheckMandatoryIOParameter(HandlerIO handler) Check mandatory parameterdefault ItemStatusexecute(WorkerParameters param, HandlerIO handler) Execute an actiondefault List<ItemStatus>executeList(WorkerParameters workerParameters, HandlerIO handler)
-
Method Details
-
execute
Execute an action- Parameters:
param-WorkerParametershandler- 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
default List<ItemStatus> executeList(WorkerParameters workerParameters, HandlerIO handler) throws ProcessingException - Parameters:
workerParameters-handler-- Returns:
- Throws:
ProcessingException
-
checkMandatoryIOParameter
Check mandatory parameter- Parameters:
handler- input output list- Throws:
ProcessingException- when handler io is not complete
-