org.finra.herd.service.helper

Class StorageFileDaoHelper

java.lang.Object

org.finra.herd.service.helper.StorageFileDaoHelper

@Component
public class StorageFileDaoHelper
extends Object

Helper for storage file related operations which require DAO.

Constructor Summary

Constructors

Constructor and Description
StorageFileDaoHelper()

Method Summary

Modifier and Type	Method and Description
List<StorageFileEntity>	createStorageFileEntitiesFromStorageFiles(StorageUnitEntity storageUnitEntity, List<StorageFile> storageFiles) Creates storage file entities from the list of storage files.
StorageFileEntity	getStorageFileEntity(StorageUnitEntity storageUnitEntity, String filePath, BusinessObjectDataKey businessObjectDataKey) Retrieves storage file by storage unit entity and file path.
StorageFileEntity	getStorageFileEntity(String storageName, String filePath) Retrieves storage file by storage name and file path.
void	validateStorageFilesCount(String storageName, BusinessObjectDataKey businessObjectDataKey, String s3KeyPrefix, int expectedStorageFilesCount) Validates that storage does not have any other registered storage files that start with the specified S3 key prefix, but belong to some other business object data instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageFileDaoHelper

public StorageFileDaoHelper()

Method Detail

createStorageFileEntitiesFromStorageFiles

public List<StorageFileEntity> createStorageFileEntitiesFromStorageFiles(StorageUnitEntity storageUnitEntity,
                                                                         List<StorageFile> storageFiles)

Creates storage file entities from the list of storage files.

Parameters:

storageUnitEntity - the storage unit entity

storageFiles - the list of storage files

Returns:

the list storage file entities

getStorageFileEntity

public StorageFileEntity getStorageFileEntity(String storageName,
                                              String filePath)
                                       throws ObjectNotFoundException,
                                              IllegalArgumentException

Retrieves storage file by storage name and file path.

Parameters:

storageName - the storage name

filePath - the file path

Returns:

the storage file

Throws:

ObjectNotFoundException - if the storage file doesn't exist

IllegalArgumentException - if more than one storage file matching the file path exist in the storage

getStorageFileEntity

public StorageFileEntity getStorageFileEntity(StorageUnitEntity storageUnitEntity,
                                              String filePath,
                                              BusinessObjectDataKey businessObjectDataKey)
                                       throws ObjectNotFoundException,
                                              IllegalArgumentException

Retrieves storage file by storage unit entity and file path.

Parameters:

storageUnitEntity - the storage unit entity

filePath - the file path

businessObjectDataKey - the business object data key

Returns:

the storage file entity

Throws:

ObjectNotFoundException - if the storage file doesn't exist

IllegalArgumentException - if more than one storage file matching the file path exist in the storage

validateStorageFilesCount

public void validateStorageFilesCount(String storageName,
                                      BusinessObjectDataKey businessObjectDataKey,
                                      String s3KeyPrefix,
                                      int expectedStorageFilesCount)

Validates that storage does not have any other registered storage files that start with the specified S3 key prefix, but belong to some other business object data instances.

Parameters:

storageName - the storage name

businessObjectDataKey - the business object data key

s3KeyPrefix - the S3 key prefix

expectedStorageFilesCount - the expected number of storage files that match the specified S3 key prefix in the storage