org.finra.herd.rest

Class StoragePlatformRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.StoragePlatformRestController

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

The REST controller that handles storage platform REST requests.

Constructor Summary

Constructors

Constructor and Description
StoragePlatformRestController()

Method Summary

Modifier and Type	Method and Description
StoragePlatform	getStoragePlatform(String name) Gets an existing storage platform by name.
StoragePlatforms	getStoragePlatforms() Gets a list of existing storage platforms.

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

StoragePlatformRestController

public StoragePlatformRestController()

Method Detail

getStoragePlatform

@RequestMapping(value="/storagePlatforms/{name}",
                method=GET)
 @Secured(value="FN_STORAGE_PLATFORMS_GET")
public StoragePlatform getStoragePlatform(@PathVariable(value="name")
                                                                                                                                                                    String name)

Gets an existing storage platform by name.

Parameters:

name - the storage platform name.

Returns:

the storage platform information.

getStoragePlatforms

@RequestMapping(value="/storagePlatforms",
                method=GET)
 @Secured(value="FN_STORAGE_PLATFORMS_ALL_GET")
public StoragePlatforms getStoragePlatforms()

Gets a list of existing storage platforms.

Returns:

the storage platforms.