org.finra.herd.service

Interface UploadDownloadHelperService

All Known Implementing Classes:

UploadDownloadHelperServiceImpl

public interface UploadDownloadHelperService

Method Summary

Modifier and Type	Method and Description
void	assertS3ObjectKeyDoesNotExist(String bucketName, String key) Asserts that the S3 object in the specified bucket and key does not exist.
void	deleteSourceFileFromS3(CompleteUploadSingleParamsDto completeUploadSingleParamsDto) delete the source file from S3
void	executeFileMoveAfterSteps(CompleteUploadSingleParamsDto completeUploadSingleParamsDto) Executes the steps required to complete the processing of complete upload single message following a successful S3 file move operation.
void	performFileMove(CompleteUploadSingleParamsDto completeUploadSingleParamsDto) Moves an S3 file from the source bucket to the target bucket.
void	prepareForFileMove(String objectKey, CompleteUploadSingleParamsDto completeUploadSingleParamsDto) Prepares to move an S3 file from the source bucket to the target bucket.
void	updateBusinessObjectDataStatus(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus) Updates the business object data status in a new transaction.

Method Detail

prepareForFileMove

void prepareForFileMove(String objectKey,
                        CompleteUploadSingleParamsDto completeUploadSingleParamsDto)

Prepares to move an S3 file from the source bucket to the target bucket. On success, both the target and source business object data statuses are set to "RE-ENCRYPTING" and the DTO is updated accordingly.

Parameters:

objectKey - the object key (i.e. filename)

completeUploadSingleParamsDto - the DTO to be initialized with parameters required for complete upload single message processing

performFileMove

void performFileMove(CompleteUploadSingleParamsDto completeUploadSingleParamsDto)

Moves an S3 file from the source bucket to the target bucket. Updates the target business object data status in the DTO based on the result of S3 copy operation. If S3 copy fails, the target business object data status in the DTO is set to "INVALID", otherwise it is set to "VALID".

Parameters:

completeUploadSingleParamsDto - the DTO that contains complete upload single message parameters

executeFileMoveAfterSteps

void executeFileMoveAfterSteps(CompleteUploadSingleParamsDto completeUploadSingleParamsDto)

Executes the steps required to complete the processing of complete upload single message following a successful S3 file move operation. The method also updates the DTO that contains complete upload single message parameters.

Parameters:

completeUploadSingleParamsDto - the DTO that contains complete upload single message parameters

deleteSourceFileFromS3

void deleteSourceFileFromS3(CompleteUploadSingleParamsDto completeUploadSingleParamsDto)

delete the source file from S3

Parameters:

completeUploadSingleParamsDto - the DTO that contains complete upload single message parameters

updateBusinessObjectDataStatus

void updateBusinessObjectDataStatus(BusinessObjectDataKey businessObjectDataKey,
                                    String businessObjectDataStatus)

Updates the business object data status in a new transaction.

Parameters:

businessObjectDataKey - the business object data key

businessObjectDataStatus - the business object data status

assertS3ObjectKeyDoesNotExist

void assertS3ObjectKeyDoesNotExist(String bucketName,
                                   String key)

Asserts that the S3 object in the specified bucket and key does not exist.

Parameters:

bucketName - The S3 bucket name

key - The S3 key