org.finra.herd.rest

Class StorageUnitRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.StorageUnitRestController

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

Constructor Summary

Constructors

Constructor and Description
StorageUnitRestController()

Method Summary

Modifier and Type	Method and Description
StorageUnitDownloadCredential	getStorageUnitDownloadCredential(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, String storageName, String subPartitionValues) Gets the AWS credential to download to the specified storage unit.
StorageUnitUploadCredential	getStorageUnitUploadCredential(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, String storageName, String subPartitionValues) Gets the AWS credential to upload to the specified storage unit.

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

StorageUnitRestController

public StorageUnitRestController()

Method Detail

getStorageUnitUploadCredential

@RequestMapping(value="/storageUnits/upload/credential/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}/storageNames/{storageName}",
                method=GET)
 @Secured(value="FN_STORAGE_UNIT_UPLOAD_CREDENTIAL_GET")
public StorageUnitUploadCredential getStorageUnitUploadCredential(@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,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @PathVariable(value="storageName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      String storageName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @RequestParam(value="subPartitionValues",required=false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      String subPartitionValues)

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

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

storageName - the storage name

subPartitionValues - the sub-partition values

Returns:

AWS credential

getStorageUnitDownloadCredential

@RequestMapping(value="/storageUnits/download/credential/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}/storageNames/{storageName}",
                method=GET)
 @Secured(value="FN_STORAGE_UNIT_DOWNLOAD_CREDENTIAL_GET")
public StorageUnitDownloadCredential getStorageUnitDownloadCredential(@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,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @PathVariable(value="storageName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              String storageName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @RequestParam(value="subPartitionValues",required=false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              String subPartitionValues)

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

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

storageName - the storage name

subPartitionValues - the sub-partition values

Returns:

AWS credential