org.finra.herd.rest

Class StorageRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.StorageRestController

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

The REST controller that handles storage REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	STORAGES_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
StorageRestController()

Method Summary

Modifier and Type	Method and Description
Storage	createStorage(StorageCreateRequest request) Creates a new storage.
Storage	deleteStorage(String storageName) Deletes an existing storage by name.
Storage	getStorage(String storageName) Gets an existing storage by name.
StorageKeys	getStorages() Gets a list of namespace keys for all namespaces defined in the system.
Storage	updateStorage(String storageName, StorageUpdateRequest request) Updates an existing storage.

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

getList, validateNoDuplicateQueryStringParams

Methods inherited from class java.lang.Object

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

Field Detail

STORAGES_URI_PREFIX

public static final String STORAGES_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

StorageRestController

public StorageRestController()

Method Detail

createStorage

@RequestMapping(value="/storages",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_STORAGES_POST")
public Storage createStorage(@RequestBody
                                                                                                                                                                                                  StorageCreateRequest request)

Creates a new storage.

Parameters:

request - the information needed to create the storage

Returns:

the created storage information

updateStorage

@RequestMapping(value="/storages/{storageName}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_STORAGES_PUT")
public Storage updateStorage(@PathVariable(value="storageName")
                                                                                                                                                                                                              String storageName,
                                                                                                                                                                                                              @RequestBody
                                                                                                                                                                                                              StorageUpdateRequest request)

Updates an existing storage.

Parameters:

storageName - the name of the storage to update

request - the information needed to update the storage

Returns:

the updated storage information

getStorage

@RequestMapping(value="/storages/{storageName}",
                method=GET)
 @Secured(value="FN_STORAGES_GET")
public Storage getStorage(@PathVariable(value="storageName")
                                                                                                                                          String storageName)

Gets an existing storage by name.

Parameters:

storageName - the storage name

Returns:

the storage information

deleteStorage

@RequestMapping(value="/storages/{storageName}",
                method=DELETE)
 @Secured(value="FN_STORAGES_DELETE")
public Storage deleteStorage(@PathVariable(value="storageName")
                                                                                                                                                   String storageName)

Deletes an existing storage by name.

Parameters:

storageName - the storage name

Returns:

the storage information of the storage that got deleted

getStorages

@RequestMapping(value="/storages",
                method=GET)
 @Secured(value="FN_STORAGES_ALL_GET")
public StorageKeys getStorages()

Gets a list of namespace keys for all namespaces defined in the system.

Returns:

the list of namespace keys