WorkflowJobRepository.java

/*
 * Copyright (c) NASK, NCSC
 * 
 * This file is part of HoneySpider Network 2.1.
 * 
 * This is a free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package pl.nask.hsn2.framework.workflow.job;

import java.util.List;

/**
 * This is interface of repository for jobs running in any workflow engine.
 * 
 * NOTO: Any implementation of this interface MUST be thread-safe.
 * 
 *
 */
public interface WorkflowJobRepository {

	/**
	 * Takes a job identified by <code>id</code> from the repository.
	 * 
	 * @param id
	 *            Identifier of looking job.
	 * @return The job or <code>null</code> if job doesn't exist.
	 * @throws WorkflowJobRepositoryException
	 *             Any problem with reading repository will rise the exception.
	 */
	WorkflowJob get(long id) throws WorkflowJobRepositoryException;
	
	/**
	 * Adds single job to the repository.
	 * 
	 * @param job
	 *            Job to be added.
	 * @return Identifier of the job in the repository.
	 * 
	 * @throws WorkflowJobRepositoryException
	 *             Any problem with adding the job to the repository will rise
	 *             the exception.
	 */
	long add(WorkflowJob job) throws WorkflowJobRepositoryException;
	
	/**
	 * Returns all jobs stored in the repository.
	 * 
	 * @return List of jobs or empty list if there are no jobs.
	 * 
	 * @throws WorkflowJobRepositoryException
	 *             Any problem with receiving list of jobs will rise this
	 *             exception.
	 */
	List<WorkflowJobInfo> getJobs() throws WorkflowJobRepositoryException;

	/**
	 * Removes the job identified by <code>id</code>.
	 * Only ended jobs can be removed.
	 * If the job not exist nothing happen.
	 * 
	 * @param id Identifier of the job to be removed from repository.
	 * 
	 * @throws WorkflowJobRepositoryException
	 * 			Any problem with removing the job from the repository will rise
	 * 			the exception. E.g. The job is not ended yet.
	 */
	void remove(long id) throws WorkflowJobRepositoryException;

	/**
	 * Removes from the repository all the jobs which are ended
	 * and time of finish is older then <code>timestamp</code>.
	 * 
	 * @param timestamp
	 * 			Point in time, jobs ended before this point will be purged.
	 * 
	 * @throws WorkflowJobRepositoryException
	 *             Any problem with receiving list of jobs will rise this
	 *             exception.
	 */
	void purgeEndedBefore(long timestamp) throws WorkflowJobRepositoryException;
}