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

Interface ISubmissionDataEncryptor

All Known Implementing Classes:

AwsHsmDataEncryptor, AwsKmsDataEncryptor, AzureKeyVaultDataEncryptor, CaviumHsmDataEncryptor, LocalKeystoreDataEncryptor

public interface ISubmissionDataEncryptor

Provides an interface to perform submission data encryption and decryption.

Since:

4.3.4

Method Summary

Modifier and Type	Method	Description
byte[]	decodeData(Submission submission, byte[] data, String encoding)	Decode the data for the given submission.
String	decryptText(Submission submission, String cypherText)	Decrypt a submission related string that was created using encryptText
byte[]	encodeData(Submission submission, byte[] data, String encoding)	Encode the data for the given submission.
String	encryptText(Submission submission, String plainText)	Encrypt a string related to a submission.
boolean	initializeCryptoDataKey(Submission submission)	Initializes the crypto data key for the submission This is called on Render to avoid a race condition TMR-2171 with multi simultaneous Dynamic Data Calls.
void	setStorageServiceDefinition(ServiceDefinition serviceDef)	Set the parent submission data storage service definition.

Method Detail

encodeData

byte[] encodeData(Submission submission,
                  byte[] data,
                  String encoding)

Encode the data for the given submission.

Parameters:

submission - the submission record (required)

data - the data to encode (required)

encoding - the encoding mode

Returns:

the encode data

decodeData

byte[] decodeData(Submission submission,
                  byte[] data,
                  String encoding)

Decode the data for the given submission.

Parameters:

submission - the submission record (required)

data - the data to encode (required)

encoding - the encoding mode

Returns:

the encode data

encryptText

String encryptText(Submission submission,
                   String plainText)

Encrypt a string related to a submission.

Parameters:

submission - the submission which the string relates to (required)

plainText - the plain text string to be encrypted

Returns:

the encrypted string - note that this will generally be longer than the original

decryptText

String decryptText(Submission submission,
                   String cypherText)

Decrypt a submission related string that was created using encryptText

Parameters:

submission - the submission which the string relates to (required)

cypherText - the encrypted string

Returns:

the plain text string

setStorageServiceDefinition

void setStorageServiceDefinition(ServiceDefinition serviceDef)

Set the parent submission data storage service definition.

Parameters:

serviceDef - set the parent submission data storage service definition.

initializeCryptoDataKey

boolean initializeCryptoDataKey(Submission submission)

Initializes the crypto data key for the submission 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:

true if the submission data storage stores a crypto key otherwise false

Since:

18.5.9