Uses of Class
org.finra.herd.model.jpa.StorageEntity

Packages that use StorageEntity

Package	Description
org.finra.herd.dao
org.finra.herd.dao.impl
org.finra.herd.model.jpa
org.finra.herd.service.helper

Uses of StorageEntity in org.finra.herd.dao

Methods in org.finra.herd.dao that return StorageEntity

Modifier and Type	Method and Description
StorageEntity	StorageDao.getStorageByName(String storageName) Gets a storage by its name.

Methods in org.finra.herd.dao with parameters of type StorageEntity

Modifier and Type	Method and Description
List<BusinessObjectDataEntity>	BusinessObjectDataDao.getBusinessObjectDataFromStorageOlderThan(StorageEntity storageEntity, int thresholdMinutes, List<String> businessObjectDataStatuses) Selects business object data having storage files associated with the specified storage and status.
StorageUnitEntity	StorageUnitDao.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.
StorageUnitEntity	StorageUnitDao.getStorageUnitByBusinessObjectDataAndStorage(BusinessObjectDataEntity businessObjectDataEntity, StorageEntity storageEntity) Gets a storage unit identified by the given business object data entity and storage entity.
StorageUnitEntity	StorageUnitDao.getStorageUnitByStorageAndDirectoryPath(StorageEntity storageEntity, String directoryPath) Returns a first discovered storage unit in the specified storage that overlaps with the directory path.
List<StorageUnitEntity>	StorageUnitDao.getStorageUnitsByStorageAndBusinessObjectData(StorageEntity storageEntity, List<BusinessObjectDataEntity> businessObjectDataEntities) Retrieves a list of storage units that belong to the specified storage for the specified business object data.

Method parameters in org.finra.herd.dao with type arguments of type StorageEntity

Modifier and Type	Method and Description
String	BusinessObjectDataDao.getBusinessObjectDataMaxPartitionValue(int partitionColumnPosition, BusinessObjectFormatKey businessObjectFormatKey, Integer businessObjectDataVersion, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<StorageEntity> storageEntities, StoragePlatformEntity storagePlatformEntity, StoragePlatformEntity excludedStoragePlatformEntity, String upperBoundPartitionValue, String lowerBoundPartitionValue) Retrieves a maximum available partition value per specified parameters.
String	BusinessObjectDataDao.getBusinessObjectDataMinPartitionValue(int partitionColumnPosition, BusinessObjectFormatKey businessObjectFormatKey, Integer businessObjectDataVersion, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<StorageEntity> storageEntities, StoragePlatformEntity storagePlatformEntity, StoragePlatformEntity excludedStoragePlatformEntity) Retrieves a minimum available partition value per specified parameters.
List<StorageUnitAvailabilityDto>	StorageUnitDao.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.

Uses of StorageEntity in org.finra.herd.dao.impl

Methods in org.finra.herd.dao.impl that return StorageEntity

Modifier and Type	Method and Description
StorageEntity	StorageDaoImpl.getStorageByName(String storageName)

Methods in org.finra.herd.dao.impl with parameters of type StorageEntity

Modifier and Type	Method and Description
List<BusinessObjectDataEntity>	BusinessObjectDataDaoImpl.getBusinessObjectDataFromStorageOlderThan(StorageEntity storageEntity, int thresholdMinutes, List<String> businessObjectDataStatuses)
StorageUnitEntity	StorageUnitDaoImpl.getExplicitlyRegisteredSubPartition(StorageEntity storageEntity, BusinessObjectFormatEntity businessObjectFormatEntity, String partitionValue, List<String> subPartitionValues, Integer businessObjectDataVersion)
StorageUnitEntity	StorageUnitDaoImpl.getStorageUnitByBusinessObjectDataAndStorage(BusinessObjectDataEntity businessObjectDataEntity, StorageEntity storageEntity)
StorageUnitEntity	StorageUnitDaoImpl.getStorageUnitByStorageAndDirectoryPath(StorageEntity storageEntity, String directoryPath)
List<StorageUnitEntity>	StorageUnitDaoImpl.getStorageUnitsByStorageAndBusinessObjectData(StorageEntity storageEntity, List<BusinessObjectDataEntity> businessObjectDataEntities)

Method parameters in org.finra.herd.dao.impl with type arguments of type StorageEntity

