org.finra.herd.rest

Class AttributeValueListRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.AttributeValueListRestController

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_VALUE_LIST_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
AttributeValueListRestController()

Method Summary

Modifier and Type	Method and Description
AttributeValueList	createAttributeValueList(AttributeValueListCreateRequest request) Creates a new attribute value list.
AttributeValueList	deleteAttributeValueList(String namespace, String attributeValueListName) Deletes an existing attribute value list.
AttributeValueList	getAttributeValueList(String namespace, String attributeValueListName) Gets an existing attribute value list.
AttributeValueListKeys	getAttributeValueLists() Gets a list of keys for all attribute value lists registered in the system that user has access to.

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

ATTRIBUTE_VALUE_LIST_URI_PREFIX

public static final String ATTRIBUTE_VALUE_LIST_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

AttributeValueListRestController

public AttributeValueListRestController()

Method Detail

createAttributeValueList

@RequestMapping(value="/attributeValueLists",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_ATTRIBUTE_VALUE_LISTS_POST")
public AttributeValueList createAttributeValueList(@RequestBody
                                                                                                                                                                                                                                                AttributeValueListCreateRequest request)

Creates a new attribute value list.

Requires WRITE permission on namespace

Parameters:

request - the information needed to create an attribute value list

Returns:

the attribute value list information

deleteAttributeValueList

@RequestMapping(value="/attributeValueLists/namespaces/{namespace}/attributeValueListNames/{attributeValueListName}",
                method=DELETE)
 @Secured(value="FN_ATTRIBUTE_VALUE_LISTS_DELETE")
public AttributeValueList deleteAttributeValueList(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                           String namespace,
                                                                                                                                                                                                                                                           @PathVariable(value="attributeValueListName")
                                                                                                                                                                                                                                                           String attributeValueListName)

Deletes an existing attribute value list.

Requires WRITE permission on namespace

Parameters:

namespace - the namespace of the attribute value list

attributeValueListName - the name of the attribute value list

Returns:

the attribute value list information

getAttributeValueList

@RequestMapping(value="/attributeValueLists/namespaces/{namespace}/attributeValueListNames/{attributeValueListName}",
                method=GET)
 @Secured(value="FN_ATTRIBUTE_VALUE_LISTS_GET")
public AttributeValueList getAttributeValueList(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                  String namespace,
                                                                                                                                                                                                                                                  @PathVariable(value="attributeValueListName")
                                                                                                                                                                                                                                                  String attributeValueListName)

Gets an existing attribute value list.

Requires READ permission on namespace

Parameters:

namespace - the namespace of the attribute value list

attributeValueListName - the name of the attribute value list

Returns:

the attribute value list information

getAttributeValueLists

@RequestMapping(value="/attributeValueLists",
                method=GET)
 @Secured(value="FN_ATTRIBUTE_VALUE_LISTS_GET_ALL")
public AttributeValueListKeys getAttributeValueLists()

Gets a list of keys for all attribute value lists registered in the system that user has access to.

Requires READ permission on namespace

Returns:

the list of attribute value list keys