org.finra.herd.dao

Interface StorageUnitDao

All Superinterfaces:

BaseJpaDao

All Known Implementing Classes:

StorageUnitDaoImpl

public interface StorageUnitDao
extends BaseJpaDao

Method Summary

Modifier and Type	Method and Description
StorageUnitEntity	getExplicitlyRegisteredSubPartition(StorageEntity storageEntity, BusinessObjectFormatEntity businessObjectFormatEntity, String partitionValue, List<String> subPartitionValues, Integer businessObjectDataVersion) Retrieves first found storage unit entity that matches specified storage and business object data alternate key values, but registered with some additional sub-partition values.
List<StorageUnitEntity>	getLatestVersionStorageUnitsByStoragePlatformAndFileType(String storagePlatform, String businessObjectFormatFileType) Retrieves a list of storage units that belong to storage of the specified storage platform type and to business object format of the specified file type.
List<StorageUnitEntity>	getS3StorageUnitsToCleanup(int maxResult) Retrieves a list of storage units that belong to S3 storage, and has a final destroy on timestamp < current time, has a DISABLED status, and associated BData has a DELETED status.
List<StorageUnitEntity>	getS3StorageUnitsToExpire(int maxResult) Retrieves a list of storage units that belong to S3 storage, have RESTORED status, and ready to be expired.
List<StorageUnitEntity>	getS3StorageUnitsToRestore(int maxResult) Retrieves a list of storage units that belong to S3 storage and have the relative S3 storage unit in RESTORING state.
StorageUnitEntity	getStorageUnitByBusinessObjectDataAndStorage(BusinessObjectDataEntity businessObjectDataEntity, StorageEntity storageEntity) Gets a storage unit identified by the given business object data entity and storage entity.
StorageUnitEntity	getStorageUnitByBusinessObjectDataAndStorageName(BusinessObjectDataEntity businessObjectDataEntity, String storageName) Gets a storage unit identified by the given business object data entity and storage name.
StorageUnitEntity	getStorageUnitByKey(BusinessObjectDataStorageUnitKey businessObjectDataStorageUnitKey) Gets a storage unit identified by the given business object data storage unit key.
StorageUnitEntity	getStorageUnitByStorageAndDirectoryPath(StorageEntity storageEntity, String directoryPath) Returns a first discovered storage unit in the specified storage that overlaps with the directory path.
List<StorageUnitAvailabilityDto>	getStorageUnitsByPartitionFilters(BusinessObjectDefinitionEntity businessObjectDefinitionEntity, String businessObjectFormatUsage, FileTypeEntity fileTypeEntity, Integer businessObjectFormatVersion, List<List<String>> partitionFilters, Integer businessObjectDataVersion, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<StorageEntity> storageEntities, StoragePlatformEntity storagePlatformEntity, StoragePlatformEntity excludedStoragePlatformEntity, boolean selectOnlyAvailableStorageUnits, XMLGregorianCalendar asOfTime) Retrieves a list of storage unit availability DTOs per specified parameters.
List<StorageUnitEntity>	getStorageUnitsByStorageAndBusinessObjectData(StorageEntity storageEntity, List<BusinessObjectDataEntity> businessObjectDataEntities) Retrieves a list of storage units that belong to the specified storage for the specified business object data.
List<StorageUnitEntity>	getStorageUnitsByStoragePlatformAndBusinessObjectData(String storagePlatform, BusinessObjectDataEntity businessObjectDataEntity) Retrieves a list of storage units that belong to storage of the specified storage platform for the specified business object data.

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

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

Method Detail

getExplicitlyRegisteredSubPartition

StorageUnitEntity getExplicitlyRegisteredSubPartition(StorageEntity storageEntity,
                                                      BusinessObjectFormatEntity businessObjectFormatEntity,
                                                      String partitionValue,
                                                      List<String> subPartitionValues,
                                                      Integer businessObjectDataVersion)

Retrieves first found storage unit entity that matches specified storage and business object data alternate key values, but registered with some additional sub-partition values. Basically, method 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

partitionValue - the business object data primary partition value

subPartitionValues - the list of business object data sub-partition values, maybe null or empty

businessObjectDataVersion - the business object data version

Returns:

the storage unit entity

getLatestVersionStorageUnitsByStoragePlatformAndFileType

List<StorageUnitEntity> getLatestVersionStorageUnitsByStoragePlatformAndFileType(String storagePlatform,
                                                                                 String businessObjectFormatFileType)

Retrieves a list of storage units that belong to storage of the specified storage platform type and to business object format of the specified file type. Only storage units that belong to the latest versions of the relative business object format and business object data are selected.

Parameters:

storagePlatform - the storage platform

businessObjectFormatFileType - the business object format file type

Returns:

the list of storage units

getS3StorageUnitsToCleanup

List<StorageUnitEntity> getS3StorageUnitsToCleanup(int maxResult)

Retrieves a list of storage units that belong to S3 storage, and has a final destroy on timestamp < current time, has a DISABLED status, and associated BData has a DELETED status. The returned list is ordered by the "finalDestroyOn" timestamp of the S3 storage units, starting with an S3 storage unit that is final destroy on the longest.

Parameters:

maxResult - the maximum number of results to retrieve

Returns:

the list of storage unit entities

getS3StorageUnitsToExpire

List<StorageUnitEntity> getS3StorageUnitsToExpire(int maxResult)

Retrieves a list of storage units that belong to S3 storage, have RESTORED status, and ready to be expired. The returned list is ordered by the "restoreExpirationOn" timestamp of the S3 storage units, starting with an S3 storage unit that is ready to be expired the longest.

Parameters:

