org.finra.herd.rest

Class ExternalInterfaceRestController

java.lang.Object

org.finra.herd.rest.ExternalInterfaceRestController

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

The REST controller that handles external interface REST requests.

Constructor Summary

Constructors

Constructor and Description
ExternalInterfaceRestController()

Method Summary

Modifier and Type	Method and Description
ExternalInterface	createExternalInterface(ExternalInterfaceCreateRequest request) Creates a new external interface.
ExternalInterface	deleteExternalInterface(String externalInterfaceName) Deletes an existing external interface by external interface name.
ExternalInterface	getExternalInterface(String externalInterfaceName) Retrieves an existing external interface by external interface name.
ExternalInterfaceKeys	getExternalInterfaces() Gets a list of external interface keys for all external interfaces defined in the system.
ExternalInterface	updateExternalInterface(String externalInterfaceName, ExternalInterfaceUpdateRequest request) Updates an existing external interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalInterfaceRestController

public ExternalInterfaceRestController()

Method Detail

createExternalInterface

@RequestMapping(value="/externalInterfaces",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_EXTERNAL_INTERFACES_POST")
public ExternalInterface createExternalInterface(@RequestBody
                                                                                                                                                                                                                                           ExternalInterfaceCreateRequest request)

Creates a new external interface.

Parameters:

request - the information needed to create an external interface

Returns:

the created external interface

deleteExternalInterface

@RequestMapping(value="/externalInterfaces/{externalInterfaceName}",
                method=DELETE)
 @Secured(value="FN_EXTERNAL_INTERFACES_DELETE")
public ExternalInterface deleteExternalInterface(@PathVariable(value="externalInterfaceName")
                                                                                                                                                                                                      String externalInterfaceName)

Deletes an existing external interface by external interface name.

Parameters:

externalInterfaceName - the external interface name

Returns:

the deleted external interface

getExternalInterface

@RequestMapping(value="/externalInterfaces/{externalInterfaceName}",
                method=GET)
 @Secured(value="FN_EXTERNAL_INTERFACES_GET")
public ExternalInterface getExternalInterface(@PathVariable(value="externalInterfaceName")
                                                                                                                                                                                             String externalInterfaceName)

Retrieves an existing external interface by external interface name.

Parameters:

externalInterfaceName - the external interface name

Returns:

the retrieved external interface

getExternalInterfaces

@RequestMapping(value="/externalInterfaces",
                method=GET)
 @Secured(value="FN_EXTERNAL_INTERFACES_ALL_GET")
public ExternalInterfaceKeys getExternalInterfaces()

Gets a list of external interface keys for all external interfaces defined in the system. The result list is sorted by external interface name in ascending order.

Returns:

the list of external interface keys

updateExternalInterface

@RequestMapping(value="/externalInterfaces/{externalInterfaceName}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_EXTERNAL_INTERFACES_PUT")
public ExternalInterface updateExternalInterface(@PathVariable(value="externalInterfaceName")
                                                                                                                                                                                                                                                                 String externalInterfaceName,
                                                                                                                                                                                                                                                                 @RequestBody
                                                                                                                                                                                                                                                                 ExternalInterfaceUpdateRequest request)

Updates an existing external interface.

Parameters:

request - the information needed to update an external interface

Returns:

the updated external interface