org.finra.herd.service

Interface StoragePolicyProcessorHelperService

All Known Implementing Classes:

StoragePolicyProcessorHelperServiceImpl

public interface StoragePolicyProcessorHelperService

The helper service class for the storage policy processor service.

Method Summary

Modifier and Type	Method and Description
void	completeStoragePolicyTransition(StoragePolicyTransitionParamsDto storagePolicyTransitionParamsDto) Completes a storage policy transition as per specified storage policy selection.
void	executeStoragePolicyTransition(StoragePolicyTransitionParamsDto storagePolicyTransitionParamsDto) Executes a storage policy transition as per specified storage policy selection.
void	initiateStoragePolicyTransition(StoragePolicyTransitionParamsDto storagePolicyTransitionParamsDto, StoragePolicySelection storagePolicySelection) Initiates a storage policy transition as per specified storage policy selection.
void	updateStoragePolicyTransitionFailedAttemptsIgnoreException(StoragePolicyTransitionParamsDto storagePolicyTransitionParamsDto) Increments the count for failed storage policy transition attempts for the specified storage unit.

Method Detail

initiateStoragePolicyTransition

void initiateStoragePolicyTransition(StoragePolicyTransitionParamsDto storagePolicyTransitionParamsDto,
                                     StoragePolicySelection storagePolicySelection)

Initiates a storage policy transition as per specified storage policy selection. This method also updates storage policy transition DTO with parameters needed to perform a storage policy transition.

Parameters:

storagePolicyTransitionParamsDto - the storage policy transition DTO to be updated with parameters needed to perform a storage policy transition

storagePolicySelection - the storage policy selection message

executeStoragePolicyTransition

void executeStoragePolicyTransition(StoragePolicyTransitionParamsDto storagePolicyTransitionParamsDto)

Executes a storage policy transition as per specified storage policy selection.

Parameters:

storagePolicyTransitionParamsDto - the storage policy transition DTO that contains parameters needed to perform a storage policy transition

completeStoragePolicyTransition

void completeStoragePolicyTransition(StoragePolicyTransitionParamsDto storagePolicyTransitionParamsDto)

Completes a storage policy transition as per specified storage policy selection.

Parameters:

storagePolicyTransitionParamsDto - the storage policy transition DTO that contains parameters needed to complete a storage policy transition

updateStoragePolicyTransitionFailedAttemptsIgnoreException

void updateStoragePolicyTransitionFailedAttemptsIgnoreException(StoragePolicyTransitionParamsDto storagePolicyTransitionParamsDto)

Increments the count for failed storage policy transition attempts for the specified storage unit. This method does not fail in case storage unit entity update is unsuccessful, but simply logs the exception information as a warning.

Parameters:

storagePolicyTransitionParamsDto - the storage policy transition DTO that contains parameters needed to complete a storage policy transition. The business object data key and storage name identify the storage unit to be updated