ExportJob.java

package eu.simstadt.nf4j;

import java.io.File;
import java.util.Objects;

/**
 * Export jobs are requests for CityGML models. Every valid export job has an id and a status.
 * 
 * @author Marcel Bruse
 */
public class ExportJob extends Job<ExportJobDescriptorImpl> {
	
	/**
	 * This constructor forces the job to have a description and a connector instance. Every job which
	 * is created by this constructor will have the status "local", because it is assumed that it has an unsent
	 * description and no job id yet.
	 * 
	 * @param connector The job will use this connector to synchronize itself with the nF.
	 * @param descriptor The description of this job.
	 */
	public ExportJob(ExportJobDescriptorImpl descriptor, NFConnector connector) {
		super(descriptor, connector);
		status = JobStatus.LOCAL;
	}

	/**
	 * This constructor forces the job to have a id and a connector instance. Every job which is created by this
	 * constructor will have the status "sent", because it is assumed that the job is already enqueued at the 
	 * nF job queue.  
	 * 
	 * @param id The job id. If you call updateStatus() and the nF "knows" the job id, then the job status
	 * will be updated. If you call updateStatus() and the job id is "unkown" on the server side, then     
	 * @param connector The job will use this connector to synchronize itself with the nF.
	 */
	public ExportJob(int id, NFConnector connector) {
		super(id, connector);
		status = JobStatus.SENT;
	}
	
	/**
	 * Connects to the nF and refreshes the status of this job. If there is no nF connector set,
	 * this operation will throw a FailedTransmissionException.
	 * 
	 * @throws FailedTransmissionException If the connection to the nF is broken you will get some of this. 
	 */
	public void updateStatus() throws FailedTransmissionException {
		if (Objects.nonNull(getNFConnector())) {
			Job<ExportJobDescriptorImpl> job = getNFConnector().requestExportJob(getId());
			setStatus(job.getStatus());
		} else {
			throw new FailedTransmissionException();
		}
	}

	/**
	 * Sets the status of this job depending on the given nF status code. nF status codes will be sent
	 * to you in http responses.
	 *  
	 * @param statusCode The nF status code for this job.
	 */
	@Override
	public void setStatusForCode(int statusCode) {
		switch (statusCode) {
		case 0:
			setStatus(JobStatus.PENDING); break;
		case 10:
			setStatus(JobStatus.RUNNING); break;
		case 20:
			setStatus(JobStatus.FAILED); break;
		case 30:
			setStatus(JobStatus.FINISHED); break;
		default:
			setStatus(JobStatus.UNKOWN);
		}
	}
	
	/**
	 * @return Returns true, if the job is definitely done. False, otherwise.
	 */
	public boolean isFinished() {
		return Objects.nonNull(getStatus()) && getStatus().equals(JobStatus.FINISHED);
	}

	@Override
	public void send() throws InvalidJobDescriptorException, FailedTransmissionException {
		connector.sendAndUpdateExportJob(this);
	}
	
	public File requestExportJobResult() throws FailedTransmissionException {
		if (!isFinished()) {
			throw new FailedTransmissionException("Job is not finished yet!");
		}
		return connector.requestExportJobResult(id);
	}
	
}