org.finra.herd.rest

Class SecurityFunctionRestController

java.lang.Object

org.finra.herd.rest.SecurityFunctionRestController

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

The REST controller that handles security function REST requests.

Constructor Summary

Constructors

Constructor and Description
SecurityFunctionRestController()

Method Summary

Modifier and Type	Method and Description
SecurityFunction	createSecurityFunction(SecurityFunctionCreateRequest request) Creates a new security function.
SecurityFunction	deleteSecurityFunction(String securityFunctionName) Deletes an existing security function by security function name.
SecurityFunction	getSecurityFunction(String securityFunctionName) Retrieves an existing security function by security function name.
SecurityFunctionKeys	getSecurityFunctions() Gets a list of security function keys for all security functions defined in the system.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityFunctionRestController

public SecurityFunctionRestController()

Method Detail

createSecurityFunction

@RequestMapping(value="/securityFunctions",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_SECURITY_FUNCTIONS_POST")
public SecurityFunction createSecurityFunction(@RequestBody
                                                                                                                                                                                                                                       SecurityFunctionCreateRequest request)

Creates a new security function.

Parameters:

request - the information needed to create a security function

Returns:

the created security function

deleteSecurityFunction

@RequestMapping(value="/securityFunctions/{securityFunctionName}",
                method=DELETE)
 @Secured(value="FN_SECURITY_FUNCTIONS_DELETE")
public SecurityFunction deleteSecurityFunction(@PathVariable(value="securityFunctionName")
                                                                                                                                                                                                 String securityFunctionName)

Deletes an existing security function by security function name.

Parameters:

securityFunctionName - the security function name

Returns:

the deleted security function

getSecurityFunction

@RequestMapping(value="/securityFunctions/{securityFunctionName}",
                method=GET)
 @Secured(value="FN_SECURITY_FUNCTIONS_GET")
public SecurityFunction getSecurityFunction(@PathVariable(value="securityFunctionName")
                                                                                                                                                                                        String securityFunctionName)

Retrieves an existing security function by security function name.

Parameters:

securityFunctionName - the security function name

Returns:

the retrieved security function

getSecurityFunctions

@RequestMapping(value="/securityFunctions",
                method=GET)
 @Secured(value="FN_SECURITY_FUNCTIONS_ALL_GET")
public SecurityFunctionKeys getSecurityFunctions()

Gets a list of security function keys for all security functions defined in the system. The result list is sorted by security function name in ascending order.

Returns:

the list of security function keys