org.finra.herd.rest

Class NamespaceRestController

java.lang.Object

org.finra.herd.rest.NamespaceRestController

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

The REST controller that handles namespace REST requests.

Constructor Summary

Constructors

Constructor and Description
NamespaceRestController()

Method Summary

Modifier and Type	Method and Description
Namespace	createNamespace(NamespaceCreateRequest request) Creates a new namespace.
Namespace	deleteNamespace(String namespaceCode) Deletes an existing namespace by namespace code.
Namespace	getNamespace(String namespaceCode) Gets an existing namespace by namespace code.
NamespaceKeys	getNamespaces() Gets a list of namespace keys for all namespaces defined in the system.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespaceRestController

public NamespaceRestController()

Method Detail

createNamespace

@RequestMapping(value="/namespaces",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_NAMESPACES_POST")
public Namespace createNamespace(@RequestBody
                                                                                                                                                                                                          NamespaceCreateRequest request)

Creates a new namespace.

Parameters:

request - the information needed to create the namespace

Returns:

the created namespace

getNamespace

@RequestMapping(value="/namespaces/{namespaceCode}",
                method=GET)
 @Secured(value="FN_NAMESPACES_GET")
public Namespace getNamespace(@PathVariable(value="namespaceCode")
                                                                                                                                                    String namespaceCode)

Gets an existing namespace by namespace code.

Parameters:

namespaceCode - the namespace code

Returns:

the retrieved namespace

deleteNamespace

@RequestMapping(value="/namespaces/{namespaceCode}",
                method=DELETE)
 @Secured(value="FN_NAMESPACES_DELETE")
public Namespace deleteNamespace(@PathVariable(value="namespaceCode")
                                                                                                                                                             String namespaceCode)

Deletes an existing namespace by namespace code.

Parameters:

namespaceCode - the namespace code

Returns:

the namespace that got deleted

getNamespaces

@RequestMapping(value="/namespaces",
                method=GET)
 @Secured(value="FN_NAMESPACES_ALL_GET")
public NamespaceKeys getNamespaces()

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

Returns:

the list of namespace keys