fr.gouv.vitam.processing.common.parameter

Enum WorkerParameterName

java.lang.Object

java.lang.Enum<WorkerParameterName>

fr.gouv.vitam.processing.common.parameter.WorkerParameterName

All Implemented Interfaces:

Serializable, Comparable<WorkerParameterName>

public enum WorkerParameterName
extends Enum<WorkerParameterName>

Enum with all possible worker parameters

Use to set parameter value and to check emptiness nullity

Enum Constant Summary

Enum Constants

Enum Constant and Description
auditActions the array of the different audit actions there are three types of action: "check existence" , "check integrity", "correction"
auditType Type of the audit to be processed
containerName Name of the container to be uploaded
context process logbook context
currentStep Current name of the step to be processed
endDate End operation date
hashRoot hash of root
lifecycleTraceabilityOverlapDelayInSeconds The overlap delay (in seconds) for logbook lifecycle traceability events.
logbookRequest Request to be executed by the logbook module
logBookTypeProcess The LogbookTypeProcess value used in logbookOperation
metadataRequest Request to be executed by the metadata module (not used for now, except in test classes)
objectId Id of the object to be processed (not used, except in test classes)
objectName Name/path of the object to be processed
objectNameList List Name/path of the object to be processed
previousStep Previous name of the step processed
processId Unique id (GUID) of the workflow to be executed
startDate Start operation date
stepUniqId Unique id of a step.
urlMetadata Url of metadata resources
urlWorkspace Url of workspace resources
workerGUID Id of the worker (GUID) (not used for now, except in test classes)
workflowStatusKo If Current Workflow status is greater or equal ko, contains the status

Method Summary

Modifier and Type	Method and Description
static HashSet<String>	getEnums()
static WorkerParameterName	valueOf(String name) Returns the enum constant of this type with the specified name.
static WorkerParameterName[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

urlMetadata

public static final WorkerParameterName urlMetadata

Url of metadata resources

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

objectNameList

public static final WorkerParameterName objectNameList

List Name/path 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

startDate

public static final WorkerParameterName startDate

Start operation date

endDate

public static final WorkerParameterName endDate

End operation date

hashRoot

public static final WorkerParameterName hashRoot

hash of root

context

public static final WorkerParameterName context

process logbook context

auditActions

public static final WorkerParameterName auditActions

the array of the different audit actions there are three types of action: "check existence" , "check integrity", "correction"

lifecycleTraceabilityOverlapDelayInSeconds

public static final WorkerParameterName lifecycleTraceabilityOverlapDelayInSeconds

The overlap delay (in seconds) for logbook lifecycle traceability events. Used to catch up possibly missed events due to clock difference.

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(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getEnums

public static HashSet<String> getEnums()