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 an IAM role.
NamespaceIamRoleAuthorization	deleteNamespaceIamRoleAuthorization(String namespace, String iamRoleName) Removes a namespace IAM role authorization.
NamespaceIamRoleAuthorization	getNamespaceIamRoleAuthorization(String namespace, String iamRoleName) Get the namespace IAM role authorization.
NamespaceIamRoleAuthorizationKeys	getNamespaceIamRoleAuthorizations() Get a list of namespace IAM role authorization keys.
NamespaceIamRoleAuthorizationKeys	getNamespaceIamRoleAuthorizationsByIamRoleName(String iamRoleName) Get a list of namespace IAM role authorization keys by IAM role name.
NamespaceIamRoleAuthorizationKeys	getNamespaceIamRoleAuthorizationsByNamespace(String namespace) Get a list of namespace IAM role authorization keys by namespace code.
NamespaceIamRoleAuthorization	updateNamespaceIamRoleAuthorization(String namespace, String iamRoleName, NamespaceIamRoleAuthorizationUpdateRequest request) Sets the IAM role description for a namespace IAM role authorization.

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 an IAM role.

Parameters:

request - The namespace IAM role create request

Returns:

The namespace IAM role authorization

getNamespaceIamRoleAuthorization

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

Get the namespace IAM role authorization.

Parameters:

namespace - The namespace

iamRoleName - The IAM role name

Returns:

The namespace IAM role authorization

getNamespaceIamRoleAuthorizations

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

Get a list of namespace IAM role authorization keys.

Returns:

The list of namespace IAM role authorization keys

getNamespaceIamRoleAuthorizationsByIamRoleName

@RequestMapping(value="/namespaceIamRoleAuthorizations/iamRoleNames/{iamRoleName}",
                method=GET)
 @Secured(value="FN_NAMESPACE_IAM_ROLE_AUTHORIZATIONS_BY_IAM_ROLE_NAME_GET")
public NamespaceIamRoleAuthorizationKeys getNamespaceIamRoleAuthorizationsByIamRoleName(@PathVariable(value="iamRoleName")
                                                                                                                                                                                                                                                                                     String iamRoleName)

Get a list of namespace IAM role authorization keys by IAM role name.

Parameters:

iamRoleName - The IAM role name

Returns:

The list of namespace IAM role authorization keys

getNamespaceIamRoleAuthorizationsByNamespace

@RequestMapping(value="/namespaceIamRoleAuthorizations/namespaces/{namespace}",
                method=GET)
 @Secured(value="FN_NAMESPACE_IAM_ROLE_AUTHORIZATIONS_BY_NAMESPACE_GET")
public NamespaceIamRoleAuthorizationKeys getNamespaceIamRoleAuthorizationsByNamespace(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                           String namespace)

Get a list of namespace IAM role authorization keys by namespace code.

Parameters:

namespace - The namespace

Returns:

The list of namespace IAM role authorization keys

updateNamespaceIamRoleAuthorization

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

Sets the IAM role description for a namespace IAM role authorization.

Parameters:

namespace - The namespace

iamRoleName - The IAM role name

request - The namespace IAM role update request

Returns:

The namespace IAM role authorization

deleteNamespaceIamRoleAuthorization

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

Removes a namespace IAM role authorization.

Parameters:

namespace - The namespace

iamRoleName - The IAM role name

Returns:

The namespace IAM role authorization