Package fr.gouv.vitam.processing.common.parameter

Enum WorkerParameterName

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<WorkerParameterName>
    public enum WorkerParameterName
extends java.lang.Enum<WorkerParameterName>
    Enum with all possible worker parameters

    Use to set parameter value and to check emptiness nullity

    • Enum Constant Detail

      • urlWorkspace

        public static final WorkerParameterName urlWorkspace
        Url of workspace resources

      • processId

        public static final WorkerParameterName processId
        Unique id (GUID) of the workflow to be executed

      • stepUniqId

        public static final WorkerParameterName stepUniqId
        Unique id of a step. The pattern of the id is : {CONTAINER_NAME}_{WORKFLOW_ID}_{STEP_RANK_IN_THE_WORKFLOW}_{STEP_NAME}

      • containerName

        public static final WorkerParameterName containerName
        Name of the container to be uploaded

      • objectName

        public static final WorkerParameterName objectName
        Name/path of the object to be processed

      • objectMetadata

        public static final WorkerParameterName objectMetadata
        Name/metadata of the object to be processed

      • objectNameList

        public static final WorkerParameterName objectNameList
        List Name/path of the object to be processed

      • objectMetadataList

        public static final WorkerParameterName objectMetadataList
        List Name/metadata of the object to be processed

      • objectId

        public static final WorkerParameterName objectId
        Id of the object to be processed (not used, except in test classes)

      • auditType

        public static final WorkerParameterName auditType
        Type of the audit to be processed

      • workerGUID

        public static final WorkerParameterName workerGUID
        Id of the worker (GUID) (not used for now, except in test classes)

      • metadataRequest

        public static final WorkerParameterName metadataRequest
        Request to be executed by the metadata module (not used for now, except in test classes)

      • currentStep

        public static final WorkerParameterName currentStep
        Current name of the step to be processed

      • previousStep

        public static final WorkerParameterName previousStep
        Previous name of the step processed

      • workflowStatusKo

        public static final WorkerParameterName workflowStatusKo
        If Current Workflow status is greater or equal ko, contains the status

      • logBookTypeProcess

        public static final WorkerParameterName logBookTypeProcess
        The LogbookTypeProcess value used in logbookOperation

      • logbookRequest

        public static final WorkerParameterName logbookRequest
        Request to be executed by the logbook module

      • auditActions

        public static final WorkerParameterName auditActions
        the array of the different audit actions there are three types of action: "check existence" , "check integrity", "correction"

      • lifecycleTraceabilityTemporizationDelayInSeconds

        public static final WorkerParameterName lifecycleTraceabilityTemporizationDelayInSeconds
        Temporization delay (in seconds) for recent logbook lifecycle events

      • lifecycleTraceabilityMaxEntries

        public static final WorkerParameterName lifecycleTraceabilityMaxEntries
        Max event count to select during a single logbook lifecycle traceability workflow.

      • mustLogAccessOnObject

        public static final WorkerParameterName mustLogAccessOnObject
        Boolean that indicate for Export DIP workflow if the access to an object must be (or not) logged

      • workflowIdentifier

        public static final WorkerParameterName workflowIdentifier
        Workflow identifier (used also as eventType)

      • ingestOperationIdToCleanup

        public static final WorkerParameterName ingestOperationIdToCleanup
        Ingest operation id to clean up

    • Method Detail

      • values

        public static WorkerParameterName[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (WorkerParameterName c : WorkerParameterName.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static WorkerParameterName valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getEnums

        public static java.util.HashSet<java.lang.String> getEnums()