Package com.avoka.fc.core.service.storage

Class DatabaseSubmissionDataStorageService

java.lang.Object

com.avoka.fc.core.service.BaseService

com.avoka.fc.core.service.CayenneService

com.avoka.fc.core.service.storage.AbstractSubmissionDataStorageService

com.avoka.fc.core.service.storage.DatabaseSubmissionDataStorageService

All Implemented Interfaces:

IServiceDefinitionAware, ISubmissionDataStorageService

Direct Known Subclasses:

AmazonHSMSubmissionDataStorageService, AwsSubmissionDataStorageService, CloudSubmissionDataStorageService, FileSystemSubmissionDataStorageService, MockSubmissionDataStorageService

public class DatabaseSubmissionDataStorageService
extends AbstractSubmissionDataStorageService

Provides a database based submission data storage service class.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME	The Constant SERVICE_NAME.

Constructor Summary

Constructors

Constructor	Description
DatabaseSubmissionDataStorageService()

Method Summary

Modifier and Type	Method	Description
boolean	deleteAttachmentData(FileUpload fileUpload)	Delete attachment data.
boolean	deleteSubmissionData(Submission submission)	Delete the transaction data associated with this submission, if not already deleted.
byte[]	getAttachment(FileUpload fileUpload)	Gets the attachment file data.
byte[]	getSignatureReceipt(Submission submission)	Gets the signature receipt data.
byte[]	getSubmissionHistoryXml(SubmissionHistory history)	Gets the submission history xml data.
byte[]	getSubmissionReceipt(Submission submission)	Gets the submission receipt data.
byte[]	getSubmissionXml(Submission submission)	Gets the submission xml data.
boolean	initializeCryptoDataKey(Submission submission)	returns false as there is no crypto key to initialize This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.
void	storeAttachment(Submission submission, FileUpload fileUpload, byte[] fileData)	Store the submission attachment file data.
void	storeSignatureReceipt(Submission submission, byte[] receiptData)	Store submission signature receipt data.
void	storeSubmissionAndHistoryXml(Submission submission, SubmissionHistory history, byte[] xmlData)	Store submission form xml data against the submission and submission history objects.
void	storeSubmissionHistoryXml(SubmissionHistory history, byte[] xmlData)	Store submission history xml data.
void	storeSubmissionReceipt(Submission submission, byte[] receiptData)	Store submission receipt data.
void	storeSubmissionXml(Submission submission, byte[] xmlData)	Store submission form xml data.

Methods inherited from class com.avoka.fc.core.service.storage.AbstractSubmissionDataStorageService

decodeData, decryptText, encodeData, encryptText, getAttachmentsEncoding, getDataEncryptor, getErrorLogService, getReceiptPdfEncoding, getServiceDefinition, getSubmissionHistoryXmlEncoding, getSubmissionXmlEncoding, hasExternalizeStorage, refetchEntity, setAttachmentsEncoding, setDataEncryptor, setReceiptPdfEncoding, setServiceDefinition, setSubmissionHistoryXmlEncoding, setSubmissionXmlEncoding

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, 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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

The Constant SERVICE_NAME.

See Also:

Constant Field Values

Constructor Detail

DatabaseSubmissionDataStorageService

public DatabaseSubmissionDataStorageService()

Method Detail

storeSubmissionReceipt

public void storeSubmissionReceipt(Submission submission,
                                   byte[] receiptData)

Description copied from interface: ISubmissionDataStorageService

Store submission receipt data.

Parameters:

submission - the submission

receiptData - the signature receipt data

See Also:

ISubmissionDataStorageService.storeSignatureReceipt(Submission, byte[])

storeSignatureReceipt

public void storeSignatureReceipt(Submission submission,
                                  byte[] receiptData)

Description copied from interface: ISubmissionDataStorageService

Store submission signature receipt data.

Parameters:

submission - the submission

receiptData - the signature receipt data

See Also:

ISubmissionDataStorageService.storeSignatureReceipt(Submission, byte[])

storeSubmissionXml

public void storeSubmissionXml(Submission submission,
                               byte[] xmlData)

Description copied from interface: ISubmissionDataStorageService

