org.mapfish.print.servlet.job

Interface JobManager

All Known Implementing Classes:

ThreadPoolJobManager

public interface JobManager

Manages and Executes Print Jobs.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(java.lang.String referenceId) Cancel a job.
long	getAverageTimeSpentPrinting() Get the average time print jobs take to complete.
com.google.common.base.Optional<? extends PrintJobStatus>	getCompletedPrintJob(java.lang.String referenceId) Return the completed job object if the job has completed or absent otherwise.
int	getLastPrintCount() Get the number of prints that finished (either by error or success).
int	getNumberOfRequestsMade() Get the total number of print requests made.
JobStatus	getStatus(java.lang.String referenceId) Get the status for a job.
boolean	isDone(java.lang.String referenceId) Check if the job is done.
void	submit(PrintJob job) Submit a new job for execution.
long	timeSinceLastStatusCheck(java.lang.String referenceId) Get the time since a client has last requested the print job.

Method Detail

submit

void submit(PrintJob job)

Submit a new job for execution.

Parameters:

job - the job to run.

getLastPrintCount

int getLastPrintCount()

Get the number of prints that finished (either by error or success).

getAverageTimeSpentPrinting

long getAverageTimeSpentPrinting()

Get the average time print jobs take to complete.

getNumberOfRequestsMade

int getNumberOfRequestsMade()

Get the total number of print requests made.

timeSinceLastStatusCheck

long timeSinceLastStatusCheck(java.lang.String referenceId)

Get the time since a client has last requested the print job.

Parameters:

referenceId - the id of the printjob

isDone

boolean isDone(java.lang.String referenceId)
               throws NoSuchReferenceException

Check if the job is done.

Parameters:

referenceId - the job to check.

Throws:

NoSuchReferenceException

getCompletedPrintJob

com.google.common.base.Optional<? extends PrintJobStatus> getCompletedPrintJob(java.lang.String referenceId)
                                                                               throws NoSuchReferenceException

Return the completed job object if the job has completed or absent otherwise.

Parameters:

referenceId - the referenceId of the report to lookup

Throws:

NoSuchReferenceException

cancel

void cancel(java.lang.String referenceId)
            throws NoSuchReferenceException

Cancel a job.

Parameters:

referenceId - The referenceId of the job to cancel.

Throws:

NoSuchReferenceException

getStatus

JobStatus getStatus(java.lang.String referenceId)
                    throws NoSuchReferenceException

Get the status for a job.

Parameters:

referenceId - The referenceId of the job to check.

Throws:

NoSuchReferenceException