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

Class FileSystemSubmissionDataStorageService

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

com.avoka.fc.core.service.storage.FileSystemSubmissionDataStorageService

All Implemented Interfaces:

IServiceDefinitionAware, ISubmissionDataStorageService

public class FileSystemSubmissionDataStorageService
extends DatabaseSubmissionDataStorageService

Provides a submission data storage service which stores file attachments on the file system. This service will the XML and PDF receipt data in the database.

Since:

4.2.0

Field Summary

Fields inherited from class com.avoka.fc.core.service.storage.DatabaseSubmissionDataStorageService

SERVICE_NAME

Constructor Summary

Constructors

Constructor	Description
FileSystemSubmissionDataStorageService()

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.
String	getBaseStorageDirectory()
protected ISubmissionDataEncryptor	getDataEncryptor()
String	getEncryptionMode()	Return the encryption mode [ Local | HSM ]
byte[]	getSignatureReceipt(Submission submission)	Gets the signature receipt data.
byte[]	getSubmissionReceipt(Submission submission)	Gets the submission receipt data.
void	setBaseStorageDirectory(String baseStorageDirectory)	Set the base storage director for submission data.
void	setEncryptionMode(String value)	Set the encryption mode [ Local | HSM ]
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	storeSubmissionReceipt(Submission submission, byte[] receiptData)	Store submission receipt data.

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

getSubmissionHistoryXml, getSubmissionXml, initializeCryptoDataKey, storeSubmissionAndHistoryXml, storeSubmissionHistoryXml, storeSubmissionXml

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

decodeData, decryptText, encodeData, encryptText, getAttachmentsEncoding, 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

Constructor Detail

FileSystemSubmissionDataStorageService

public FileSystemSubmissionDataStorageService()

Method Detail

storeSubmissionReceipt

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

Description copied from interface: ISubmissionDataStorageService

Store submission receipt data.

Specified by:

storeSubmissionReceipt in interface ISubmissionDataStorageService

Overrides:

storeSubmissionReceipt in class DatabaseSubmissionDataStorageService

Parameters:

submission - the submission

receiptData - the signature receipt data

See Also:

ISubmissionDataStorageService.storeSubmissionReceipt(Submission, byte[])

storeSignatureReceipt

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

Description copied from interface: ISubmissionDataStorageService

Store submission signature receipt data.

Specified by:

storeSignatureReceipt in interface ISubmissionDataStorageService

Overrides:

storeSignatureReceipt in class DatabaseSubmissionDataStorageService

Parameters:

submission - the submission

receiptData - the signature receipt data

See Also:

ISubmissionDataStorageService.storeSignatureReceipt(Submission, byte[])

getSubmissionReceipt

public byte[] getSubmissionReceipt(Submission submission)

Description copied from interface: ISubmissionDataStorageService

Gets the submission receipt data.

Specified by:

getSubmissionReceipt in interface ISubmissionDataStorageService

Overrides:

getSubmissionReceipt in class DatabaseSubmissionDataStorageService

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.

Specified by:

getSignatureReceipt in interface ISubmissionDataStorageService

Overrides:

getSignatureReceipt in class DatabaseSubmissionDataStorageService

Parameters:

submission - the submission

Returns:

the submission receipt

See Also:

ISubmissionDataStorageService.getSignatureReceipt(Submission)

storeAttachment

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

Store the submission attachment file data.

Specified by:

storeAttachment in interface ISubmissionDataStorageService

Overrides:

storeAttachment in class DatabaseSubmissionDataStorageService

Parameters:

submission - the associated submission

fileUpload - the file upload

fileData - the file data

See Also:

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

getAttachment

public byte[] getAttachment(FileUpload fileUpload)

Gets the attachment file data.

Specified by:

getAttachment in interface ISubmissionDataStorageService

Overrides:

getAttachment in class DatabaseSubmissionDataStorageService

Parameters:

fileUpload - the file upload

Returns:

the attachment

See Also:

ISubmissionDataStorageService.getAttachment(FileUpload)

deleteAttachmentData

public boolean deleteAttachmentData(FileUpload fileUpload)

Delete attachment data.

Specified by:

deleteAttachmentData in interface ISubmissionDataStorageService

Overrides:

deleteAttachmentData in class DatabaseSubmissionDataStorageService

Parameters:

fileUpload - the file upload

Returns:

true, if successful

See Also:

ISubmissionDataStorageService.deleteAttachmentData(FileUpload)

deleteSubmissionData

public boolean deleteSubmissionData(Submission submission)

Delete the transaction data associated with this submission, if not already deleted.

Delete submission data, attachment data, submission history data and return true if successful.

Specified by:

deleteSubmissionData in interface ISubmissionDataStorageService

Overrides:

deleteSubmissionData in class DatabaseSubmissionDataStorageService

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)

setEncryptionMode

public void setEncryptionMode(String value)

Set the encryption mode [ Local | HSM ]

Parameters:

value - the encryption mode

getEncryptionMode

public String getEncryptionMode()

Return the encryption mode [ Local | HSM ]

Returns:

the encryption mode

getDataEncryptor

protected ISubmissionDataEncryptor getDataEncryptor()

Overrides:

getDataEncryptor in class AbstractSubmissionDataStorageService

Returns:

the submission data encryptor

getBaseStorageDirectory

public String getBaseStorageDirectory()

Returns:

the base storage directory for submission data

setBaseStorageDirectory

public void setBaseStorageDirectory(String baseStorageDirectory)

Set the base storage director for submission data.

Parameters:

baseStorageDirectory - the base storage directory for submission data