org.finra.herd.rest

Class UploadDownloadRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.UploadDownloadRestController

@RestController
 @RequestMapping(value="/rest",
                produces={"application/xml","application/json"})
public class UploadDownloadRestController
extends HerdBaseController

The REST controller that handles business object data REST requests.

Constructor Summary

Constructors

Constructor and Description
UploadDownloadRestController()

Method Summary

Modifier and Type	Method and Description
UploadSingleCredentialExtensionResponse	extendUploadSingleCredentials(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion) Extends the credentials for a previously initiated upload.
DownloadSingleInitiationResponse	initiateDownloadSingle(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion) Initiates a download of a single file.
DownloadBusinessObjectDataStorageFileSingleInitiationResponse	initiateDownloadSingleBusinessObjectDataStorageFile(DownloadBusinessObjectDataStorageFileSingleInitiationRequest downloadBusinessObjectDataStorageFileSingleInitiationRequest) Download a single business object data storage file
DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse	initiateDownloadSingleSampleFile(DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest downloadBusinesObjectDefinitionSingleInitiationRequest) Download a single business object definition sample file
UploadBusinessObjectDefinitionSampleDataFileInitiationResponse	initiateUploadSampleFile(UploadBusinessObjectDefinitionSampleDataFileInitiationRequest uploadBusinessObjectDefinitionSampleDataFileInitiationRequest) Provide the location and credentials prior to upload a Sample Data file
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.

Methods inherited from class org.finra.herd.rest.HerdBaseController

addPagingHttpHeaders, validateNoDuplicateQueryStringParams

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadDownloadRestController

public UploadDownloadRestController()

Method Detail

initiateUploadSingle

@RequestMapping(value="/upload/single/initiation",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_UPLOAD_POST")
public UploadSingleInitiationResponse initiateUploadSingle(@RequestBody
                                                                                                                                                                                                                                              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.

Requires WRITE permission on namespace

Parameters:

uploadSingleInitiationRequest - the information needed to initiate a file upload

Returns:

the upload single initiation response

initiateDownloadSingle

@RequestMapping(value="/download/single/initiation/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}",
                method=GET)
 @Secured(value="FN_DOWNLOAD_GET")
public DownloadSingleInitiationResponse initiateDownloadSingle(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @PathVariable(value="businessObjectFormatUsage")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              String businessObjectFormatUsage,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @PathVariable(value="businessObjectFormatFileType")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              String businessObjectFormatFileType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @PathVariable(value="businessObjectFormatVersion")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Integer businessObjectFormatVersion,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @PathVariable(value="partitionValue")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              String partitionValue,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @PathVariable(value="businessObjectDataVersion")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Integer businessObjectDataVersion)

Initiates a download of a single file.

Requires READ permission on namespace

Parameters:

namespace - the namespace.

businessObjectDefinitionName - the business object definition name.

businessObjectFormatUsage - the business object format usage.

businessObjectFormatFileType - the business object format file type.

businessObjectFormatVersion - the business object format version.

partitionValue - the partition value.

businessObjectDataVersion - the business object data version.

Returns:

the download single initiation response.

extendUploadSingleCredentials

@RequestMapping(value="/upload/single/credential/extension/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}",
                method=GET)
 @Secured(value="FN_UPLOAD_EXTEND_CREDENTIALS_GET")
public UploadSingleCredentialExtensionResponse extendUploadSingleCredentials(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     @PathVariable(value="businessObjectFormatUsage")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     String businessObjectFormatUsage,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     @PathVariable(value="businessObjectFormatFileType")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     String businessObjectFormatFileType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     @PathVariable(value="businessObjectFormatVersion")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Integer businessObjectFormatVersion,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     @PathVariable(value="partitionValue")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     String partitionValue,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     @PathVariable(value="businessObjectDataVersion")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Integer businessObjectDataVersion)

Extends the credentials for a previously initiated upload.

Requires WRITE permission on namespace

Parameters:

namespace - the namespace.

businessObjectDefinitionName - the business object definition name.

businessObjectFormatUsage - the business object format usage.

businessObjectFormatFileType - the business object format file type.

businessObjectFormatVersion - the business object format version.

partitionValue - the partition value.

businessObjectDataVersion - the business object data version.

Returns:

the extended credentials.

initiateDownloadSingleSampleFile

@RequestMapping(value="/download/businessObjectDefinitionSampleDataFile/single/initiation",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_DOWNLOAD_BUSINESS_OBJECT_DEFINITION_SAMPLE_DATA_FILE_POST")
public DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse initiateDownloadSingleSampleFile(@RequestBody
                                                                                                                                                                                                                                                                                                                                                                                         DownloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest downloadBusinesObjectDefinitionSingleInitiationRequest)

Download a single business object definition sample file

Parameters:

downloadBusinesObjectDefinitionSingleInitiationRequest -

Returns:

the download business object definition response

initiateUploadSampleFile

@RequestMapping(value="/upload/businessObjectDefinitionSampleDataFile/initiation",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_UPLOAD_BUSINESS_OBJECT_DEFINITION_SAMPLE_DATA_FILE_POST")
public UploadBusinessObjectDefinitionSampleDataFileInitiationResponse initiateUploadSampleFile(@RequestBody
                                                                                                                                                                                                                                                                                                                                                              UploadBusinessObjectDefinitionSampleDataFileInitiationRequest uploadBusinessObjectDefinitionSampleDataFileInitiationRequest)

Provide the location and credentials prior to upload a Sample Data file

Requires WRITE or WRITE_DESCRIPTIVE_CONTENT permission on namespace

Parameters:

uploadBusinessObjectDefinitionSampleDataFileInitiationRequest - request to upload

Returns:

information necessary to upload sample data file

initiateDownloadSingleBusinessObjectDataStorageFile

@RequestMapping(value="/download/businessObjectDataStorageFile/single/initiation",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_DOWNLOAD_BUSINESS_OBJECT_DATA_STORAGE_FILE_POST")
public DownloadBusinessObjectDataStorageFileSingleInitiationResponse initiateDownloadSingleBusinessObjectDataStorageFile(@RequestBody
                                                                                                                                                                                                                                                                                                                                                                                DownloadBusinessObjectDataStorageFileSingleInitiationRequest downloadBusinessObjectDataStorageFileSingleInitiationRequest)

Download a single business object data storage file

Parameters:

downloadBusinessObjectDataStorageFileSingleInitiationRequest -

Returns:

the download business object data storage file single initiation response