maxResult - the maximum number of results to retrieve

Returns:

the list of storage unit entities

getS3StorageUnitsToRestore

List<StorageUnitEntity> getS3StorageUnitsToRestore(int maxResult)

Retrieves a list of storage units that belong to S3 storage and have the relative S3 storage unit in RESTORING state. The returned list is ordered by the "updated on" timestamp of the S3 storage units, starting with an S3 storage unit that has the RESTORING status the longest.

Parameters:

maxResult - the maximum number of results to retrieve

Returns:

the list of storage unit entities

getStorageUnitByBusinessObjectDataAndStorage

StorageUnitEntity getStorageUnitByBusinessObjectDataAndStorage(BusinessObjectDataEntity businessObjectDataEntity,
                                                               StorageEntity storageEntity)

Gets a storage unit identified by the given business object data entity and storage entity. Returns null if storage unit entity does not exist.

Parameters:

businessObjectDataEntity - the business object data entity

storageEntity - the storage entity

Returns:

StorageUnitEntity or null

getStorageUnitByBusinessObjectDataAndStorageName

StorageUnitEntity getStorageUnitByBusinessObjectDataAndStorageName(BusinessObjectDataEntity businessObjectDataEntity,
                                                                   String storageName)

Gets a storage unit identified by the given business object data entity and storage name. Returns null if storage unit entity does not exist.

Parameters:

businessObjectDataEntity - the business object data entity

storageName - the storage name (case-insensitive)

Returns:

StorageUnitEntity or null

getStorageUnitByKey

StorageUnitEntity getStorageUnitByKey(BusinessObjectDataStorageUnitKey businessObjectDataStorageUnitKey)

Gets a storage unit identified by the given business object data storage unit key. Returns null if storage unit does not exist.

Parameters:

businessObjectDataStorageUnitKey - the business object data storage unit key

Returns:

StorageUnitEntity or null

getStorageUnitByStorageAndDirectoryPath

StorageUnitEntity getStorageUnitByStorageAndDirectoryPath(StorageEntity storageEntity,
                                                          String directoryPath)

Returns a first discovered storage unit in the specified storage that overlaps with the directory path.

Parameters:

storageEntity - the storage entity

directoryPath - the directory path

Returns:

the first found storage unit in the specified storage that overlaps with the directory path or null if none were found

getStorageUnitsByPartitionFilters

List<StorageUnitAvailabilityDto> getStorageUnitsByPartitionFilters(BusinessObjectDefinitionEntity businessObjectDefinitionEntity,
                                                                   String businessObjectFormatUsage,
                                                                   FileTypeEntity fileTypeEntity,
                                                                   Integer businessObjectFormatVersion,
                                                                   List<List<String>> partitionFilters,
                                                                   Integer businessObjectDataVersion,
                                                                   BusinessObjectDataStatusEntity businessObjectDataStatusEntity,
                                                                   List<StorageEntity> storageEntities,
                                                                   StoragePlatformEntity storagePlatformEntity,
                                                                   StoragePlatformEntity excludedStoragePlatformEntity,
                                                                   boolean selectOnlyAvailableStorageUnits,
                                                                   XMLGregorianCalendar asOfTime)

Retrieves a list of storage unit availability DTOs per specified parameters.

Parameters:

businessObjectDefinitionEntity - the business object definition entity

businessObjectFormatUsage - the business object format usage (case-insensitive)

fileTypeEntity - the file type entity

businessObjectFormatVersion - the optional business object format version. If a business object format version isn't specified, the latest available format version for each partition value will be used

partitionFilters - the list of partition filter to be used to select business object data instances. Each partition filter contains a list of primary and sub-partition values in the right order up to the maximum partition levels allowed by business object data registration - with partition values for the relative partitions not to be used for selection passed as nulls.

businessObjectDataVersion - the business object data version. If a business object data version isn't specified, the latest data version based on the specified business object data status is returned.

businessObjectDataStatusEntity - the optional business object data status entity. This parameter is ignored when the business object data version is specified. When business object data version and business object data status both are not specified, the latest data version for each set of partition values will be used regardless of the status

storageEntities - the optional list of storage entities where business object data storage units should be looked for

storagePlatformEntity - the optional storage platform entity, e.g. S3 for Hive DDL. It is ignored when the list of storage entities is not empty

excludedStoragePlatformEntity - the optional storage platform entity to be excluded from search. It is ignored when the list of storage entities is not empty or the storage platform entity is specified

selectOnlyAvailableStorageUnits - specifies if only available storage units will be selected or any storage units regardless of their status

asOfTime - specifies the date and time when the business object status was effective at that time

Returns:

the list of storage unit availability DTOs sorted by partition values and storage names

getStorageUnitsByStorageAndBusinessObjectData

List<StorageUnitEntity> getStorageUnitsByStorageAndBusinessObjectData(StorageEntity storageEntity,
                                                                      List<BusinessObjectDataEntity> businessObjectDataEntities)

Retrieves a list of storage units that belong to the specified storage for the specified business object data.

Parameters:

storageEntity - the storage entity

businessObjectDataEntities - the list of business object data entities

Returns:

the list of storage unit entities

getStorageUnitsByStoragePlatformAndBusinessObjectData

List<StorageUnitEntity> getStorageUnitsByStoragePlatformAndBusinessObjectData(String storagePlatform,
                                                                              BusinessObjectDataEntity businessObjectDataEntity)

Retrieves a list of storage units that belong to storage of the specified storage platform for the specified business object data.

Parameters:

storagePlatform - the storage platform

businessObjectDataEntity - the business object data entity

Returns:

the list of storage unit entities