org.finra.herd.rest

Class DataProviderRestController

java.lang.Object

org.finra.herd.rest.DataProviderRestController

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

The REST controller that handles data provider REST requests.

Constructor Summary

Constructors

Constructor and Description
DataProviderRestController()

Method Summary

Modifier and Type	Method and Description
DataProvider	createDataProvider(DataProviderCreateRequest request) Creates a new data provider.
DataProvider	deleteDataProvider(String dataProviderName) Deletes an existing data provider by data provider name.
DataProvider	getDataProvider(String dataProviderName) Gets an existing data provider by data provider name.
DataProviderKeys	getDataProviders() Gets a list of data provider keys for all data providers defined in the system.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataProviderRestController

public DataProviderRestController()

Method Detail

createDataProvider

@RequestMapping(value="/dataProviders",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_DATA_PROVIDERS_POST")
public DataProvider createDataProvider(@RequestBody
                                                                                                                                                                                                                       DataProviderCreateRequest request)

Creates a new data provider.

Parameters:

request - the information needed to create the data provider

Returns:

the created data provider

getDataProvider

@RequestMapping(value="/dataProviders/{dataProviderName}",
                method=GET)
 @Secured(value="FN_DATA_PROVIDERS_GET")
public DataProvider getDataProvider(@PathVariable(value="dataProviderName")
                                                                                                                                                                    String dataProviderName)

Gets an existing data provider by data provider name.

Parameters:

dataProviderName - the data provider name

Returns:

the retrieved data provider

deleteDataProvider

@RequestMapping(value="/dataProviders/{dataProviderName}",
                method=DELETE)
 @Secured(value="FN_DATA_PROVIDERS_DELETE")
public DataProvider deleteDataProvider(@PathVariable(value="dataProviderName")
                                                                                                                                                                             String dataProviderName)

Deletes an existing data provider by data provider name.

Parameters:

dataProviderName - the data provider name

Returns:

the data provider that got deleted

getDataProviders

@RequestMapping(value="/dataProviders",
                method=GET)
 @Secured(value="FN_DATA_PROVIDERS_ALL_GET")
public DataProviderKeys getDataProviders()

Gets a list of data provider keys for all data providers defined in the system.

Returns:

the list of data provider keys