org.mapfish.print.servlet.job

Class SuccessfulPrintJob

java.lang.Object

org.mapfish.print.servlet.job.PrintJobStatus

org.mapfish.print.servlet.job.SuccessfulPrintJob

public final class SuccessfulPrintJob
extends PrintJobStatus

Represents a successfully completed job.

Constructor Summary

Constructors

Constructor and Description
SuccessfulPrintJob(java.lang.String referenceId, java.net.URI reportURI, java.lang.String appId, java.util.Date startDate, java.util.Date completionDate, long requestCount, java.lang.String fileName, java.lang.String mimeType, java.lang.String fileExtension, AccessAssertion access) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addExtraParameters(org.json.JSONObject metadata) Add extra information to the metadata object being put in the registry.
java.lang.String	getFileExtension()
java.lang.String	getMimeType()
java.net.URI	getURI()
static SuccessfulPrintJob	load(org.json.JSONObject metadata, java.lang.String referenceId, java.lang.String appId, java.util.Date startDate, java.util.Date completionDate, long requestCount, java.lang.String fileName, AccessAssertion reportAccess) Construct a new instance from the values provided.

Methods inherited from class org.mapfish.print.servlet.job.PrintJobStatus

assertAccess, getAccess, getAppId, getCompletionDate, getElapsedTime, getFileName, getReferenceId, getRequestCount, getStartDate, load, setCompletionDate, store

Methods inherited from class java.lang.Object

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

Constructor Detail

SuccessfulPrintJob

public SuccessfulPrintJob(java.lang.String referenceId,
                  java.net.URI reportURI,
                  java.lang.String appId,
                  java.util.Date startDate,
                  java.util.Date completionDate,
                  long requestCount,
                  java.lang.String fileName,
                  java.lang.String mimeType,
                  java.lang.String fileExtension,
                  AccessAssertion access)

Constructor.

Parameters:

referenceId - reference of the report.

reportURI - the uri for fetching the report.

appId - the appId used for loading the configuration.

startDate - the date when the print job started.

completionDate - the date when the print job completed.

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

fileName - the fileName to send to the client.

mimeType - the mimetype of the printed file

fileExtension - the file extension (to be added to the filename)

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

Method Detail

getURI

public java.net.URI getURI()

getMimeType

public java.lang.String getMimeType()

getFileExtension

public java.lang.String getFileExtension()

load

public static SuccessfulPrintJob load(org.json.JSONObject metadata,
                      java.lang.String referenceId,
                      java.lang.String appId,
                      java.util.Date startDate,
                      java.util.Date completionDate,
                      long requestCount,
                      java.lang.String fileName,
                      AccessAssertion reportAccess)
                               throws org.json.JSONException

Construct a new instance from the values provided.

Parameters:

metadata - the metadata retrieved from the registry. Only need it to get the extra information that is not stored by parent class.

referenceId - reference of the report.

appId - the appId used for loading the configuration.

startDate - the start date.

completionDate - the date when the print job completed.

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

fileName - the fileName to send to the client.

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

Throws:

org.json.JSONException

addExtraParameters

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

Description copied from class: PrintJobStatus

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

Specified by:

addExtraParameters in class PrintJobStatus

Parameters:

metadata - the json object that contains the metadata

Throws:

org.json.JSONException