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

Class AwsHsmDataEncryptor

java.lang.Object

com.avoka.fc.core.service.storage.AwsHsmDataEncryptor

All Implemented Interfaces:

ISubmissionDataEncryptor

public class AwsHsmDataEncryptor
extends Object
implements ISubmissionDataEncryptor

Provides a AWS HSM submission data encryption class.

Since:

4.3.4

Constructor Summary

Constructors

Constructor	Description
AwsHsmDataEncryptor()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AwsHsmDataEncryptor

public AwsHsmDataEncryptor()

Method Detail

encryptText

public String encryptText(Submission submission,
                          String plainText)

Encrypt a string related to a submission.

Specified by:

encryptText in interface ISubmissionDataEncryptor

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

See Also:

ISubmissionDataEncryptor.encryptText(Submission, String)

decryptText

public String decryptText(Submission submission,
                          String cypherText)

Decrypt a submission related string that was created using encryptText

Specified by:

decryptText in interface ISubmissionDataEncryptor

Parameters:

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

cypherText - the encrypted string

Returns:

the plain text string

See Also:

ISubmissionDataEncryptor.decryptText(Submission, String)

encodeData

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

Encode the data for the given submission.

Specified by:

encodeData in interface ISubmissionDataEncryptor

Parameters:

submission - the submission record (required)

data - the data to encode (required)

encoding - the encoding mode

Returns:

the encode data

See Also:

ISubmissionDataEncryptor.encodeData(Submission, byte[], String)

decodeData

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

Decode the data for the given submission.

Specified by:

decodeData in interface ISubmissionDataEncryptor

Parameters:

submission - the submission record (required)

data - the data to encode (required)

encoding - the encoding mode

Returns:

the encode data

See Also:

ISubmissionDataEncryptor.decodeData(Submission, byte[], String)

setStorageServiceDefinition

public void setStorageServiceDefinition(ServiceDefinition serviceDef)

Set the parent submission data storage service definition.

Specified by:

setStorageServiceDefinition in interface ISubmissionDataEncryptor

Parameters:

serviceDef - set the parent submission data storage service definition.

See Also:

ISubmissionDataEncryptor.setStorageServiceDefinition(ServiceDefinition)

initializeCryptoDataKey

public 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.

Specified by:

initializeCryptoDataKey in interface ISubmissionDataEncryptor

Parameters:

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

Returns:

true as the submission data storage has stored a crypto key

Since:

18.5.9