org.finra.herd.service.impl

Class UploadDownloadHelperServiceImpl

java.lang.Object

org.finra.herd.service.impl.UploadDownloadHelperServiceImpl

All Implemented Interfaces:

UploadDownloadHelperService

@Service
 @Transactional(value="herdTransactionManager")
public class UploadDownloadHelperServiceImpl
extends Object
implements UploadDownloadHelperService

A helper service class for UploadDownloadService.

Constructor Summary

Constructors

Constructor and Description
UploadDownloadHelperServiceImpl()

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
protected void	deleteSourceFileFromS3Impl(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	executeFileMoveAfterStepsImpl(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.
protected void	performFileMoveImpl(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.
protected void	prepareForFileMoveImpl(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.
protected void	updateBusinessObjectDataStatusImpl(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus) Implementation of the update business object data status.

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadDownloadHelperServiceImpl

public UploadDownloadHelperServiceImpl()

Method Detail

prepareForFileMove

@PublishNotificationMessages
 @Transactional(propagation=REQUIRES_NEW)
public void prepareForFileMove(String objectKey,
                                                                                                      CompleteUploadSingleParamsDto completeUploadSingleParamsDto)

Description copied from interface: UploadDownloadHelperService

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.

Specified by:

prepareForFileMove in interface UploadDownloadHelperService

Parameters:

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

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

prepareForFileMoveImpl

protected void prepareForFileMoveImpl(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

@Transactional(propagation=NOT_SUPPORTED)
public void performFileMove(CompleteUploadSingleParamsDto completeUploadSingleParamsDto)

Description copied from interface: UploadDownloadHelperService

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

Specified by:

performFileMove in interface UploadDownloadHelperService

Parameters:

completeUploadSingleParamsDto - the DTO that contains complete upload single message parameters

performFileMoveImpl

protected void performFileMoveImpl(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.

Parameters:

completeUploadSingleParamsDto - the DTO that contains complete upload single message parameters

executeFileMoveAfterSteps

@PublishNotificationMessages
 @Transactional(propagation=REQUIRES_NEW)
public void executeFileMoveAfterSteps(CompleteUploadSingleParamsDto completeUploadSingleParamsDto)

Description copied from interface: UploadDownloadHelperService

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.

Specified by:

executeFileMoveAfterSteps in interface UploadDownloadHelperService

Parameters:

completeUploadSingleParamsDto - the DTO that contains complete upload single message parameters

executeFileMoveAfterStepsImpl

public void executeFileMoveAfterStepsImpl(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

@Transactional(propagation=NOT_SUPPORTED)
public void deleteSourceFileFromS3(CompleteUploadSingleParamsDto completeUploadSingleParamsDto)

Description copied from interface: UploadDownloadHelperService

delete the source file from S3

Specified by:

deleteSourceFileFromS3 in interface UploadDownloadHelperService

Parameters:

completeUploadSingleParamsDto - the DTO that contains complete upload single message parameters

deleteSourceFileFromS3Impl

protected void deleteSourceFileFromS3Impl(CompleteUploadSingleParamsDto completeUploadSingleParamsDto)

Delete the source file from S3

Parameters:

completeUploadSingleParamsDto - the DTO that contains complete upload single message parameters

updateBusinessObjectDataStatus

@PublishNotificationMessages
 @Transactional(propagation=REQUIRES_NEW)
public void updateBusinessObjectDataStatus(BusinessObjectDataKey businessObjectDataKey,
                                                                                                                  String businessObjectDataStatus)

Description copied from interface: UploadDownloadHelperService

Updates the business object data status in a new transaction.

Specified by:

updateBusinessObjectDataStatus in interface UploadDownloadHelperService

Parameters:

businessObjectDataKey - the business object data key

businessObjectDataStatus - the business object data status

updateBusinessObjectDataStatusImpl

protected void updateBusinessObjectDataStatusImpl(BusinessObjectDataKey businessObjectDataKey,
                                                  String businessObjectDataStatus)

Implementation of the update business object data status.

assertS3ObjectKeyDoesNotExist

public void assertS3ObjectKeyDoesNotExist(String bucketName,
                                          String key)

Description copied from interface: UploadDownloadHelperService

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

Specified by:

assertS3ObjectKeyDoesNotExist in interface UploadDownloadHelperService

Parameters:

bucketName - The S3 bucket name

key - The S3 key