org.mapfish.print.servlet.job

Class ThreadPoolJobManager

java.lang.Object

org.mapfish.print.servlet.job.ThreadPoolJobManager

All Implemented Interfaces:

JobManager

public class ThreadPoolJobManager
extends java.lang.Object
implements JobManager

A JobManager backed by a ThreadPoolExecutor.

Constructor Summary

Constructors

Constructor and Description
ThreadPoolJobManager()

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.
void	init() Called by spring after constructing the java bean.
boolean	isDone(java.lang.String referenceId) Check if the job is done.
void	setAbandonedTimeout(long abandonedTimeout)
void	setJobPriorityComparator(java.util.Comparator<PrintJob> jobPriorityComparator)
void	setMaxNumberOfRunningPrintJobs(int maxNumberOfRunningPrintJobs)
void	setMaxNumberOfWaitingJobs(int maxNumberOfWaitingJobs)
void	setOldFileCleanUp(boolean oldFileCleanUp)
void	setOldFileCleanupInterval(long oldFileCleanupInterval)
void	setTimeout(long timeout)
void	shutdown() Called by spring when application context is being destroyed.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThreadPoolJobManager

public ThreadPoolJobManager()

Method Detail

setMaxNumberOfRunningPrintJobs

public final void setMaxNumberOfRunningPrintJobs(int maxNumberOfRunningPrintJobs)

setMaxNumberOfWaitingJobs

public final void setMaxNumberOfWaitingJobs(int maxNumberOfWaitingJobs)

setTimeout

public final void setTimeout(long timeout)

setAbandonedTimeout

public final void setAbandonedTimeout(long abandonedTimeout)

setJobPriorityComparator

public final void setJobPriorityComparator(java.util.Comparator<PrintJob> jobPriorityComparator)

setOldFileCleanUp

public final void setOldFileCleanUp(boolean oldFileCleanUp)

setOldFileCleanupInterval

public final void setOldFileCleanupInterval(long oldFileCleanupInterval)

init

@PostConstruct
public final void init()

Called by spring after constructing the java bean.

shutdown

@PreDestroy
public final void shutdown()

Called by spring when application context is being destroyed.

submit

public final void submit(PrintJob job)

Description copied from interface: JobManager

Submit a new job for execution.

Specified by:

submit in interface JobManager

Parameters:

job - the job to run.

getNumberOfRequestsMade

public final int getNumberOfRequestsMade()

Description copied from interface: JobManager

Get the total number of print requests made.

Specified by:

getNumberOfRequestsMade in interface JobManager

isDone

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

Description copied from interface: JobManager

Check if the job is done.

Specified by:

isDone in interface JobManager

Parameters:

referenceId - the job to check.

Throws:

NoSuchReferenceException

cancel

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

Description copied from interface: JobManager

Cancel a job.

Specified by:

cancel in interface JobManager

Parameters:

referenceId - The referenceId of the job to cancel.

Throws:

NoSuchReferenceException

timeSinceLastStatusCheck

public final long timeSinceLastStatusCheck(java.lang.String referenceId)

Description copied from interface: JobManager

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

Specified by:

timeSinceLastStatusCheck in interface JobManager

Parameters:

referenceId - the id of the printjob

getAverageTimeSpentPrinting

public final long getAverageTimeSpentPrinting()

Description copied from interface: JobManager

Get the average time print jobs take to complete.

Specified by:

getAverageTimeSpentPrinting in interface JobManager

getLastPrintCount

public final int getLastPrintCount()

Description copied from interface: JobManager

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

Specified by:

getLastPrintCount in interface JobManager

getCompletedPrintJob

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

Description copied from interface: JobManager

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

Specified by:

getCompletedPrintJob in interface JobManager

Parameters:

referenceId - the referenceId of the report to lookup

Throws:

NoSuchReferenceException

getStatus

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

Description copied from interface: JobManager

Get the status for a job.

Specified by:

getStatus in interface JobManager

Parameters:

referenceId - The referenceId of the job to check.

Throws:

NoSuchReferenceException