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

Class ActionHandler

java.lang.Object
fr.gouv.vitam.worker.core.handler.ActionHandler
All Implemented Interfaces:
VitamAutoCloseable, WorkerAction, 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, EliminationActionUnitPreparationHandler, 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
public abstract class ActionHandler extends Object implements WorkerAction, VitamAutoCloseable
ActionHandler abstract class of interface Action

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 Details

    • ActionHandler

      public ActionHandler()

  • Method Details

    • checkMandatoryParameters

      public void checkMandatoryParameters(WorkerParameters parameters)
      Check mandatory parameters
      Parameters:
      parameters - parameter to check
      Throws:
      IllegalArgumentException - thrown when a mandatory parameter is null or empty

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface VitamAutoCloseable

    • updateDetailItemStatus

      public void updateDetailItemStatus(ItemStatus globalCompositeItemStatus, String value, String globalOutcomeDetailSubCode)
      Update a detail item status
      Parameters:
      globalCompositeItemStatus -
      value -
      globalOutcomeDetailSubCode -