Package org.mapfish.print.servlet.job

Class PrintJob

java.lang.Object

org.mapfish.print.servlet.job.PrintJob

All Implemented Interfaces:

Callable<PrintJobResult>

Direct Known Subclasses:

FilePrintJob, HibernatePrintJob

public abstract class PrintJob
extends Object
implements Callable<PrintJobResult>

The information for printing a report.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	PrintJob.PrintAction	Interface encapsulating the code to run with the open output stream.
static final record	PrintJob.PrintResult	Holds the info that goes with the result of a print.

Constructor Summary

Constructors

Constructor	Description
PrintJob()

Method Summary

Modifier and Type	Method	Description
PrintJobResult	call()
protected abstract PrintJobResult	createResult(String fileName, String fileExtension, String mimeType)	Create Print Job Result.
protected void	deleteReport()	Delete the report (used if the report is sent by email).
final PrintJobEntry	getEntry()
protected File	getReportFile()
final void	setEntry(PrintJobEntry entry)
final void	setSecurityContext(org.springframework.security.core.context.SecurityContext securityContext)	The security context that contains the information about the user that made the request.
protected PrintJob.PrintResult	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 Details

PrintJob

public PrintJob()

Method Details

getEntry

public final PrintJobEntry getEntry()

setEntry

public final void setEntry(PrintJobEntry entry)

getReportFile

protected File getReportFile()

withOpenOutputStream

protected PrintJob.PrintResult withOpenOutputStream(PrintJob.PrintAction function)
                                             throws Exception

Open an OutputStream and execute the function using the OutputStream.

Parameters:

function - the function to execute

Returns:

the URI and the file size

Throws:

Exception

createResult

protected abstract PrintJobResult createResult(String fileName,
 String fileExtension,
 String mimeType)
                                        throws URISyntaxException,
IOException

Create Print Job Result.

Parameters:

fileName - the file name

fileExtension - the file extension

mimeType - the mime type

Returns:

the job result

Throws:

URISyntaxException

IOException

call

public PrintJobResult call()
                    throws Exception

Specified by:

call in interface Callable<PrintJobResult>

Throws:

Exception

deleteReport

protected void deleteReport()

Delete the report (used if the report is sent by email).

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 context object