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

Class DefaultWorkerParameters

    • Field Detail

      • mapParameters

        protected final java.util.Map<WorkerParameterName,​java.lang.String> mapParameters

    • Constructor Detail

      • DefaultWorkerParameters

        protected DefaultWorkerParameters​(java.util.Map<java.lang.String,​java.lang.String> map)
        Builder for REST
        Parameters:
        map - the wanted parameters
        Throws:
        java.lang.IllegalArgumentException - if one key is not allowed

    • Method Detail

      • newInstance

        public DefaultWorkerParameters newInstance()
        Shallow copy of DefaultWorkerParameter
        Returns:
        the shallow copy

      • putParameterValue

        public WorkerParameters putParameterValue​(WorkerParameterName parameterName,
                                          java.lang.String parameterValue)
        Description copied from interface: WorkerParameters
        Put parameterValue on mapParameters with parameterName key

        If parameterKey already exists, then override it (no check)
        Specified by:
        putParameterValue in interface WorkerParameters
        Parameters:
        parameterName - the key of the parameter to put on the parameter map
        parameterValue - the value to put on the parameter map
        Returns:
        actual instance of WorkerParameter (fluent like)

      • getParameterValue

        public java.lang.String getParameterValue​(WorkerParameterName parameterName)
        Description copied from interface: WorkerParameters
        Get the parameter according to the parameterName
        Specified by:
        getParameterValue in interface WorkerParameters
        Parameters:
        parameterName - the wanted parameter
        Returns:
        the value or null if not found

      • setMap

        public WorkerParameters setMap​(java.util.Map<java.lang.String,​java.lang.String> map)
        Description copied from interface: WorkerParameters
        Set from map using String as Key
        Specified by:
        setMap in interface WorkerParameters
        Parameters:
        map - the map parameters to set
        Returns:
        the current instance of WorkerParameters

      • getCurrentStep

        public java.lang.String getCurrentStep()
        Description copied from interface: WorkerParameters
        Get the current step parameter
        Specified by:
        getCurrentStep in interface WorkerParameters
        Returns:
        the current step value

      • setCurrentStep

        public WorkerParameters setCurrentStep​(java.lang.String currentStep)
        Description copied from interface: WorkerParameters
        Set the current step value
        Specified by:
        setCurrentStep in interface WorkerParameters
        Parameters:
        currentStep - the current step value
        Returns:
        the current instance of WorkerParameters

      • getPreviousStep

        public java.lang.String getPreviousStep()
        Description copied from interface: WorkerParameters
        Get the previous step parameter
        Specified by:
        getPreviousStep in interface WorkerParameters
        Returns:
        the previous step value

      • setPreviousStep

        public WorkerParameters setPreviousStep​(java.lang.String previousStep)
        Description copied from interface: WorkerParameters
        Set the previous step value
        Specified by:
        setPreviousStep in interface WorkerParameters
        Parameters:
        previousStep - the current step value
        Returns:
        the current instance of WorkerParameters

      • getContainerName

        public java.lang.String getContainerName()
        Description copied from interface: WorkerParameters
        Get container name parameter
        Specified by:
        getContainerName in interface WorkerParameters
        Returns:
        the container name value

      • setContainerName

        public WorkerParameters setContainerName​(java.lang.String containerName)
        Description copied from interface: WorkerParameters
        Set the container name value
        Specified by:
        setContainerName in interface WorkerParameters
        Parameters:
        containerName - the container name value
        Returns:
        the current instance of WorkerParameter

      • getObjectId

        public java.lang.String getObjectId()
        Description copied from interface: WorkerParameters
        Get the object id parameter
        Specified by:
        getObjectId in interface WorkerParameters
        Returns:
        the object id value

      • setObjectId

        public WorkerParameters setObjectId​(java.lang.String objectId)
        Description copied from interface: WorkerParameters
        Set the object id value
        Specified by:
        setObjectId in interface WorkerParameters
        Parameters:
        objectId - the object id value
        Returns:
        the current instance of WorkerParameter

      • getObjectName

        public java.lang.String getObjectName()
        Description copied from interface: WorkerParameters
        Get the object name parameter
        Specified by:
        getObjectName in interface WorkerParameters
        Returns:
        the object name value

      • setObjectName

        public WorkerParameters setObjectName​(java.lang.String objectName)
        Description copied from interface: WorkerParameters
        Set the object name value
        Specified by:
        setObjectName in interface WorkerParameters
        Parameters:
        objectName - the object name value
        Returns:
        the current instance of WorkerParameter

      • getObjectMetadata

        public com.fasterxml.jackson.databind.JsonNode getObjectMetadata()
        Description copied from interface: WorkerParameters
        Get the object metadata parameter
        Specified by:
        getObjectMetadata in interface WorkerParameters
        Returns:
        the object metadata value

      • setObjectMetadata

        public WorkerParameters setObjectMetadata​(com.fasterxml.jackson.databind.JsonNode objectMetadata)
        Description copied from interface: WorkerParameters
        Set the object metadata value
        Specified by:
        setObjectMetadata in interface WorkerParameters
        Parameters:
        objectMetadata - the object metadata value
        Returns:
        the current instance of WorkerParameter

      • getObjectNameList

        public java.util.List<java.lang.String> getObjectNameList()
        Description copied from interface: WorkerParameters
        Get the object name parameter
        Specified by:
        getObjectNameList in interface WorkerParameters
        Returns:
        the object name value

      • setObjectNameList

        public WorkerParameters setObjectNameList​(java.util.List<java.lang.String> objectNameList)
        Description copied from interface: WorkerParameters
        Set the object name value
        Specified by:
        setObjectNameList in interface WorkerParameters
        Parameters:
        objectNameList - the object name value
        Returns:
        the current instance of WorkerParameter

      • getObjectMetadataList

        public java.util.List<com.fasterxml.jackson.databind.JsonNode> getObjectMetadataList()
        Description copied from interface: WorkerParameters
        Get the object metadata parameter
        Specified by:
        getObjectMetadataList in interface WorkerParameters
        Returns:
        the object name value

      • setObjectMetadataList

        public WorkerParameters setObjectMetadataList​(java.util.List<com.fasterxml.jackson.databind.JsonNode> objectMetaDataList)
        Description copied from interface: WorkerParameters
        Set the object metadata value
        Specified by:
        setObjectMetadataList in interface WorkerParameters
        Parameters:
        objectMetaDataList - the object metadataList value
        Returns:
        the current instance of WorkerParameter

      • getMetadataRequest

        public java.lang.String getMetadataRequest()
        Description copied from interface: WorkerParameters
        Get the metadata request parameter
        Specified by:
        getMetadataRequest in interface WorkerParameters
        Returns:
        the metadata request value

      • setMetadataRequest

        public WorkerParameters setMetadataRequest​(java.lang.String metadataRequest)
        Description copied from interface: WorkerParameters
        Set the request metadata request value
        Specified by:
        setMetadataRequest in interface WorkerParameters
        Parameters:
        metadataRequest - the metadata request value
        Returns:
        the current instance of WorkerParameter

      • getWorkerGUID

        public java.lang.String getWorkerGUID()
        Description copied from interface: WorkerParameters
        Get the worker GUID parameter
        Specified by:
        getWorkerGUID in interface WorkerParameters
        Returns:
        the worker GUID value

      • setWorkerGUID

        public WorkerParameters setWorkerGUID​(java.lang.String workerGUID)
        Description copied from interface: WorkerParameters
        Set the worker GUID value
        Specified by:
        setWorkerGUID in interface WorkerParameters
        Parameters:
        workerGUID - the worker GUID value
        Returns:
        the current instance of WorkerParameters

      • getProcessId

        public java.lang.String getProcessId()
        Description copied from interface: WorkerParameters
        Get the process id parameter
        Specified by:
        getProcessId in interface WorkerParameters
        Returns:
        the process id value

      • setProcessId

        public WorkerParameters setProcessId​(java.lang.String processId)
        Description copied from interface: WorkerParameters
        Set the process id value
        Specified by:
        setProcessId in interface WorkerParameters
        Parameters:
        processId - the process id value
        Returns:
        the current instance of WorkerParameters

      • getUrlMetadata

        public java.lang.String getUrlMetadata()
        Description copied from interface: WorkerParameters
        Get the url of metadata resource parameter
        Specified by:
        getUrlMetadata in interface WorkerParameters
        Returns:
        the url of metadata resource value

      • setUrlMetadata

        public WorkerParameters setUrlMetadata​(java.lang.String urlMetadata)
        Description copied from interface: WorkerParameters
        Set the url of metadata resource value
        Specified by:
        setUrlMetadata in interface WorkerParameters
        Parameters:
        urlMetadata - the url of metadata resource value
        Returns:
        the current instance of WorkerParameters

      • getUrlWorkspace

        public java.lang.String getUrlWorkspace()
        Description copied from interface: WorkerParameters
        Get the url of workspace resource parameter
        Specified by:
        getUrlWorkspace in interface WorkerParameters
        Returns:
        the url of workspace resource value

      • setUrlWorkspace

        public WorkerParameters setUrlWorkspace​(java.lang.String urlWorkspace)
        Description copied from interface: WorkerParameters
        Set the url of workspace resource value
        Specified by:
        setUrlWorkspace in interface WorkerParameters
        Parameters:
        urlWorkspace - the url of workspace resource value
        Returns:
        the current instance of WorkerParameters

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getRequestId

        public java.lang.String getRequestId()
        Specified by:
        getRequestId in interface WorkerParameters
        Returns:
        the current X-Request-Id