org.finra.herd.rest

Class SecurityRoleRestController

java.lang.Object

org.finra.herd.rest.SecurityRoleRestController

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

The REST controller that handles security role REST requests.

Constructor Summary

Constructors

Constructor and Description
SecurityRoleRestController()

Method Summary

Modifier and Type	Method and Description
SecurityRole	createSecurityRole(SecurityRoleCreateRequest securityRoleCreateRequest) Creates a new security role.
SecurityRole	deleteSecurityRole(String securityRoleName) Deletes an existing security role.
SecurityRole	getSecurityRole(String securityRoleName) Retrieves an existing security role.
SecurityRoleKeys	getSecurityRoles() Gets a list of security role keys for all security roles registered in the system.
SecurityRole	updateSecurityRole(String securityRoleName, SecurityRoleUpdateRequest securityRoleUpdateRequest) Updates an existing security role.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityRoleRestController

public SecurityRoleRestController()

Method Detail

createSecurityRole

@RequestMapping(value="/securityRoles",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_SECURITY_ROLES_POST")
public SecurityRole createSecurityRole(@RequestBody
                                                                                                                                                                                                                       SecurityRoleCreateRequest securityRoleCreateRequest)

Creates a new security role.

Parameters:

securityRoleCreateRequest - the information needed to create a security role

Returns:

the created security role

deleteSecurityRole

@RequestMapping(value="/securityRoles/{securityRoleName}",
                method=DELETE)
 @Secured(value="FN_SECURITY_ROLES_DELETE")
public SecurityRole deleteSecurityRole(@PathVariable(value="securityRoleName")
                                                                                                                                                                             String securityRoleName)

Deletes an existing security role.

Parameters:

securityRoleName - the security role name

Returns:

the deleted security role

getSecurityRole

@RequestMapping(value="/securityRoles/{securityRoleName}",
                method=GET)
 @Secured(value="FN_SECURITY_ROLES_GET")
public SecurityRole getSecurityRole(@PathVariable(value="securityRoleName")
                                                                                                                                                                    String securityRoleName)

Retrieves an existing security role.

Parameters:

securityRoleName - the security role name

Returns:

the retrieved security role

getSecurityRoles

@RequestMapping(value="/securityRoles",
                method=GET)
 @Secured(value="FN_SECURITY_ROLES_ALL_GET")
public SecurityRoleKeys getSecurityRoles()

Gets a list of security role keys for all security roles registered in the system. The result list is sorted by security role name in ascending order.

Returns:

the list of security role keys

updateSecurityRole

@RequestMapping(value="/securityRoles/{securityRoleName}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_SECURITY_ROLES_PUT")
public SecurityRole updateSecurityRole(@PathVariable(value="securityRoleName")
                                                                                                                                                                                                                                        String securityRoleName,
                                                                                                                                                                                                                                        @RequestBody
                                                                                                                                                                                                                                        SecurityRoleUpdateRequest securityRoleUpdateRequest)

Updates an existing security role.

Parameters:

securityRoleName - the security role name

securityRoleUpdateRequest - the information required to update a security role

Returns:

the updated security role