Modifier and Type	Method and Description
String	BusinessObjectDataDaoImpl.getBusinessObjectDataMaxPartitionValue(int partitionColumnPosition, BusinessObjectFormatKey businessObjectFormatKey, Integer businessObjectDataVersion, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<StorageEntity> storageEntities, StoragePlatformEntity storagePlatformEntity, StoragePlatformEntity excludedStoragePlatformEntity, String upperBoundPartitionValue, String lowerBoundPartitionValue)
String	BusinessObjectDataDaoImpl.getBusinessObjectDataMinPartitionValue(int partitionColumnPosition, BusinessObjectFormatKey businessObjectFormatKey, Integer businessObjectDataVersion, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<StorageEntity> storageEntities, StoragePlatformEntity storagePlatformEntity, StoragePlatformEntity excludedStoragePlatformEntity)
protected javax.persistence.criteria.Predicate	AbstractHerdDao.getQueryRestrictionOnStorage(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,StorageEntity> storageEntityFrom, List<StorageEntity> storageEntities, StoragePlatformEntity storagePlatformEntity, StoragePlatformEntity excludedStoragePlatformEntity) Builds a query restriction predicate for the storage.
protected javax.persistence.criteria.Predicate	AbstractHerdDao.getQueryRestrictionOnStorage(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,StorageEntity> storageEntityFrom, List<StorageEntity> storageEntities, StoragePlatformEntity storagePlatformEntity, StoragePlatformEntity excludedStoragePlatformEntity) Builds a query restriction predicate for the storage.
List<StorageUnitAvailabilityDto>	StorageUnitDaoImpl.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)

Uses of StorageEntity in org.finra.herd.model.jpa

Fields in org.finra.herd.model.jpa with type parameters of type StorageEntity

Modifier and Type	Field and Description
static javax.persistence.metamodel.CollectionAttribute<StorageEntity,StorageAttributeEntity>	StorageEntity_.attributes
static javax.persistence.metamodel.SingularAttribute<StorageEntity,String>	StorageEntity_.name
static javax.persistence.metamodel.SingularAttribute<StorageUnitNotificationRegistrationEntity,StorageEntity>	StorageUnitNotificationRegistrationEntity_.storage
static javax.persistence.metamodel.SingularAttribute<BusinessObjectDefinitionSampleDataFileEntity,StorageEntity>	BusinessObjectDefinitionSampleDataFileEntity_.storage
static javax.persistence.metamodel.SingularAttribute<StorageUnitEntity,StorageEntity>	StorageUnitEntity_.storage
static javax.persistence.metamodel.SingularAttribute<StorageAttributeEntity,StorageEntity>	StorageAttributeEntity_.storage
static javax.persistence.metamodel.SingularAttribute<BusinessObjectDataNotificationRegistrationEntity,StorageEntity>	BusinessObjectDataNotificationRegistrationEntity_.storage
static javax.persistence.metamodel.SingularAttribute<StoragePolicyEntity,StorageEntity>	StoragePolicyEntity_.storage
static javax.persistence.metamodel.SingularAttribute<StorageEntity,StoragePlatformEntity>	StorageEntity_.storagePlatform
static javax.persistence.metamodel.SingularAttribute<StorageEntity,String>	StorageEntity_.storagePlatformCode

Methods in org.finra.herd.model.jpa that return StorageEntity

Modifier and Type	Method and Description
StorageEntity	BusinessObjectDataNotificationRegistrationEntity.getStorage()
StorageEntity	StorageUnitNotificationRegistrationEntity.getStorage()
StorageEntity	StoragePolicyEntity.getStorage()
StorageEntity	StorageAttributeEntity.getStorage()
StorageEntity	BusinessObjectDefinitionSampleDataFileEntity.getStorage()
StorageEntity	StorageUnitEntity.getStorage()

Methods in org.finra.herd.model.jpa with parameters of type StorageEntity

Modifier and Type	Method and Description
void	BusinessObjectDataNotificationRegistrationEntity.setStorage(StorageEntity storage)
void	StorageUnitNotificationRegistrationEntity.setStorage(StorageEntity storage)
void	StoragePolicyEntity.setStorage(StorageEntity storage)
void	StorageAttributeEntity.setStorage(StorageEntity storage)
void	BusinessObjectDefinitionSampleDataFileEntity.setStorage(StorageEntity storage)
void	StorageUnitEntity.setStorage(StorageEntity storage)

Uses of StorageEntity in org.finra.herd.service.helper

Methods in org.finra.herd.service.helper that return StorageEntity

Modifier and Type	Method and Description
StorageEntity	StorageDaoHelper.getStorageEntity(StorageKey storageKey) Gets a storage entity by storage key and makes sure that it exists.
StorageEntity	StorageDaoHelper.getStorageEntity(String storageName) Gets a storage entity based on the storage name and makes sure that it exists.

Methods in org.finra.herd.service.helper with parameters of type StorageEntity

