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

Interface WorkerParameters

    • Method Detail

      • putParameterValue

        WorkerParameters putParameterValue​(WorkerParameterName parameterName,
                                   java.lang.String parameterValue)
        Put parameterValue on mapParameters with parameterName key

        If parameterKey already exists, then override it (no check)
        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)
        Throws:
        java.lang.IllegalArgumentException - if the parameterName is null or if parameterValue is null or empty

      • getParameterValue

        java.lang.String getParameterValue​(WorkerParameterName parameterName)
        Get the parameter according to the parameterName
        Parameters:
        parameterName - the wanted parameter
        Returns:
        the value or null if not found
        Throws:
        java.lang.IllegalArgumentException - throws if parameterName is null

      • setMap

        WorkerParameters setMap​(java.util.Map<java.lang.String,​java.lang.String> map)
        Set from map using String as Key
        Parameters:
        map - the map parameters to set
        Returns:
        the current instance of WorkerParameters
        Throws:
        java.lang.IllegalArgumentException - if parameter key is unknown or if the map is null

      • getCurrentStep

        java.lang.String getCurrentStep()
        Get the current step parameter
        Returns:
        the current step value

      • setCurrentStep

        WorkerParameters setCurrentStep​(java.lang.String currentStep)
        Set the current step value
        Parameters:
        currentStep - the current step value
        Returns:
        the current instance of WorkerParameters

      • getPreviousStep

        java.lang.String getPreviousStep()
        Get the previous step parameter
        Returns:
        the previous step value

      • setPreviousStep

        WorkerParameters setPreviousStep​(java.lang.String previousStep)
        Set the previous step value
        Parameters:
        previousStep - the current step value
        Returns:
        the current instance of WorkerParameters
        Throws:
        java.lang.IllegalArgumentException - if the previousStep is null or empty

      • getContainerName

        java.lang.String getContainerName()
        Get container name parameter
        Returns:
        the container name value

      • setContainerName

        WorkerParameters setContainerName​(java.lang.String containerName)
        Set the container name value
        Parameters:
        containerName - the container name value
        Returns:
        the current instance of WorkerParameter
        Throws:
        java.lang.IllegalArgumentException - if the containerName is null or empty

      • getObjectId

        java.lang.String getObjectId()
        Get the object id parameter
        Returns:
        the object id value

      • setObjectId

        WorkerParameters setObjectId​(java.lang.String objectId)
        Set the object id value
        Parameters:
        objectId - the object id value
        Returns:
        the current instance of WorkerParameter
        Throws:
        java.lang.IllegalArgumentException - if the objectId is null or empty

      • getObjectName

        java.lang.String getObjectName()
        Get the object name parameter
        Returns:
        the object name value

      • setObjectName

        WorkerParameters setObjectName​(java.lang.String objectName)
        Set the object name value
        Parameters:
        objectName - the object name value
        Returns:
        the current instance of WorkerParameter
        Throws:
        java.lang.IllegalArgumentException - if the objectName is null or empty

      • getObjectMetadata

        com.fasterxml.jackson.databind.JsonNode getObjectMetadata()
        Get the object metadata parameter
        Returns:
        the object metadata value

      • setObjectMetadata

        WorkerParameters setObjectMetadata​(com.fasterxml.jackson.databind.JsonNode objectName)
        Set the object metadata value
        Parameters:
        objectName - the object metadata value
        Returns:
        the current instance of WorkerParameter
        Throws:
        java.lang.IllegalArgumentException - if the objectName is null or empty

      • getObjectNameList

        java.util.List<java.lang.String> getObjectNameList()
        Get the object name parameter
        Returns:
        the object name value

      • setObjectNameList

        WorkerParameters setObjectNameList​(java.util.List<java.lang.String> objectNameList)
        Set the object name value
        Parameters:
        objectNameList - the object name value
        Returns:
        the current instance of WorkerParameter
        Throws:
        java.lang.IllegalArgumentException - if the objectName is null or empty

      • getObjectMetadataList

        java.util.List<com.fasterxml.jackson.databind.JsonNode> getObjectMetadataList()
        Get the object metadata parameter
        Returns:
        the object name value

      • setObjectMetadataList

        WorkerParameters setObjectMetadataList​(java.util.List<com.fasterxml.jackson.databind.JsonNode> objectMetadataList)
        Set the object metadata value
        Parameters:
        objectMetadataList - the object metadataList value
        Returns:
        the current instance of WorkerParameter
        Throws:
        java.lang.IllegalStateException - if the metadataList is null or empty

      • getMetadataRequest

        java.lang.String getMetadataRequest()
        Get the metadata request parameter
        Returns:
        the metadata request value

      • setMetadataRequest

        WorkerParameters setMetadataRequest​(java.lang.String metadataRequest)
        Set the request metadata request value
        Parameters:
        metadataRequest - the metadata request value
        Returns:
        the current instance of WorkerParameter
        Throws:
        java.lang.IllegalArgumentException - if metadataRequest is null or empty

      • getWorkerGUID

        java.lang.String getWorkerGUID()
        Get the worker GUID parameter
        Returns:
        the worker GUID value

      • setWorkerGUID

        WorkerParameters setWorkerGUID​(java.lang.String workerGUID)
        Set the worker GUID value
        Parameters:
        workerGUID - the worker GUID value
        Returns:
        the current instance of WorkerParameters
        Throws:
        java.lang.IllegalArgumentException - if workerGUID is null or empty

      • getProcessId

        java.lang.String getProcessId()
        Get the process id parameter
        Returns:
        the process id value

      • setProcessId

        WorkerParameters setProcessId​(java.lang.String processId)
        Set the process id value
        Parameters:
        processId - the process id value
        Returns:
        the current instance of WorkerParameters
        Throws:
        java.lang.IllegalArgumentException - if processId is null or empty

      • getUrlMetadata

        java.lang.String getUrlMetadata()
        Get the url of metadata resource parameter
        Returns:
        the url of metadata resource value

      • setUrlMetadata

        WorkerParameters setUrlMetadata​(java.lang.String urlMetadata)
        Set the url of metadata resource value
        Parameters:
        urlMetadata - the url of metadata resource value
        Returns:
        the current instance of WorkerParameters
        Throws:
        java.lang.IllegalArgumentException - if urlMetadata is null or empty

      • getUrlWorkspace

        java.lang.String getUrlWorkspace()
        Get the url of workspace resource parameter
        Returns:
        the url of workspace resource value

      • setUrlWorkspace

        WorkerParameters setUrlWorkspace​(java.lang.String urlWorkspace)
        Set the url of workspace resource value
        Parameters:
        urlWorkspace - the url of workspace resource value
        Returns:
        the current instance of WorkerParameters
        Throws:
        java.lang.IllegalArgumentException - if urlWorspace is null or empty

      • getLogbookTypeProcess

        LogbookTypeProcess getLogbookTypeProcess()
        Get the logbook Type Process
        Returns:
        the logbook Type Process

      • setLogbookTypeProcess

        WorkerParameters setLogbookTypeProcess​(LogbookTypeProcess logbookTypeProcess)
        Set the logbook Type Process
        Parameters:
        logbookTypeProcess - the logbook Type Process
        Returns:
        the current instance of WorkerParameters
        Throws:
        java.lang.IllegalArgumentException - if urlWorspace is null or empty

      • getWorkflowIdentifier

        java.lang.String getWorkflowIdentifier()
        Returns:
        workflowIdentifier

      • setWorkflowIdentifier

        WorkerParameters setWorkflowIdentifier​(java.lang.String workflowIdentifier)
        Set the logbook Type Process
        Parameters:
        workflowIdentifier -
        Returns:
        the current instance of WorkerParameters
        Throws:
        java.lang.IllegalArgumentException - if urlWorspace is null or empty

      • setFromParameters

        WorkerParameters setFromParameters​(WorkerParameters parameters)
        Set parameters from another WorkerParameters
        Parameters:
        parameters - the parameters to set
        Returns:
        the current instance of WorkerParameters
        Throws:
        java.lang.IllegalArgumentException - if parameters is null

      • getRequestId

        java.lang.String getRequestId()
        Returns:
        the current X-Request-Id

      • setRequestId

        WorkerParameters setRequestId​(java.lang.String newRequestId)
        setRequestId.
        Parameters:
        newRequestId -
        Returns:

      • getWorkflowStatusKo

        java.lang.String getWorkflowStatusKo()
        Returns:
        workflowStatusKo