org.finra.herd.service.helper

Class StorageUnitDaoHelper

java.lang.Object

org.finra.herd.service.helper.StorageUnitDaoHelper

@Component
public class StorageUnitDaoHelper
extends Object

Helper for storage unit related operations which require DAO.

Constructor Summary

Constructors

Constructor and Description
StorageUnitDaoHelper()

Method Summary

Modifier and Type	Method and Description
StorageUnitEntity	findExplicitlyRegisteredSubPartitionInStorageForBusinessObjectData(StorageEntity storageEntity, BusinessObjectFormatEntity businessObjectFormatEntity, BusinessObjectFormat businessObjectFormat, BusinessObjectDataKey businessObjectDataKey) Tries to find at least one sub-partition for the specified business object data that is explicitly registered in the same storage.
StorageUnitEntity	getStorageUnitEntity(String storageName, BusinessObjectDataEntity businessObjectDataEntity) Retrieves a storage unit entity for the business object data in the specified storage and make sure it exists.
StorageUnitEntity	getStorageUnitEntityByBusinessObjectDataAndStorage(BusinessObjectDataEntity businessObjectDataEntity, StorageEntity storageEntity) Retrieves a storage unit entity for the business object data in the specified storage and make sure it exists.
StorageUnitEntity	getStorageUnitEntityByKey(BusinessObjectDataStorageUnitKey businessObjectDataStorageUnitKey) Retrieves a storage unit entity for the specified business object data storage unit key and makes sure it exists.
void	setStorageUnitStatus(StorageUnitEntity storageUnitEntity, StorageUnitStatusEntity storageUnitStatusEntity) Sets storage unit status value for a storage unit.
void	updateStorageUnitStatus(StorageUnitEntity storageUnitEntity, StorageUnitStatusEntity storageUnitStatusEntity, String reason) Updates storage unit status value for a storage unit.
void	updateStorageUnitStatus(StorageUnitEntity storageUnitEntity, String storageUnitStatus, String reason) Update the storage unit status.
void	validateNoExplicitlyRegisteredSubPartitionInStorageForBusinessObjectData(StorageEntity storageEntity, BusinessObjectFormatEntity businessObjectFormatEntity, BusinessObjectDataKey businessObjectDataKey, String s3KeyPrefix) Validates that there are no explicitly registered sub-partitions in storage for the business object data.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageUnitDaoHelper

public StorageUnitDaoHelper()

Method Detail

findExplicitlyRegisteredSubPartitionInStorageForBusinessObjectData

public StorageUnitEntity findExplicitlyRegisteredSubPartitionInStorageForBusinessObjectData(StorageEntity storageEntity,
                                                                                            BusinessObjectFormatEntity businessObjectFormatEntity,
                                                                                            BusinessObjectFormat businessObjectFormat,
                                                                                            BusinessObjectDataKey businessObjectDataKey)

Tries to find at least one sub-partition for the specified business object data that is explicitly registered in the same storage.

Parameters:

storageEntity - the storage entity

businessObjectFormatEntity - the business object format entity

businessObjectFormat - the business object format

businessObjectDataKey - the business object data key

Returns:

the storage unit entity for the explicitly registered sub-partition - if it is found, otherwise null

getStorageUnitEntity

public StorageUnitEntity getStorageUnitEntity(String storageName,
                                              BusinessObjectDataEntity businessObjectDataEntity)

Retrieves a storage unit entity for the business object data in the specified storage and make sure it exists.

Parameters:

storageName - the storage name

businessObjectDataEntity - the business object data entity

Returns:

the storage unit entity

getStorageUnitEntityByBusinessObjectDataAndStorage

public StorageUnitEntity getStorageUnitEntityByBusinessObjectDataAndStorage(BusinessObjectDataEntity businessObjectDataEntity,
                                                                            StorageEntity storageEntity)

Retrieves a storage unit entity for the business object data in the specified storage and make sure it exists.

Parameters:

businessObjectDataEntity - the business object data entity

storageEntity - the storage entity

Returns:

the storage unit entity

getStorageUnitEntityByKey

public StorageUnitEntity getStorageUnitEntityByKey(BusinessObjectDataStorageUnitKey businessObjectDataStorageUnitKey)

Retrieves a storage unit entity for the specified business object data storage unit key and makes sure it exists.

Parameters:

businessObjectDataStorageUnitKey - the business object data storage unit key

Returns:

the storage unit entity

setStorageUnitStatus

public void setStorageUnitStatus(StorageUnitEntity storageUnitEntity,
                                 StorageUnitStatusEntity storageUnitStatusEntity)

Sets storage unit status value for a storage unit. This method also generates a storage unit status change notification event as per system configuration.

Parameters:

storageUnitEntity - the storage unit entity

storageUnitStatusEntity - the storage unit status entity

updateStorageUnitStatus

public void updateStorageUnitStatus(StorageUnitEntity storageUnitEntity,
                                    String storageUnitStatus,
                                    String reason)

Update the storage unit status.

Parameters:

storageUnitEntity - the storage unit entity

storageUnitStatus - the new storage unit status

reason - the reason for the update

updateStorageUnitStatus

public void updateStorageUnitStatus(StorageUnitEntity storageUnitEntity,
                                    StorageUnitStatusEntity storageUnitStatusEntity,
                                    String reason)

Updates storage unit status value for a storage unit. This method also updates the storage unit status history and generates a storage unit status change notification event as per system configuration.

Parameters:

storageUnitEntity - the storage unit entity

storageUnitStatusEntity - the new storage unit status entity

reason - the reason for the update

validateNoExplicitlyRegisteredSubPartitionInStorageForBusinessObjectData

public void validateNoExplicitlyRegisteredSubPartitionInStorageForBusinessObjectData(StorageEntity storageEntity,
                                                                                     BusinessObjectFormatEntity businessObjectFormatEntity,
                                                                                     BusinessObjectDataKey businessObjectDataKey,
                                                                                     String s3KeyPrefix)

Validates that there are no explicitly registered sub-partitions in storage for the business object data. This check is needed to validate that there are no storage files already registered in this storage by some other business object data that start with the same S3 key prefix.

Parameters:

storageEntity - the storage entity

businessObjectFormatEntity - the business object format entity

businessObjectDataKey - the business object data key

s3KeyPrefix - the S3 key prefix for the business object data in this storage