org.finra.herd.rest

Class StoragePolicyRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.StoragePolicyRestController

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

The REST controller that handles storage policy REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	STORAGE_POLICIES_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
StoragePolicyRestController()

Method Summary

Modifier and Type	Method and Description
StoragePolicy	createStoragePolicy(StoragePolicyCreateRequest request) Creates a new storage policy.
StoragePolicy	getStoragePolicy(String namespace, String storagePolicyName) Gets an existing storage policy by key.
StoragePolicy	updateStoragePolicy(String namespace, String storagePolicyName, StoragePolicyUpdateRequest request) Updates an existing storage policy by key.

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

Field Detail

STORAGE_POLICIES_URI_PREFIX

public static final String STORAGE_POLICIES_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

StoragePolicyRestController

public StoragePolicyRestController()

Method Detail

createStoragePolicy

@RequestMapping(value="/storagePolicies",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_STORAGE_POLICIES_POST")
public StoragePolicy createStoragePolicy(@RequestBody
                                                                                                                                                                                                                             StoragePolicyCreateRequest request)

Creates a new storage policy.

Requires WRITE permission on storage policy namespace and storage policy filter namespace

Parameters:

request - the information needed to create the storage policy

Returns:

the created storage policy

updateStoragePolicy

@RequestMapping(value="/storagePolicies/namespaces/{namespace}/storagePolicyNames/{storagePolicyName}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_STORAGE_POLICIES_PUT")
public StoragePolicy updateStoragePolicy(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                         String namespace,
                                                                                                                                                                                                                                                                                         @PathVariable(value="storagePolicyName")
                                                                                                                                                                                                                                                                                         String storagePolicyName,
                                                                                                                                                                                                                                                                                         @RequestBody
                                                                                                                                                                                                                                                                                         StoragePolicyUpdateRequest request)

Updates an existing storage policy by key.

Requires WRITE permission on storage policy namespace and storage policy filter namespace

Parameters:

namespace - the namespace

storagePolicyName - the storage policy name

request - the information needed to update the storage policy

Returns:

the updated storage policy

getStoragePolicy

@RequestMapping(value="/storagePolicies/namespaces/{namespace}/storagePolicyNames/{storagePolicyName}",
                method=GET)
 @Secured(value="FN_STORAGE_POLICIES_GET")
public StoragePolicy getStoragePolicy(@PathVariable(value="namespace")
                                                                                                                                                                                                                     String namespace,
                                                                                                                                                                                                                     @PathVariable(value="storagePolicyName")
                                                                                                                                                                                                                     String storagePolicyName)

Gets an existing storage policy by key.

Requires READ permission on namespace

Parameters:

namespace - the namespace

storagePolicyName - the storage policy name

Returns:

the retrieved storage policy