ca.nrc.cadc.uws.server.JobUpdater Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cadc-uws-server Show documentation
Show all versions of cadc-uws-server Show documentation
OpenCADC UWS server library
The newest version!
/*
************************************************************************
******************* CANADIAN ASTRONOMY DATA CENTRE *******************
************** CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES **************
*
* (c) 2022. (c) 2022.
* Government of Canada Gouvernement du Canada
* National Research Council Conseil national de recherches
* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
* All rights reserved Tous droits réservés
*
* NRC disclaims any warranties, Le CNRC dénie toute garantie
* expressed, implied, or énoncée, implicite ou légale,
* statutory, of any kind with de quelque nature que ce
* respect to the software, soit, concernant le logiciel,
* including without limitation y compris sans restriction
* any warranty of merchantability toute garantie de valeur
* or fitness for a particular marchande ou de pertinence
* purpose. NRC shall not be pour un usage particulier.
* liable in any event for any Le CNRC ne pourra en aucun cas
* damages, whether direct or être tenu responsable de tout
* indirect, special or general, dommage, direct ou indirect,
* consequential or incidental, particulier ou général,
* arising from the use of the accessoire ou fortuit, résultant
* software. Neither the name de l'utilisation du logiciel. Ni
* of the National Research le nom du Conseil National de
* Council of Canada nor the Recherches du Canada ni les noms
* names of its contributors may de ses participants ne peuvent
* be used to endorse or promote être utilisés pour approuver ou
* products derived from this promouvoir les produits dérivés
* software without specific prior de ce logiciel sans autorisation
* written permission. préalable et particulière
* par écrit.
*
* This file is part of the Ce fichier fait partie du projet
* OpenCADC project. OpenCADC.
*
* OpenCADC is free software: OpenCADC est un logiciel libre ;
* you can redistribute it and/or vous pouvez le redistribuer ou le
* modify it under the terms of modifier suivant les termes de
* the GNU Affero General Public la “GNU Affero General Public
* License as published by the License” telle que publiée
* Free Software Foundation, par la Free Software Foundation
* either version 3 of the : soit la version 3 de cette
* License, or (at your option) licence, soit (à votre gré)
* any later version. toute version ultérieure.
*
* OpenCADC is distributed in the OpenCADC est distribué
* hope that it will be useful, dans l’espoir qu’il vous
* but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE
* without even the implied GARANTIE : sans même la garantie
* warranty of MERCHANTABILITY implicite de COMMERCIALISABILITÉ
* or FITNESS FOR A PARTICULAR ni d’ADÉQUATION À UN OBJECTIF
* PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence
* General Public License for Générale Publique GNU Affero
* more details. pour plus de détails.
*
* You should have received Vous devriez avoir reçu une
* a copy of the GNU Affero copie de la Licence Générale
* General Public License along Publique GNU Affero avec
* with OpenCADC. If not, see OpenCADC ; si ce n’est
* . pas le cas, consultez :
* .
*
* $Revision: 4 $
*
************************************************************************
*/
package ca.nrc.cadc.uws.server;
import ca.nrc.cadc.net.TransientException;
import ca.nrc.cadc.uws.ErrorSummary;
import ca.nrc.cadc.uws.ExecutionPhase;
import ca.nrc.cadc.uws.Parameter;
import ca.nrc.cadc.uws.Result;
import java.util.Date;
import java.util.List;
/**
* Interface to define the subset of the JobPersistence API that is intended for use by
* JobRunner implementations.
*
* @author pdowler
*/
public interface JobUpdater {
/**
* Get the current execution phase of the specified job.
*
* @param jobID
* @return the current phase
* @throws JobNotFoundException
* @throws JobPersistenceException
* @throws TransientException
*/
public ExecutionPhase getPhase(String jobID)
throws JobNotFoundException, JobPersistenceException, TransientException;
/**
* Try to change the phase from start to end. The transition is
* successful IFF the current phase is equal to the starting phase and the phase
* update succeeds.
*
* @param jobID
* @param start
* @param end
* @return the resulting phase or null if the the transition was not successful.
* @throws JobNotFoundException
* @throws JobPersistenceException
* @throws TransientException
*/
public ExecutionPhase setPhase(String jobID, ExecutionPhase start, ExecutionPhase end)
throws JobNotFoundException, JobPersistenceException, TransientException;
/**
* Try to change the phase from start to end and, if successful,
* set the startTime (end=EXECUTING) or endTime (end=COMPLETED | ERROR | ABORTED).
* The transition is successful IFF the current phase is equal to the starting
* phase and the phase update succeeds. The date argument is ignored if the end
* phase is not one of those listed above.
*
* @param jobID
* @param start
* @param end
* @param date
* @return the resulting phase or null if the the transition was not successful.
* @throws JobNotFoundException
* @throws JobPersistenceException
* @throws TransientException
*/
public ExecutionPhase setPhase(String jobID, ExecutionPhase start, ExecutionPhase end, Date date)
throws JobNotFoundException, JobPersistenceException, TransientException;
/**
* Conditionally change phase from start to end and, if successful, add the specified results to the
* job and set the startTime (end=EXECUTING) or endTime (end=COMPLETED | ERROR | ABORTED).
*
* @param jobID
* @param start
* @param end
* @param results
* @param date
* @return the final phase (end) or null if not successful
* @throws JobNotFoundException
* @throws JobPersistenceException
* @throws TransientException
*/
public ExecutionPhase setPhase(String jobID, ExecutionPhase start, ExecutionPhase end, List results, Date date)
throws JobNotFoundException, JobPersistenceException, TransientException;
/**
* Conditionally change phase from start to end and, if successful, set the
* error summary and set the startTime (end=EXECUTING) or endTime (end=COMPLETED | ERROR | ABORTED).
*
* @param jobID
* @param start
* @param end
* @param error
* @param date
* @return the final phase (end) or null if not successful
* @throws JobNotFoundException
* @throws JobPersistenceException
* @throws TransientException
*/
public ExecutionPhase setPhase(String jobID, ExecutionPhase start, ExecutionPhase end, ErrorSummary error, Date date)
throws JobNotFoundException, JobPersistenceException, TransientException;
/**
* Add parameters to the specified job.
*
* @param jobID
* @param params
* @throws JobNotFoundException
* @throws JobPersistenceException
* @throws TransientException
*/
public void addParameters(String jobID, List params)
throws JobNotFoundException, JobPersistenceException, TransientException;
}