org.finra.herd.rest

Class GlobalAttributeDefinitionRestController

java.lang.Object

org.finra.herd.rest.GlobalAttributeDefinitionRestController

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

The REST controller that handles global attribute definition REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GLOBAL_ATTRIBUTE_DEFINITIONS_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
GlobalAttributeDefinitionRestController()

Method Summary

Modifier and Type	Method and Description
GlobalAttributeDefinition	createGlobalAttributeDefinition(GlobalAttributeDefinitionCreateRequest globalAttributeDefinitionCreateRequest) Creates a new global Attribute Definition.
GlobalAttributeDefinition	deleteGlobalAttributeDefinition(String globalAttributeDefinitionLevel, String globalAttributeDefinitionName) Deletes an existing global Attribute Definition.
GlobalAttributeDefinition	getGlobalAttributeDefinition(String globalAttributeDefinitionLevel, String globalAttributeDefinitionName) Get an existing global Attribute Definition.
GlobalAttributeDefinitionKeys	getGlobalAttributeDefinitions() Retrieves all global Attribute Definitions.

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_ATTRIBUTE_DEFINITIONS_URI_PREFIX

public static final String GLOBAL_ATTRIBUTE_DEFINITIONS_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

GlobalAttributeDefinitionRestController

public GlobalAttributeDefinitionRestController()

Method Detail

createGlobalAttributeDefinition

@RequestMapping(value="/globalAttributeDefinitions",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_GLOBAL_ATTRIBUTE_DEFINITIONS_POST")
public GlobalAttributeDefinition createGlobalAttributeDefinition(@RequestBody
                                                                                                                                                                                                                                                                            GlobalAttributeDefinitionCreateRequest globalAttributeDefinitionCreateRequest)

Creates a new global Attribute Definition.

Parameters:

globalAttributeDefinitionCreateRequest - the information needed to create the global Attribute Definition

Returns:

the created global Attribute Definition

deleteGlobalAttributeDefinition

@RequestMapping(value="/globalAttributeDefinitions/globalAttributeDefinitionLevels/{globalAttributeDefinitionLevel}/globalAttributeDefinitionNames/{globalAttributeDefinitionName}",
                method=DELETE)
 @Secured(value="FN_GLOBAL_ATTRIBUTE_DEFINITIONS_DELETE")
public GlobalAttributeDefinition deleteGlobalAttributeDefinition(@PathVariable(value="globalAttributeDefinitionLevel")
                                                                                                                                                                                                                                                                                                                                               String globalAttributeDefinitionLevel,
                                                                                                                                                                                                                                                                                                                                               @PathVariable(value="globalAttributeDefinitionName")
                                                                                                                                                                                                                                                                                                                                               String globalAttributeDefinitionName)

Deletes an existing global Attribute Definition.

Parameters:

globalAttributeDefinitionLevel - the global Attribute Definition level

globalAttributeDefinitionName - the global Attribute Definition name

Returns:

the deleted global Attribute Definition

getGlobalAttributeDefinitions

@RequestMapping(value="/globalAttributeDefinitions",
                method=GET)
 @Secured(value="FN_GLOBAL_ATTRIBUTE_DEFINITIONS_ALL_GET")
public GlobalAttributeDefinitionKeys getGlobalAttributeDefinitions()

Retrieves all global Attribute Definitions.

Returns:

global Attribute Definitions

getGlobalAttributeDefinition

@RequestMapping(value="/globalAttributeDefinitions/globalAttributeDefinitionLevels/{globalAttributeDefinitionLevel}/globalAttributeDefinitionNames/{globalAttributeDefinitionName}",
                method=GET)
 @Secured(value="FN_GLOBAL_ATTRIBUTE_DEFINITIONS_GET")
public GlobalAttributeDefinition getGlobalAttributeDefinition(@PathVariable(value="globalAttributeDefinitionLevel")
                                                                                                                                                                                                                                                                                                                                      String globalAttributeDefinitionLevel,
                                                                                                                                                                                                                                                                                                                                      @PathVariable(value="globalAttributeDefinitionName")
                                                                                                                                                                                                                                                                                                                                      String globalAttributeDefinitionName)

Get an existing global Attribute Definition.

Parameters:

globalAttributeDefinitionLevel - the global Attribute Definition level

globalAttributeDefinitionName - the global Attribute Definition name

Returns:

the global Attribute Definition