org.finra.herd.dao

Interface StorageFileDao

All Superinterfaces:

BaseJpaDao

All Known Implementing Classes:

StorageFileDaoImpl

public interface StorageFileDao
extends BaseJpaDao

Method Summary

Modifier and Type	Method and Description
StorageFileEntity	getStorageFileByStorageNameAndFilePath(String storageName, String filePath) Retrieves storage file by storage name and file path.
StorageFileEntity	getStorageFileByStorageUnitEntityAndFilePath(StorageUnitEntity storageUnitEntity, String filePath) Retrieves storage file by storage unit entity and file path.
Long	getStorageFileCount(String storageName, String filePathPrefix) Counts all storage files matching the file path prefix in the specified storage.
org.apache.commons.collections4.MultiValuedMap<Integer,String>	getStorageFilePathsByStorageUnitIds(List<Integer> storageUnitIds) Retrieves a map of storage unit ids to their corresponding storage file paths.
List<String>	getStorageFilesByStorageAndFilePathPrefix(String storageName, String filePathPrefix) Retrieves a sorted list of storage file paths matching S3 key prefix in the specified storage.

Methods inherited from interface org.finra.herd.dao.BaseJpaDao

delete, detach, findAll, findById, findByNamedProperties, findUniqueByNamedProperties, getCurrentTimestamp, getEntityManager, query, queryByNamedParams, save, saveAndRefresh

Method Detail

getStorageFileByStorageNameAndFilePath

StorageFileEntity getStorageFileByStorageNameAndFilePath(String storageName,
                                                         String filePath)

Retrieves storage file by storage name and file path.

Parameters:

storageName - the storage name (case-insensitive)

filePath - the file path

Returns:

the storage file

getStorageFileByStorageUnitEntityAndFilePath

StorageFileEntity getStorageFileByStorageUnitEntityAndFilePath(StorageUnitEntity storageUnitEntity,
                                                               String filePath)

Retrieves storage file by storage unit entity and file path.

Parameters:

storageUnitEntity - the storage unit entity

filePath - the file path

Returns:

the storage file

getStorageFileCount

Long getStorageFileCount(String storageName,
                         String filePathPrefix)

Counts all storage files matching the file path prefix in the specified storage.

Parameters:

storageName - the storage name (case-insensitive)

filePathPrefix - the file path prefix that file paths should match

Returns:

the storage file count

getStorageFilePathsByStorageUnitIds

org.apache.commons.collections4.MultiValuedMap<Integer,String> getStorageFilePathsByStorageUnitIds(List<Integer> storageUnitIds)

Retrieves a map of storage unit ids to their corresponding storage file paths.

Parameters:

storageUnitIds - the list of storage unit identifiers

Returns:

the map of storage unit ids to their corresponding storage file paths.

getStorageFilesByStorageAndFilePathPrefix

List<String> getStorageFilesByStorageAndFilePathPrefix(String storageName,
                                                       String filePathPrefix)

Retrieves a sorted list of storage file paths matching S3 key prefix in the specified storage.

Parameters:

storageName - the storage name (case-insensitive)

filePathPrefix - the file path prefix that file paths should match

Returns:

the list of storage file paths