Package com.avoka.fc.core.service

Class AbstractRenderReceiptService

java.lang.Object

com.avoka.fc.core.service.BaseService

com.avoka.fc.core.service.CayenneService

com.avoka.fc.core.service.AbstractRenderReceiptService

All Implemented Interfaces:

IRenderReceiptService, IServiceDefinitionAware

Direct Known Subclasses:

AcroFormRenderReceiptService, LocalProcessRenderReceiptService, PhantomJSRenderReceiptService

public abstract class AbstractRenderReceiptService
extends CayenneService
implements IRenderReceiptService, IServiceDefinitionAware

Provides an abstract PDF receipt rendering service for subclasses to implement.

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE_PDF	The PDF content type header value.

Constructor Summary

Constructors

Constructor	Description
AbstractRenderReceiptService()

Method Summary

Modifier and Type	Method	Description
byte[]	generateReceipt(TemplateVersion templateVersion, String xml)	Return a PDF Receipt byte array rendered from the Form TemplateVersion and xml
Integer	getMaxProcesses()	Return the maximum number of concurrent processes.
protected abstract DataDocument	getReceiptDocument(Submission submission, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, String receiptMode)	Return the PDF Receipt DataDocument for the submission, request and requestLog.
ServiceDefinition	getServiceDefinition()	Return the service definition for the service.
void	renderReceipt(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, RequestLog requestLog)	Render the PDF Receipt given the submission.
byte[]	renderReceipt(Submission submission, String mode)	Return a PDF Receipt byte array rendered from the submission.
void	setMaxProcesses(Integer value)	Set the maximum number of concurrent processes.
void	setServiceDefinition(ServiceDefinition serviceDefinition)	Set the service definition for the service.
void	setTestMode(boolean testMode)	Specify whether running in test mode an render receipt changes should not be committed to database.
protected String	updateReceiptMode(String xmlData, TemplateVersion templateVersion, jakarta.servlet.http.HttpServletRequest request)	Return the updated form submission XML data with the correct receipt mode for the receipt rendering context.
protected String	updateReceiptMode(String xmlData, TemplateVersion templateVersion, jakarta.servlet.http.HttpServletRequest request, String mode)	Return the updated form submission XML data with the correct receipt mode for the receipt rendering context.

Methods inherited from class com.avoka.fc.core.service.CayenneService

commitChanges, deleteObject, deleteObjects, findObject, getDataContext, getDataDomain, getObjectForPK, getObjectStore, newObject, performNamedQuery, performNamedQuery, performNamedQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performQuery, performQuery, refetchEntity, refetchObject, registerNewObject, rollbackChanges, toMap, toMap

Methods inherited from class com.avoka.fc.core.service.BaseService

getLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.avoka.fc.core.service.IRenderReceiptService

requiresLiveCycle

Field Details

CONTENT_TYPE_PDF

public static final String CONTENT_TYPE_PDF

The PDF content type header value.

See Also:

• Constant Field Values

Constructor Details

AbstractRenderReceiptService

public AbstractRenderReceiptService()

Method Details

getReceiptDocument

protected abstract DataDocument getReceiptDocument(Submission submission,
 jakarta.servlet.http.HttpServletRequest request,
 RequestLog requestLog,
 String receiptMode)
                                            throws ApplicationException

Return the PDF Receipt DataDocument for the submission, request and requestLog.

Parameters:

submission - the form submission

request - the servlet request

requestLog - the request log

receiptMode - receipt mode in [ Web | Email | Delivery ]

Returns:

the PDF Receipt DataDocument for the submission, request and requestLog

Throws:

ApplicationException

renderReceipt

public void renderReceipt(Submission submission,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 RequestLog requestLog)
                   throws ApplicationException

Render the PDF Receipt given the submission.

Specified by:

renderReceipt in interface IRenderReceiptService

Parameters:

submission - the submission

request - - the users Http servlet request

response - - the Http servlet response to render to

requestLog - - the request log parameter

Throws:

ApplicationException - if an error occurs at runtime

See Also:

• IRenderReceiptService.renderReceipt(Submission, HttpServletRequest, HttpServletResponse, RequestLog)

renderReceipt

public byte[] renderReceipt(Submission submission,
 String mode)
                     throws ApplicationException

Return a PDF Receipt byte array rendered from the submission.

Specified by:

renderReceipt in interface IRenderReceiptService

Parameters:

submission - the submission

mode - receipt mode in [ Web | Email | Delivery ]

Returns:

the receipt data in PDF

Throws:

ApplicationException - if an error occurs at runtime

See Also:

• IRenderReceiptService.renderReceipt(Submission, String)

generateReceipt

public byte[] generateReceipt(TemplateVersion templateVersion,
 String xml)
                       throws ApplicationException

Return a PDF Receipt byte array rendered from the Form TemplateVersion and xml

Parameters:

templateVersion - the form templateVersion

xml - the xmlData

Returns:

the receipt data in PDF

Throws:

ApplicationException - if an error occurs at runtime

Since:

24.10.0

setTestMode

public void setTestMode(boolean testMode)

Specify whether running in test mode an render receipt changes should not be committed to database.

Specified by:

setTestMode in interface IRenderReceiptService

Parameters:

testMode - Specify whether running in test mode an render receipt changes should not be committed to database

Since:

4.1.15

See Also:

• IRenderReceiptService.setTestMode(boolean)

setMaxProcesses

public void setMaxProcesses(Integer value)

Set the maximum number of concurrent processes.

Specified by:

setMaxProcesses in interface IRenderReceiptService

Parameters:

value - the maximum number of concurrent processes

Since:

5.0.3

See Also:

• IRenderReceiptService.setMaxProcesses(Integer)

getMaxProcesses

public Integer getMaxProcesses()

Return the maximum number of concurrent processes.

Returns:

the maximum number of concurrent processes

Since:

5.0.3

setServiceDefinition

public void setServiceDefinition(ServiceDefinition serviceDefinition)

Set the service definition for the service.

Specified by:

setServiceDefinition in interface IServiceDefinitionAware

Parameters:

serviceDefinition - the service definition for the service

See Also:

• IServiceDefinitionAware.setServiceDefinition(ServiceDefinition)

getServiceDefinition

public ServiceDefinition getServiceDefinition()

Return the service definition for the service.

Specified by:

getServiceDefinition in interface IServiceDefinitionAware

Returns:

the service definition for the service

See Also:

• IServiceDefinitionAware.getServiceDefinition()

updateReceiptMode

protected String updateReceiptMode(String xmlData,
 TemplateVersion templateVersion,
 jakarta.servlet.http.HttpServletRequest request)

Return the updated form submission XML data with the correct receipt mode for the receipt rendering context.

Parameters:

xmlData - the form submission XML data

templateVersion - the form template version

request - the servlet request

Returns:

the updated form submission XML data with the correct receipt mode for the receipt rendering context

Since:

4.0.0

updateReceiptMode

protected String updateReceiptMode(String xmlData,
 TemplateVersion templateVersion,
 jakarta.servlet.http.HttpServletRequest request,
 String mode)

Return the updated form submission XML data with the correct receipt mode for the receipt rendering context.

Parameters:

xmlData - the form submission XML data

templateVersion - the form template version

request - the servlet request

mode - the receipt mode

Returns:

the updated form submission XML data with the correct receipt mode for the receipt rendering context