Store submission form xml data.

Parameters:

submission - the submission

xmlData - the xml data

See Also:

ISubmissionDataStorageService.storeSubmissionXml(Submission, byte[])

storeSubmissionAndHistoryXml

public void storeSubmissionAndHistoryXml(Submission submission,
                                         SubmissionHistory history,
                                         byte[] xmlData)

Description copied from interface: ISubmissionDataStorageService

Store submission form xml data against the submission and submission history objects.

Parameters:

submission - the submission

history - the submission history

xmlData - the xml data

See Also:

ISubmissionDataStorageService.storeSubmissionAndHistoryXml(Submission, SubmissionHistory, byte[])

storeSubmissionHistoryXml

public void storeSubmissionHistoryXml(SubmissionHistory history,
                                      byte[] xmlData)

Description copied from interface: ISubmissionDataStorageService

Store submission history xml data.

Parameters:

history - the history

xmlData - the xml data

See Also:

ISubmissionDataStorageService.storeSubmissionHistoryXml(SubmissionHistory, byte[])

storeAttachment

public void storeAttachment(Submission submission,
                            FileUpload fileUpload,
                            byte[] fileData)

Description copied from interface: ISubmissionDataStorageService

Store the submission attachment file data.

Parameters:

submission - the associated submission

fileUpload - the file upload

fileData - the file data

See Also:

ISubmissionDataStorageService.storeAttachment(Submission, FileUpload, byte[])

getSubmissionReceipt

public byte[] getSubmissionReceipt(Submission submission)

Description copied from interface: ISubmissionDataStorageService

Gets the submission receipt data.

Parameters:

submission - the submission

Returns:

the submission receipt

See Also:

ISubmissionDataStorageService.getSubmissionReceipt(Submission)

getSignatureReceipt

public byte[] getSignatureReceipt(Submission submission)

Description copied from interface: ISubmissionDataStorageService

Gets the signature receipt data.

Parameters:

submission - the submission

Returns:

the signature receipt

See Also:

ISubmissionDataStorageService.getSignatureReceipt(Submission)

getSubmissionXml

public byte[] getSubmissionXml(Submission submission)

Description copied from interface: ISubmissionDataStorageService

Gets the submission xml data.

Parameters:

submission - the submission

Returns:

the submission xml

See Also:

ISubmissionDataStorageService.getSubmissionXml(Submission)

getSubmissionHistoryXml

public byte[] getSubmissionHistoryXml(SubmissionHistory history)

Description copied from interface: ISubmissionDataStorageService

Gets the submission history xml data.

Parameters:

history - the history

Returns:

the submission history xml

See Also:

ISubmissionDataStorageService.getSubmissionHistoryXml(SubmissionHistory)

getAttachment

public byte[] getAttachment(FileUpload fileUpload)

Description copied from interface: ISubmissionDataStorageService

Gets the attachment file data.

Parameters:

fileUpload - the file upload

Returns:

the attachment

See Also:

ISubmissionDataStorageService.getAttachment(FileUpload)

deleteSubmissionData

public boolean deleteSubmissionData(Submission submission)

Delete the transaction data associated with this submission, if not already deleted. Note submission delivery status must be [ Completed | Undeliverable | Not Required ]. Delete submission data, attachment data, submission history data and return true if successful.

Parameters:

submission - the submission to delete the data of (required)

Returns:

true if successful, or false if the data was already deleted or is in the wrong delivery status

See Also:

ISubmissionDataStorageService.deleteSubmissionData(Submission)

deleteAttachmentData

public boolean deleteAttachmentData(FileUpload fileUpload)

Description copied from interface: ISubmissionDataStorageService

Delete attachment data.

Parameters:

fileUpload - the file upload

Returns:

true, if successful

See Also:

ISubmissionDataStorageService.deleteAttachmentData(FileUpload)

initializeCryptoDataKey

public boolean initializeCryptoDataKey(Submission submission)

returns false as there is no crypto key to initialize This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.

Parameters:

submission - the submission to which the data key will be created

Returns:

false as the submission data storage does not store a crypto key

Since:

18.5.9