ProcessMonitoring.java

/*******************************************************************************
 * Copyright French Prime minister Office/SGMAP/DINSIC/Vitam Program (2015-2019)
 *
 * contact.vitam@culture.gouv.fr
 *
 * This software is a computer program whose purpose is to implement a digital archiving back-office system managing
 * high volumetry securely and efficiently.
 *
 * This software is governed by the CeCILL 2.1 license under French law and abiding by the rules of distribution of free
 * software. You can use, modify and/ or redistribute the software under the terms of the CeCILL 2.1 license as
 * circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license,
 * users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the
 * successive licensors have only limited liability.
 *
 * In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or
 * developing or reproducing the software by the user in light of its specific status of free software, that may mean
 * that it is complicated to manipulate, and that also therefore means that it is reserved for developers and
 * experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the
 * software's suitability as regards their requirements in conditions enabling the security of their systems and/or data
 * to be ensured and, more generally, to use and operate it in the same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had knowledge of the CeCILL 2.1 license and that you
 * accept its terms.
 *******************************************************************************/
package fr.gouv.vitam.processing.engine.core.monitoring;

import java.util.List;
import java.util.Map;

import fr.gouv.vitam.common.exception.WorkflowNotFoundException;
import fr.gouv.vitam.common.model.ProcessExecutionStatus;
import fr.gouv.vitam.common.model.StatusCode;
import fr.gouv.vitam.processing.common.exception.ProcessingException;
import fr.gouv.vitam.processing.common.exception.StepsNotFoundException;
import fr.gouv.vitam.processing.common.model.ProcessStep;
import fr.gouv.vitam.processing.common.model.ProcessWorkflow;

/**
 * Process Monitoring Interface offers services in order to monitor workflows
 */
public interface ProcessMonitoring {


    /**
     * Gets Process Workflow by operation Id
     * 
     * @param id :null not allowed
     * @param tenantId Tenant identifier
     * @return ProcessWorkflow object
     * @throws WorkflowNotFoundException thrown when process workflow not found
     */
    ProcessWorkflow getProcessWorkflow(String id, Integer tenantId) throws WorkflowNotFoundException;

    /**
     * Gets current Process Workflow execution status by operation Id
     * 
     * @param id :null not allowed : the operation identifier process to return
     * @param tenantId Tenant identifier
     * @return {@link ProcessExecutionStatus} :
     * @throws WorkflowNotFoundException hrown when process workflow not found
     */
    ProcessExecutionStatus getProcessExecutionStatus(String id, Integer tenantId) throws WorkflowNotFoundException;

    /**
     * Get process steps by processId
     * 
     * @param processId is operation id
     * @param tenantId Tenant identifier
     * @return map of process step
     * @throws StepsNotFoundException will be thrown when steps not found
     * @throws WorkflowNotFoundException
     */

    public Map<String, ProcessStep> getProcessSteps(String processId, Integer tenantId)
        throws StepsNotFoundException, WorkflowNotFoundException;


    /**
     * Return true if at least one of the step status is KO or FATAL.
     * @param processId The workflow identifier
     * @param tenantId Tenant identifier
     * @return true if at least one of the step status is KO or FATAL, else false
     * @throws ProcessingException if the process does not exist
     */
    StatusCode getProcessWorkflowStatus(String processId, Integer tenantId) throws ProcessingException;
    
    /**
     * Get all proccess
     * @param tenantId
     * @return
     */
    public List<ProcessWorkflow> getAllProcessWorkflow(Integer tenantId);



}