Modifier and Type	Method and Description
String	S3KeyPrefixHelper.buildS3KeyPrefix(StorageEntity storageEntity, BusinessObjectDefinitionKey businessObjectDefinitionKey) Build S3 key prefix for business object definition key
String	S3KeyPrefixHelper.buildS3KeyPrefix(StorageEntity storageEntity, BusinessObjectFormatEntity businessObjectFormatEntity, BusinessObjectDataKey businessObjectDataKey) Returns the S3 object key prefix based on the given storage, business object format and business object data key.
BusinessObjectDataCreateRequest	BusinessObjectDataHelper.createBusinessObjectDataCreateRequest(BusinessObjectFormatEntity businessObjectFormatEntity, String uuid, String businessObjectDataStatus, List<Attribute> attributes, StorageEntity storageEntity, String storageDirectoryPath, String storageFilePath, Long storageFileSizeBytes, Long storageFileRowCount) Validates the upload single initiation request.
StorageUnitEntity	BusinessObjectDataDaoHelper.createStorageUnitEntity(BusinessObjectDataEntity businessObjectDataEntity, StorageEntity storageEntity, StorageDirectory storageDirectory, List<StorageFile> storageFiles, Boolean isDiscoverStorageFiles, Boolean isUseFullFilePath) Creates a storage unit entity per specified parameters.
StorageUnitEntity	StorageUnitDaoHelper.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.
boolean	StorageHelper.getBooleanStorageAttributeValueByName(String attributeName, StorageEntity storageEntity, boolean attributeRequired, boolean attributeValueRequiredIfExists) Gets attribute value by name from the storage entity and returns it as a boolean.
S3FileTransferRequestParamsDto	StorageHelper.getS3BucketAccessParams(StorageEntity storageEntity) Returns a new instance of S3FileTransferRequestParamsDto populated with all parameters, required to access an S3 bucket.
Integer	StorageHelper.getStorageAttributeIntegerValueByName(String attributeName, StorageEntity storageEntity, boolean attributeRequired, boolean attributeValueRequiredIfExists) Gets a storage attribute value by name.
Integer	StorageHelper.getStorageAttributeIntegerValueByName(String attributeName, StorageEntity storageEntity, Integer defaultValue) Gets a storage attribute value by name.
String	StorageHelper.getStorageAttributeValueByName(String attributeName, StorageEntity storageEntity, boolean attributeValueRequired) Gets attribute value by name from the storage entity while specifying whether the attribute value is required (i.e.
String	StorageHelper.getStorageAttributeValueByName(String attributeName, StorageEntity storageEntity, boolean attributeRequired, boolean attributeValueRequiredIfExists) Gets attribute value by name from the storage entity while specifying whether the attribute is required and whether the attribute value is required.
String	StorageHelper.getStorageBucketName(StorageEntity storageEntity) Gets the storage's bucket name.
String	StorageHelper.getStorageKmsKeyId(StorageEntity storageEntity) Gets the storage's KMS key ID.
StorageUnitEntity	StorageUnitDaoHelper.getStorageUnitEntityByBusinessObjectDataAndStorage(BusinessObjectDataEntity businessObjectDataEntity, StorageEntity storageEntity) Retrieves a storage unit entity for the business object data in the specified storage and make sure it exists.
void	StorageUnitDaoHelper.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.
void	StoragePolicyDaoHelper.validateStoragePolicyFilterStorage(StorageEntity storageEntity) Validates the storage policy filter storage.

Method parameters in org.finra.herd.service.helper with type arguments of type StorageEntity

Modifier and Type	Method and Description
protected org.finra.herd.service.helper.BusinessObjectDataDdlPartitionsHelper.GenerateDdlRequestWrapper	BusinessObjectDataDdlPartitionsHelper.buildGenerateDdlPartitionsWrapper(BusinessObjectDataDdlRequest request, BusinessObjectFormatEntity businessObjectFormatEntity, CustomDdlEntity customDdlEntity, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<String> storageNames, List<StorageEntity> requestedStorageEntities, Map<String,StorageEntity> cachedStorageEntities, Map<String,String> cachedS3BucketNames) Generates the create table Hive 13 DDL as per specified business object data DDL request.
protected org.finra.herd.service.helper.BusinessObjectDataDdlPartitionsHelper.GenerateDdlRequestWrapper	BusinessObjectDataDdlPartitionsHelper.buildGenerateDdlPartitionsWrapper(BusinessObjectDataDdlRequest request, BusinessObjectFormatEntity businessObjectFormatEntity, CustomDdlEntity customDdlEntity, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<String> storageNames, List<StorageEntity> requestedStorageEntities, Map<String,StorageEntity> cachedStorageEntities, Map<String,String> cachedS3BucketNames) Generates the create table Hive 13 DDL as per specified business object data DDL request.
List<List<String>>	BusinessObjectDataDaoHelper.buildPartitionFilters(List<PartitionValueFilter> partitionValueFilters, PartitionValueFilter standalonePartitionValueFilter, BusinessObjectFormatKey businessObjectFormatKey, Integer businessObjectDataVersion, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<StorageEntity> storageEntities, StoragePlatformEntity storagePlatformEntity, StoragePlatformEntity excludedStoragePlatformEntity, BusinessObjectFormatEntity businessObjectFormatEntity) Build partition filters based on the specified partition value filters.
abstract String	DdlGenerator.generateCreateTableDdl(BusinessObjectDataDdlRequest request, BusinessObjectFormatEntity businessObjectFormatEntity, CustomDdlEntity customDdlEntity, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<String> storageNames, List<StorageEntity> requestedStorageEntities, Map<String,StorageEntity> cachedStorageEntities, Map<String,String> cachedS3BucketNames) This method generates the create table DDL as per specified business object data DDL request.
abstract String	DdlGenerator.generateCreateTableDdl(BusinessObjectDataDdlRequest request, BusinessObjectFormatEntity businessObjectFormatEntity, CustomDdlEntity customDdlEntity, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<String> storageNames, List<StorageEntity> requestedStorageEntities, Map<String,StorageEntity> cachedStorageEntities, Map<String,String> cachedS3BucketNames) This method generates the create table DDL as per specified business object data DDL request.
String	Hive13DdlGenerator.generateCreateTableDdl(BusinessObjectDataDdlRequest request, BusinessObjectFormatEntity businessObjectFormatEntity, CustomDdlEntity customDdlEntity, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<String> storageNames, List<StorageEntity> requestedStorageEntities, Map<String,StorageEntity> cachedStorageEntities, Map<String,String> cachedS3BucketNames) Generates the create table Hive 13 DDL as per specified business object data DDL request.
String	Hive13DdlGenerator.generateCreateTableDdl(BusinessObjectDataDdlRequest request, BusinessObjectFormatEntity businessObjectFormatEntity, CustomDdlEntity customDdlEntity, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<String> storageNames, List<StorageEntity> requestedStorageEntities, Map<String,StorageEntity> cachedStorageEntities, Map<String,String> cachedS3BucketNames) Generates the create table Hive 13 DDL as per specified business object data DDL request.
List<Partition>	BusinessObjectDataPartitionsHelper.generatePartitions(BusinessObjectDataDdlRequest request, BusinessObjectFormatEntity businessObjectFormatEntity, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<String> storageNames, List<StorageEntity> requestedStorageEntities, Map<String,StorageEntity> cachedStorageEntities, Map<String,String> cachedS3BucketNames) Generates the partitions information as per specified business object data partitions request.
List<Partition>	BusinessObjectDataPartitionsHelper.generatePartitions(BusinessObjectDataDdlRequest request, BusinessObjectFormatEntity businessObjectFormatEntity, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<String> storageNames, List<StorageEntity> requestedStorageEntities, Map<String,StorageEntity> cachedStorageEntities, Map<String,String> cachedS3BucketNames) Generates the partitions information as per specified business object data partitions request.
List<String>	BusinessObjectDataDaoHelper.getPartitionValues(PartitionValueFilter partitionValueFilter, String partitionKey, int partitionColumnPosition, BusinessObjectFormatKey businessObjectFormatKey, Integer businessObjectDataVersion, BusinessObjectDataStatusEntity businessObjectDataStatusEntity, List<StorageEntity> storageEntities, StoragePlatformEntity storagePlatformEntity, StoragePlatformEntity excludedStoragePlatformEntity, BusinessObjectFormatEntity businessObjectFormatEntity) Builds a list of partition values from the partition value filter.
protected void	BusinessObjectDataDdlPartitionsHelper.notAllowNonAvailableRegisteredSubPartitions(BusinessObjectDefinitionEntity businessObjectDefinitionEntity, String businessObjectFormatUsage, FileTypeEntity fileTypeEntity, Integer businessObjectFormatVersion, List<List<String>> matchedAvailablePartitionFilters, List<List<String>> availablePartitions, List<String> storageNames, List<StorageEntity> storageEntities, StoragePlatformEntity s3StoragePlatformEntity) Searches for and fails on any of "non-available" registered sub-partitions as per list of "matched" partition filters.