org.finra.herd.rest

Class NamespaceIamRoleAuthorizationRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.NamespaceIamRoleAuthorizationRestController

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

The REST controller for namespace IAM role authorizations.

Constructor Summary

Constructors

Constructor and Description
NamespaceIamRoleAuthorizationRestController()

Method Summary

Modifier and Type	Method and Description
NamespaceIamRoleAuthorization	createNamespaceIamRoleAuthorization(NamespaceIamRoleAuthorizationCreateRequest request) Authorizes a namespace to use IAM roles.
NamespaceIamRoleAuthorization	deleteNamespaceIamRoleAuthorization(String namespace) Removes IAM roles a namespace has authorizations to use.
NamespaceIamRoleAuthorization	getNamespaceIamRoleAuthorization(String namespace) Get the IAM roles that a namespace is authorized to use.
NamespaceIamRoleAuthorizations	getNamespaceIamRoleAuthorizations() Get a list of namespace IAM role authorizations.
NamespaceIamRoleAuthorization	updateNamespaceIamRoleAuthorization(String namespace, NamespaceIamRoleAuthorizationUpdateRequest request) Sets the authorizations a namespace has to use IAM roles.

Methods inherited from class org.finra.herd.rest.HerdBaseController

addPagingHttpHeaders, validateNoDuplicateQueryStringParams

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespaceIamRoleAuthorizationRestController

public NamespaceIamRoleAuthorizationRestController()

Method Detail

createNamespaceIamRoleAuthorization

@RequestMapping(value="/namespaceIamRoleAuthorizations",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_NAMESPACE_IAM_ROLE_AUTHORIZATIONS_POST")
public NamespaceIamRoleAuthorization createNamespaceIamRoleAuthorization(@RequestBody
                                                                                                                                                                                                                                                                                             NamespaceIamRoleAuthorizationCreateRequest request)

Authorizes a namespace to use IAM roles.

Parameters:

request - The namespace IAM role create request

Returns:

The namespace IAM role authorization

getNamespaceIamRoleAuthorization

@RequestMapping(value="/namespaceIamRoleAuthorizations/namespaces/{namespace}",
                method=GET)
 @Secured(value="FN_NAMESPACE_IAM_ROLE_AUTHORIZATIONS_GET")
public NamespaceIamRoleAuthorization getNamespaceIamRoleAuthorization(@PathVariable(value="namespace")
                                                                                                                                                                                                                                              String namespace)

Get the IAM roles that a namespace is authorized to use.

Parameters:

namespace - The namespace

Returns:

The namespace IAM role authorization

getNamespaceIamRoleAuthorizations

@RequestMapping(value="/namespaceIamRoleAuthorizations",
                method=GET)
 @Secured(value="FN_NAMESPACE_IAM_ROLE_AUTHORIZATIONS_ALL_GET")
public NamespaceIamRoleAuthorizations getNamespaceIamRoleAuthorizations()

Get a list of namespace IAM role authorizations.

Returns:

The list of namespace IAM role authorizations.

updateNamespaceIamRoleAuthorization

@RequestMapping(value="/namespaceIamRoleAuthorizations/namespaces/{namespace}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_NAMESPACE_IAM_ROLE_AUTHORIZATIONS_PUT")
public NamespaceIamRoleAuthorization updateNamespaceIamRoleAuthorization(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                  String namespace,
                                                                                                                                                                                                                                                                                                                  @RequestBody
                                                                                                                                                                                                                                                                                                                  NamespaceIamRoleAuthorizationUpdateRequest request)

Sets the authorizations a namespace has to use IAM roles.

Parameters:

namespace - The namespace to update authorizations

request - The namespace IAM role update request

Returns:

The namespace IAM role authorization

deleteNamespaceIamRoleAuthorization

@RequestMapping(value="/namespaceIamRoleAuthorizations/namespaces/{namespace}",
                method=DELETE)
 @Secured(value="FN_NAMESPACE_IAM_ROLE_AUTHORIZATIONS_DELETE")
public NamespaceIamRoleAuthorization deleteNamespaceIamRoleAuthorization(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                       String namespace)

Removes IAM roles a namespace has authorizations to use.

Parameters:

namespace - The namespace of the authorizations to remove

Returns:

The namespace IAM role authorization