org.mapfish.print.servlet.job

Class PrintJob

java.lang.Object

org.mapfish.print.servlet.job.PrintJob

All Implemented Interfaces:

java.util.concurrent.Callable<PrintJobStatus>

Direct Known Subclasses:

FilePrintJob

public abstract class PrintJob
extends java.lang.Object
implements java.util.concurrent.Callable<PrintJobStatus>

The information for printing a report.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	PrintJob.PrintAction Interface encapsulating the code to run with the open output stream.

Constructor Summary

Constructors

Constructor and Description
PrintJob()

Method Summary

Methods

Modifier and Type	Method and Description
PrintJobStatus	call()
void	configureAccess(Template template) Configure the access permissions required to access this print job.
AccessAssertion	getAccess()
protected java.lang.String	getAppId()
java.lang.Long	getCreateTime()
java.util.Date	getCreateTimeAsDate()
java.lang.String	getReferenceId() Get the reference id of the job so it can be looked up again later.
void	setCreateTime(java.lang.Long createTime)
void	setReferenceId(java.lang.String referenceId) Set the reference id of the job so it can be looked up again later.
void	setRequestData(PJsonObject requestData) Set the data from the client making the request.
void	setSecurityContext(org.springframework.security.core.context.SecurityContext securityContext) The security context that contains the information about the user that made the request.
protected abstract java.net.URI	withOpenOutputStream(PrintJob.PrintAction function) Open an OutputStream and execute the function using the OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintJob

public PrintJob()

Method Detail

getReferenceId

public final java.lang.String getReferenceId()

Get the reference id of the job so it can be looked up again later.

setReferenceId

public final void setReferenceId(java.lang.String referenceId)

Set the reference id of the job so it can be looked up again later.

Parameters:

referenceId - the referenceId

getCreateTime

public final java.lang.Long getCreateTime()

getCreateTimeAsDate

public final java.util.Date getCreateTimeAsDate()

setCreateTime

public final void setCreateTime(java.lang.Long createTime)

setRequestData

public final void setRequestData(PJsonObject requestData)

Set the data from the client making the request.

Parameters:

requestData - the json data

withOpenOutputStream

protected abstract java.net.URI withOpenOutputStream(PrintJob.PrintAction function)
                                              throws java.lang.Throwable

Open an OutputStream and execute the function using the OutputStream.

Parameters:

function - the function to execute

Returns:

the

Throws:

java.lang.Throwable

call

public final PrintJobStatus call()
                          throws java.lang.Exception

Specified by:

call in interface java.util.concurrent.Callable<PrintJobStatus>

Throws:

java.lang.Exception

getAppId

protected final java.lang.String getAppId()

setSecurityContext

public final void setSecurityContext(org.springframework.security.core.context.SecurityContext securityContext)

The security context that contains the information about the user that made the request. This must be set on SecurityContextHolder when the thread starts executing.

Parameters:

securityContext - the conext object

getAccess

public final AccessAssertion getAccess()

configureAccess

public final void configureAccess(Template template)

Configure the access permissions required to access this print job.

Parameters:

template - the containing print template which should have sufficient information to configure the access.