org.finra.herd.service.impl

Class UploadDownloadServiceImpl

java.lang.Object

org.finra.herd.service.impl.UploadDownloadServiceImpl

All Implemented Interfaces:

UploadDownloadService

@Service
 @Transactional(value="herdTransactionManager")
public class UploadDownloadServiceImpl
extends Object
implements UploadDownloadService

The upload download service implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UploadDownloadServiceImpl.CompleteUploadSingleMessageResult

Constructor Summary

Constructors

Constructor and Description
UploadDownloadServiceImpl()

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 request) Returns information required to download object from S3 for business object definition sample file
UploadBusinessObjectDefinitionSampleDataFileInitiationResponse	initiateUploadSampleFile(UploadBusinessObjectDefinitionSampleDataFileInitiationRequest request) 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.
protected UploadDownloadServiceImpl.CompleteUploadSingleMessageResult	performCompleteUploadSingleMessageImpl(String objectKey) Performs the completion of upload single file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UploadDownloadServiceImpl

public UploadDownloadServiceImpl()

Method Detail

initiateUploadSingle

@PublishNotificationMessages
 @NamespacePermission(fields={"#uploadSingleInitiationRequest?.sourceBusinessObjectFormatKey?.namespace","#uploadSingleInitiationRequest?.targetBusinessObjectFormatKey?.namespace"},
                     permissions=WRITE)
public UploadSingleInitiationResponse initiateUploadSingle(UploadSingleInitiationRequest uploadSingleInitiationRequest)

Description copied from interface: UploadDownloadService

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.

Specified by:

initiateUploadSingle in interface UploadDownloadService

Parameters:

uploadSingleInitiationRequest - the information needed to initiate a file upload

Returns:

the upload single initiation response

performCompleteUploadSingleMessage

@Transactional(propagation=NOT_SUPPORTED)
public UploadDownloadServiceImpl.CompleteUploadSingleMessageResult performCompleteUploadSingleMessage(String objectKey)

Description copied from interface: UploadDownloadService

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

Specified by:

performCompleteUploadSingleMessage in interface UploadDownloadService

Parameters:

objectKey - the object key.

Returns:

CompleteUploadSingleMessageResult

performCompleteUploadSingleMessageImpl

protected UploadDownloadServiceImpl.CompleteUploadSingleMessageResult performCompleteUploadSingleMessageImpl(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

@NamespacePermission(fields="#namespace",
                     permissions=READ)
public DownloadSingleInitiationResponse initiateDownloadSingle(String namespace,
                                                                                                                                                String businessObjectDefinitionName,
                                                                                                                                                String businessObjectFormatUsage,
                                                                                                                                                String businessObjectFormatFileType,
                                                                                                                                                Integer businessObjectFormatVersion,
                                                                                                                                                String partitionValue,
                                                                                                                                                Integer businessObjectDataVersion)

Description copied from interface: UploadDownloadService

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

Specified by:

initiateDownloadSingle in interface UploadDownloadService

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

@NamespacePermission(fields="#namespace",
                     permissions=WRITE)
public UploadSingleCredentialExtensionResponse extendUploadSingleCredentials(String namespace,
                                                                                                                                                               String businessObjectDefinitionName,
                                                                                                                                                               String businessObjectFormatUsage,
                                                                                                                                                               String businessObjectFormatFileType,
                                                                                                                                                               Integer businessObjectFormatVersion,
                                                                                                                                                               String partitionValue,
                                                                                                                                                               Integer businessObjectDataVersion)

Description copied from interface: UploadDownloadService

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).

Specified by:

extendUploadSingleCredentials in interface UploadDownloadService

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

public DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse initiateDownloadSingleSampleFile(DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest request)

Description copied from interface: UploadDownloadService

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

Specified by:

initiateDownloadSingleSampleFile in interface UploadDownloadService

Parameters:

request - download request for single sample file

Returns:

download response

initiateUploadSampleFile

@NamespacePermission(fields="#request.businessObjectDefinitionKey.namespace",
                     permissions={WRITE_DESCRIPTIVE_CONTENT,WRITE})
public UploadBusinessObjectDefinitionSampleDataFileInitiationResponse initiateUploadSampleFile(UploadBusinessObjectDefinitionSampleDataFileInitiationRequest request)

Description copied from interface: UploadDownloadService

Return information required to upload file to S3

Specified by:

initiateUploadSampleFile in interface UploadDownloadService

Parameters:

request - upload request

Returns:

information required to upload

initiateDownloadSingleBusinessObjectDataStorageFile

@NamespacePermission(fields="#downloadBusinessObjectDataStorageFileSingleInitiationRequest.businessObjectDataStorageFileKey.namespace",
                     permissions=READ)
public DownloadBusinessObjectDataStorageFileSingleInitiationResponse initiateDownloadSingleBusinessObjectDataStorageFile(DownloadBusinessObjectDataStorageFileSingleInitiationRequest downloadBusinessObjectDataStorageFileSingleInitiationRequest)

Description copied from interface: UploadDownloadService

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

Specified by:

initiateDownloadSingleBusinessObjectDataStorageFile in interface UploadDownloadService

Parameters:

downloadBusinessObjectDataStorageFileSingleInitiationRequest - download request for single business object data storage file

Returns:

download business object data storage file single initiation response