org.finra.herd.service

Interface UploadDownloadService

All Known Implementing Classes:

UploadDownloadServiceImpl

public interface UploadDownloadService

The upload download service.

Method Summary

Modifier and Type	Method and Description
UploadSingleCredentialExtensionResponse	extendUploadSingleCredentials(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion) Returns extended credentials for an existing upload.
DownloadSingleInitiationResponse	initiateDownloadSingle(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion) Returns information required to download object from S3 for the object registered against the given parameters.
DownloadBusinessObjectDataStorageFileSingleInitiationResponse	initiateDownloadSingleBusinessObjectDataStorageFile(DownloadBusinessObjectDataStorageFileSingleInitiationRequest downloadBusinessObjectDataStorageFileSingleInitiationRequest) Returns information required to download object from S3 for business object data storage file
DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse	initiateDownloadSingleSampleFile(DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest downloadRequest) Returns information required to download object from S3 for business object definition sample file
UploadBusinessObjectDefinitionSampleDataFileInitiationResponse	initiateUploadSampleFile(UploadBusinessObjectDefinitionSampleDataFileInitiationRequest uploadBusinessObjectDefinitionSampleDataFileInitiationRequest) Return information required to upload file to S3
UploadSingleInitiationResponse	initiateUploadSingle(UploadSingleInitiationRequest uploadSingleInitiationRequest) Initiates a single file upload capability by creating the relative business object data instance in UPLOADING state and allowing write access to a specific location in S3_MANAGED_LOADING_DOCK storage.
UploadDownloadServiceImpl.CompleteUploadSingleMessageResult	performCompleteUploadSingleMessage(String objectKey) Performs the completion of upload single file.

Method Detail

initiateUploadSingle

UploadSingleInitiationResponse initiateUploadSingle(UploadSingleInitiationRequest uploadSingleInitiationRequest)

Initiates a single file upload capability by creating the relative business object data instance in UPLOADING state and allowing write access to a specific location in S3_MANAGED_LOADING_DOCK storage.

Parameters:

uploadSingleInitiationRequest - the information needed to initiate a file upload

Returns:

the upload single initiation response

performCompleteUploadSingleMessage

UploadDownloadServiceImpl.CompleteUploadSingleMessageResult performCompleteUploadSingleMessage(String objectKey)

Performs the completion of upload single file. Runs in new transaction and logs the error if an error occurs.

Parameters:

objectKey - the object key.

Returns:

CompleteUploadSingleMessageResult

initiateDownloadSingle

DownloadSingleInitiationResponse initiateDownloadSingle(String namespace,
                                                        String businessObjectDefinitionName,
                                                        String businessObjectFormatUsage,
                                                        String businessObjectFormatFileType,
                                                        Integer businessObjectFormatVersion,
                                                        String partitionValue,
                                                        Integer businessObjectDataVersion)

Returns information required to download object from S3 for the object registered against the given parameters.

Parameters:

namespace - - business object definition namespace

businessObjectDefinitionName - - business object definition name

businessObjectFormatUsage - - business object format usage code

businessObjectFormatFileType - - business object format file type

businessObjectFormatVersion - - business object format version

partitionValue - - business object data partition value

businessObjectDataVersion - - business object data version

Returns:

DownloadSingleInitiationResponse

extendUploadSingleCredentials

UploadSingleCredentialExtensionResponse extendUploadSingleCredentials(String namespace,
                                                                      String businessObjectDefinitionName,
                                                                      String businessObjectFormatUsage,
                                                                      String businessObjectFormatFileType,
                                                                      Integer businessObjectFormatVersion,
                                                                      String partitionValue,
                                                                      Integer businessObjectDataVersion)

Returns extended credentials for an existing upload. This is needed because the temporary STS credentials that were returned in the initiateUploadSingle method can be no longer than what STS allows (> 15 minutes and < 60 minutes).

Parameters:

namespace - - business object definition namespace

businessObjectDefinitionName - - business object definition name

businessObjectFormatUsage - - business object format usage code

businessObjectFormatFileType - - business object format file type

businessObjectFormatVersion - - business object format version

partitionValue - - business object data partition value

businessObjectDataVersion - - business object data version

Returns:

UploadSingleCredentialExtensionResponse

initiateDownloadSingleSampleFile

DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse initiateDownloadSingleSampleFile(DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest downloadRequest)

Returns information required to download object from S3 for business object definition sample file

Parameters:

downloadRequest - download request for single sample file

Returns:

download response

initiateUploadSampleFile

UploadBusinessObjectDefinitionSampleDataFileInitiationResponse initiateUploadSampleFile(UploadBusinessObjectDefinitionSampleDataFileInitiationRequest uploadBusinessObjectDefinitionSampleDataFileInitiationRequest)

Return information required to upload file to S3

Parameters:

uploadBusinessObjectDefinitionSampleDataFileInitiationRequest - upload request

Returns:

information required to upload

initiateDownloadSingleBusinessObjectDataStorageFile

DownloadBusinessObjectDataStorageFileSingleInitiationResponse initiateDownloadSingleBusinessObjectDataStorageFile(DownloadBusinessObjectDataStorageFileSingleInitiationRequest downloadBusinessObjectDataStorageFileSingleInitiationRequest)

Returns information required to download object from S3 for business object data storage file

Parameters:

downloadBusinessObjectDataStorageFileSingleInitiationRequest - download request for single business object data storage file

Returns:

download business object data storage file single initiation response