org.finra.herd.rest

Class SecurityRoleFunctionRestController

java.lang.Object

org.finra.herd.rest.SecurityRoleFunctionRestController

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

The REST controller that handles security role to function mapping REST requests.

Constructor Summary

Constructors

Constructor and Description
SecurityRoleFunctionRestController()

Method Summary

Modifier and Type	Method and Description
SecurityRoleFunction	createSecurityRoleFunction(SecurityRoleFunctionCreateRequest securityRoleFunctionCreateRequest) Creates a new security role to function mapping that is identified by security role name and security function name.
SecurityRoleFunction	deleteSecurityRoleFunction(String securityRoleName, String securityFunctionName) Deletes an existing security role to function mapping based on the specified parameters.
SecurityRoleFunction	getSecurityRoleFunction(String securityRoleName, String securityFunctionName) Retrieves an existing security role to function mapping based on the specified parameters.
SecurityRoleFunctionKeys	getSecurityRoleFunctions() Retrieves a list of security role to function mapping keys for all security role to function mappings registered in the system.
SecurityRoleFunctionKeys	getSecurityRoleFunctionsBySecurityFunction(String securityFunctionName) Retrieves a list of security role to function mapping keys for the specified security function.
SecurityRoleFunctionKeys	getSecurityRoleFunctionsBySecurityRole(String securityRoleName) Retrieves a list of security role to function mapping keys for the specified security role.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityRoleFunctionRestController

public SecurityRoleFunctionRestController()

Method Detail

createSecurityRoleFunction

@RequestMapping(value="/securityRoleFunctions",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_SECURITY_ROLE_FUNCTIONS_POST")
public SecurityRoleFunction createSecurityRoleFunction(@RequestBody
                                                                                                                                                                                                                                                        SecurityRoleFunctionCreateRequest securityRoleFunctionCreateRequest)

Creates a new security role to function mapping that is identified by security role name and security function name.

Parameters:

securityRoleFunctionCreateRequest - the information needed to create a security role to function mapping

Returns:

the created security role to function mapping

deleteSecurityRoleFunction

@RequestMapping(value="/securityRoleFunctions/securityRoleNames/{securityRoleName}/securityFunctionNames/{securityFunctionName}",
                method=DELETE)
 @Secured(value="FN_SECURITY_ROLE_FUNCTIONS_DELETE")
public SecurityRoleFunction deleteSecurityRoleFunction(@PathVariable(value="securityRoleName")
                                                                                                                                                                                                                                                                             String securityRoleName,
                                                                                                                                                                                                                                                                             @PathVariable(value="securityFunctionName")
                                                                                                                                                                                                                                                                             String securityFunctionName)

Deletes an existing security role to function mapping based on the specified parameters.

Parameters:

securityRoleName - the security role name

securityFunctionName - the security function name

Returns:

the deleted security role to function mapping

getSecurityRoleFunction

@RequestMapping(value="/securityRoleFunctions/securityRoleNames/{securityRoleName}/securityFunctionNames/{securityFunctionName}",
                method=GET)
 @Secured(value="FN_SECURITY_ROLE_FUNCTIONS_GET")
public SecurityRoleFunction getSecurityRoleFunction(@PathVariable(value="securityRoleName")
                                                                                                                                                                                                                                                                    String securityRoleName,
                                                                                                                                                                                                                                                                    @PathVariable(value="securityFunctionName")
                                                                                                                                                                                                                                                                    String securityFunctionName)

Retrieves an existing security role to function mapping based on the specified parameters.

Parameters:

securityRoleName - the security role name

securityFunctionName - the security function name

Returns:

the retrieved security role to function mapping

getSecurityRoleFunctions

@RequestMapping(value="/securityRoleFunctions",
                method=GET)
 @Secured(value="FN_SECURITY_ROLE_FUNCTIONS_ALL_GET")
public SecurityRoleFunctionKeys getSecurityRoleFunctions()

Retrieves a list of security role to function mapping keys for all security role to function mappings registered in the system. The result list is sorted by security role name and security function name in ascending order.

Returns:

the list of security role to function mapping keys

getSecurityRoleFunctionsBySecurityFunction

@RequestMapping(value="/securityRoleFunctions/securityFunctionNames/{securityFunctionName}",
                method=GET)
 @Secured(value="FN_SECURITY_ROLE_FUNCTIONS_BY_SECURITY_FUNCTION_GET")
public SecurityRoleFunctionKeys getSecurityRoleFunctionsBySecurityFunction(@PathVariable(value="securityFunctionName")
                                                                                                                                                                                                                                                                           String securityFunctionName)

Retrieves a list of security role to function mapping keys for the specified security function. The result list is sorted by security role name in ascending order.

Parameters:

securityFunctionName - the security function name

Returns:

the list of security role to function mapping keys

getSecurityRoleFunctionsBySecurityRole

@RequestMapping(value="/securityRoleFunctions/securityRoleNames/{securityRoleName}",
                method=GET)
 @Secured(value="FN_SECURITY_ROLE_FUNCTIONS_BY_SECURITY_ROLE_GET")
public SecurityRoleFunctionKeys getSecurityRoleFunctionsBySecurityRole(@PathVariable(value="securityRoleName")
                                                                                                                                                                                                                                                           String securityRoleName)

Retrieves a list of security role to function mapping keys for the specified security role. The result list is sorted by security function name in ascending order.

Parameters:

securityRoleName - the security role name

Returns:

the list of security role to function mapping keys