org.finra.herd.service

Interface StorageUnitService

All Known Implementing Classes:

StorageUnitServiceImpl

public interface StorageUnitService

Method Summary

Modifier and Type	Method and Description
S3KeyPrefixInformation	getS3KeyPrefix(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String storageName, Boolean createNewVersion) Gets the S3 key prefix.
StorageUnitDownloadCredential	getStorageUnitDownloadCredential(BusinessObjectDataKey businessObjectDataKey, String storageName) Gets the AWS credential to download to the specified storage unit.
StorageUnitUploadCredential	getStorageUnitUploadCredential(BusinessObjectDataKey businessObjectDataKey, Boolean createNewVersion, String storageName) Gets the AWS credential to upload to the specified storage unit.

Method Detail

getStorageUnitUploadCredential

StorageUnitUploadCredential getStorageUnitUploadCredential(BusinessObjectDataKey businessObjectDataKey,
                                                           Boolean createNewVersion,
                                                           String storageName)

Gets the AWS credential to upload to the specified storage unit.

Parameters:

businessObjectDataKey - The business object data key

createNewVersion - Flag to indicate whether to return the next version or not

storageName - The storage name

Returns:

AWS credential

getStorageUnitDownloadCredential

StorageUnitDownloadCredential getStorageUnitDownloadCredential(BusinessObjectDataKey businessObjectDataKey,
                                                               String storageName)

Gets the AWS credential to download to the specified storage unit.

Parameters:

businessObjectDataKey - The business object data key

storageName - The storage name

Returns:

AWS credential

getS3KeyPrefix

S3KeyPrefixInformation getS3KeyPrefix(BusinessObjectDataKey businessObjectDataKey,
                                      String businessObjectFormatPartitionKey,
                                      String storageName,
                                      Boolean createNewVersion)

Gets the S3 key prefix. This method starts a new transaction.

Parameters:

businessObjectDataKey - the business object data key

businessObjectFormatPartitionKey - the business object format partition key

storageName - the storage name

createNewVersion - specifies if it is OK to return an S3 key prefix for a new business object data version that is not an initial version. This parameter is ignored, when the business object data version is specified.

Returns:

the retrieved business object data information