Class ActionHandler
java.lang.Object
fr.gouv.vitam.worker.core.handler.ActionHandler
- All Implemented Interfaces:
VitamAutoCloseable,AutoCloseable
- Direct Known Subclasses:
AbstractAccessionRegisterAction,AbstractGraphComputePlugin,ArchiveUnitRulesUpdateActionPlugin,AuditCheckObjectPlugin,AuditFinalizePlugin,AuditPreparePlugin,BuildTraceabilityActionPlugin,CheckArchiveProfileActionHandler,CheckArchiveProfileRelationActionHandler,CheckArchiveUnitProfileActionPlugin,CheckArchiveUnitSchemaActionPlugin,CheckAtrAndAddItToWorkspacePlugin,CheckAttachementActionHandler,CheckClassificationLevelActionPlugin,CheckConcurrentWorkflowLockHandler,CheckConformityActionPlugin,CheckDataObjectPackageActionHandler,CheckDistributionThresholdBase,CheckHeaderActionHandler,CheckIngestContractActionHandler,CheckNoObjectsActionHandler,CheckObjectGroupSchemaActionPlugin,CheckObjectSizeActionPlugin,CheckObjectsNumberActionHandler,CheckObjectUnitConsistencyActionHandler,CheckOriginatingAgencyHandler,CheckQueriesThreshold,CheckResourceAvailability,CheckSedaActionHandler,ChecksSecureTraceabilityDataHashesPlugin,ChecksSecureTraceabilityDataStoragelogPlugin,CheckStorageAvailabilityActionHandler,CheckVersionActionHandler,CommitLifeCycleActionHandler,ComputeInheritedRuleProgenyIdentifierPlugin,ComputeInheritedRulesActionPlugin,ComputeInheritedRulesDeletePlugin,ComputeInheritedRulesFinalizationPlugin,ComputeInheritedRulesInvalidatorPlugin,ComputeInheritedRulesPreparationPlugin,CreateManifest,DataCorrectionFinalize,DataRectificationStep,DeleteGotVersionsAccessionRegisterUpdatePlugin,DeleteGotVersionsActionPlugin,DeleteGotVersionsFinalizationPlugin,DeleteGotVersionsPreparationPlugin,DeleteGotVersionsStoragePlugin,DeleteGotVersionsStoreMetadataAndLfcPlugin,DummyHandler,EliminationActionFinalizationHandler,EliminationActionUnitPreparationHandlerBase,EliminationAnalysisFinalizationHandler,EliminationAnalysisPreparationHandler,EliminationAnalysisUnitIndexationPlugin,EliminationCheckDistributionThresholdBase,EvidenceAuditDatabaseCheck,EvidenceAuditExtractFromZip,EvidenceAuditFinalize,EvidenceAuditGenerateReports,EvidenceAuditListSecuredFiles,EvidenceAuditPrepare,EvidenceAuditPrepareReport,ExtractSecureTraceabilityDataFilePlugin,ExtractSedaActionHandler,FinalizeLifecycleTraceabilityActionPlugin,FormatIdentificationActionPlugin,GenerateLifecycleTraceabilityActionPlugin,GenericReportGenerationHandler,HelloWorldPlugin,IndexObjectGroupActionPlugin,IndexUnitActionPlugin,IngestCleanupDeleteUnitPlugin,IngestCleanupEligibilityValidationPlugin,IngestCleanupFinalizationPlugin,IngestCleanupPreparationPlugin,IngestCleanupRequestValidationPlugin,IngestPrepareActionHandler,ListArchiveUnitsActionHandler,ListRunningIngestsActionHandler,MassUpdateCheck,MassUpdateRulesCheck,MigrationFinalize,MigrationUnitPrepare,PrepareBulkAtomicUpdate,PrepareLfcTraceabilityActionPlugin,PrepareStorageInfoActionHandler,PrepareStorageStrategiesPlugin,PrepareUpdateUnits,PreservationActionPlugin,PreservationExtractionAUPlugin,PreservationFinalizationPlugin,PreservationGenerateBinaryHash,PreservationInsertionAuMetadata,PreservationObjectGroupMetadataSecurityChecks,PreservationPreparationInsertionAuMetadata,PreservationPreparationPlugin,PreservationSiegfriedPlugin,PreservationStorageBinaryPlugin,PreservationTesseractPlugin,PreservationUnitMetadataSecurityChecks,PreservationUpdateObjectGroupPlugin,ProbativeCreateDistributionFile,ProbativeCreateReport,ProbativeCreateReportEntry,PurgeAccessionRegisterPreparationHandler,PurgeAccessionRegisterUpdatePlugin,PurgeDeleteObjectGroupPlugin,PurgeDetachObjectGroupPlugin,PurgeObjectGroupPreparationHandler,PurgeUnitPlugin,PutBinaryOnWorkspace,ReclassificationFinalizationHandler,ReclassificationPreparationCheckGraphHandler,ReclassificationPreparationCheckHoldRulesHandler,ReclassificationPreparationLoadRequestHandler,ReclassificationPreparationUpdateDistributionHandler,RetrieveSecureTraceabilityDataFilePlugin,RevertUpdateUnitCheckPlugin,RollBackActionHandler,RunningIngestsUpdateActionPlugin,SaveAtrPlugin,StoreExports,StoreMetaDataObjectGroupActionPlugin,StoreMetaDataUnitActionPlugin,StoreObjectActionHandler,TraceabilityFinalizationPlugin,TraceabilityLinkedCheckPreparePlugin,TransferNotificationActionHandler,TransferReplyDeleteSIP,TransferReplyFinalizationPlugin,TransferReplyUnitPreparationHandler,UnitAttachmentPlugin,UnitDetachmentPlugin,UnitMetadataRulesUpdateCheckConsistency,UnitsRulesComputePlugin,UpdateObjectGroupPlugin,UpdateUnitFinalize,UploadSIPActionHandler,VerifyAtrPlugin,VerifyMerkleTreeActionHandler,VerifyTimeStampActionHandler
ActionHandler abstract class of interface Action
Each ActionHandler must implements some public static methods:
Each ActionHandler must implements some public static methods:
// Return the unique Id of this Handler
public static final String getId();
// Later on (not available now), some other methods for Input/Output arguments
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcheckMandatoryIOParameter(HandlerIO handler) Check mandatory parametervoidcheckMandatoryParameters(WorkerParameters parameters) Check mandatory parametersvoidclose()execute(WorkerParameters param, HandlerIO handler) Execute an actionexecuteList(WorkerParameters workerParameters, HandlerIO handler) static voidupdateDetailItemStatus(ItemStatus globalCompositeItemStatus, String value, String globalOutcomeDetailSubCode) Update a detail item status
-
Constructor Details
-
ActionHandler
public ActionHandler()
-
-
Method Details
-
checkMandatoryParameters
Check mandatory parameters- Parameters:
parameters- parameter to check- Throws:
IllegalArgumentException- thrown when a mandatory parameter is null or empty
-
checkMandatoryIOParameter
Check mandatory parameter- Parameters:
handler- input output list- Throws:
ProcessingException- when handler io is not complete
-
close
public void close()- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceVitamAutoCloseable
-
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
public List<ItemStatus> executeList(WorkerParameters workerParameters, HandlerIO handler) throws ProcessingException - Parameters:
workerParameters-handler-- Returns:
- Throws:
ProcessingException
-
updateDetailItemStatus
public static void updateDetailItemStatus(ItemStatus globalCompositeItemStatus, String value, String globalOutcomeDetailSubCode) Update a detail item status- Parameters:
globalCompositeItemStatus-value-globalOutcomeDetailSubCode-
-