org.mapfish.print.servlet.job

Class PrintJobStatus

java.lang.Object

org.mapfish.print.servlet.job.PrintJobStatus

Direct Known Subclasses:

FailedPrintJob, PendingPrintJob, SuccessfulPrintJob

public abstract class PrintJobStatus
extends java.lang.Object

Represent a print job that has completed. Contains the information about the print job.

Constructor Summary

Constructors

Constructor and Description
PrintJobStatus(java.lang.String referenceId, java.lang.String appId, java.util.Date startDate, java.util.Date completionDate, long requestCount, java.lang.String fileName, AccessAssertion accessAssertion) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addExtraParameters(org.json.JSONObject metadata) Add extra information to the metadata object being put in the registry.
void	assertAccess() Assert that the current is authorized to access this job.
AccessAssertion	getAccess()
java.lang.String	getAppId()
java.util.Date	getCompletionDate()
long	getElapsedTime() Get the elapsed time in ms.
java.lang.String	getFileName()
java.lang.String	getReferenceId()
long	getRequestCount()
java.util.Date	getStartDate()
static com.google.common.base.Optional<? extends PrintJobStatus>	load(java.lang.String referenceId, Registry registry, AccessAssertionPersister persister) Construct a print job by reading the data from a registry.
void	setCompletionDate(java.util.Date completionDate)
void	store(Registry registry, AccessAssertionPersister persister) Store the data of a print job in the registry.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintJobStatus

public PrintJobStatus(java.lang.String referenceId,
              java.lang.String appId,
              java.util.Date startDate,
              java.util.Date completionDate,
              long requestCount,
              java.lang.String fileName,
              AccessAssertion accessAssertion)

Constructor.

Parameters:

referenceId - reference of the report.

appId - the appId used for loading the configuration.

fileName - the fileName to send to the client.

startDate - the time when the print job started.

completionDate - the time when the print job ended.

requestCount - the total number of requests made when the job was submitted.

accessAssertion - the an access control object for downloading this report. Typically this is combined access of the template and the configuration.

Method Detail

assertAccess

public final void assertAccess()

Assert that the current is authorized to access this job.

store

public final void store(Registry registry,
         AccessAssertionPersister persister)
                 throws org.json.JSONException

Store the data of a print job in the registry.

Parameters:

registry - the registry to writer to

persister - a persister for converting the access assertion to json

Throws:

org.json.JSONException

addExtraParameters

protected abstract void addExtraParameters(org.json.JSONObject metadata)
                                    throws org.json.JSONException

Add extra information to the metadata object being put in the registry.

Parameters:

metadata - the json object that contains the metadata

Throws:

org.json.JSONException

load

public static com.google.common.base.Optional<? extends PrintJobStatus> load(java.lang.String referenceId,
                                                             Registry registry,
                                                             AccessAssertionPersister persister)
                                                                      throws org.json.JSONException,
                                                                             NoSuchReferenceException

Construct a print job by reading the data from a registry.

Parameters:

referenceId - the reference id of the report to get information about.

registry - the registry to read from.

persister - the access persister to use for reading the access data from the registry

Throws:

org.json.JSONException

NoSuchReferenceException

getReferenceId

public final java.lang.String getReferenceId()

getAppId

public final java.lang.String getAppId()

getFileName

public final java.lang.String getFileName()

getStartDate

public final java.util.Date getStartDate()

setCompletionDate

public final void setCompletionDate(java.util.Date completionDate)

getCompletionDate

public final java.util.Date getCompletionDate()

getRequestCount

public final long getRequestCount()

getAccess

public final AccessAssertion getAccess()

getElapsedTime

public final long getElapsedTime()

Get the elapsed time in ms.