org.finra.herd.rest

Class AllowedAttributeValueRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.AllowedAttributeValueRestController

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

The REST controller that handles allowed attribute value REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOWED_ATTRIBUTE_VALUES_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
AllowedAttributeValueRestController()

Method Summary

Modifier and Type	Method and Description
AllowedAttributeValuesInformation	createAllowedAttributeValues(AllowedAttributeValuesCreateRequest request) Creates a list of allowed attribute values for an existing attribute value list.
AllowedAttributeValuesInformation	deleteAllowedAttributeValues(AllowedAttributeValuesDeleteRequest request) Deletes specified allowed attribute values from an existing attribute value list.
AllowedAttributeValuesInformation	getAllowedAttributeValues(String namespace, String attributeValueListName) Retrieves a range of existing allowed attribute values.

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

ALLOWED_ATTRIBUTE_VALUES_URI_PREFIX

public static final String ALLOWED_ATTRIBUTE_VALUES_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

AllowedAttributeValueRestController

public AllowedAttributeValueRestController()

Method Detail

createAllowedAttributeValues

@RequestMapping(value="/allowedAttributeValues",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_ALLOWED_ATTRIBUTE_VALUES_POST")
public AllowedAttributeValuesInformation createAllowedAttributeValues(@RequestBody
                                                                                                                                                                                                                                                                         AllowedAttributeValuesCreateRequest request)

Creates a list of allowed attribute values for an existing attribute value list.

Parameters:

request - the information needed to create the allowed attribute values

Returns:

the newly created allowed attribute values

getAllowedAttributeValues

@RequestMapping(value="/allowedAttributeValues/namespaces/{namespace}/attributeValueListNames/{attributeValueListName}",
                method=GET)
 @Secured(value="FN_ALLOWED_ATTRIBUTE_VALUES_ALL_GET")
public AllowedAttributeValuesInformation getAllowedAttributeValues(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                               String namespace,
                                                                                                                                                                                                                                                                               @PathVariable(value="attributeValueListName")
                                                                                                                                                                                                                                                                               String attributeValueListName)

Retrieves a range of existing allowed attribute values.

Parameters:

namespace - the namespace

attributeValueListName - the attribute value list name

Returns:

the allowed attribute values

deleteAllowedAttributeValues

@RequestMapping(value="/allowedAttributeValues",
                method=DELETE,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_ALLOWED_ATTRIBUTE_VALUES_DELETE")
public AllowedAttributeValuesInformation deleteAllowedAttributeValues(@RequestBody
                                                                                                                                                                                                                                                                             AllowedAttributeValuesDeleteRequest request)

Deletes specified allowed attribute values from an existing attribute value list.

Parameters:

request - the allowed attribute values delete request

Returns:

the deleted allowed attribute values