org.finra.herd.service.helper

Class NamespaceIamRoleAuthorizationHelper

java.lang.Object

org.finra.herd.service.helper.NamespaceIamRoleAuthorizationHelper

@Component
public class NamespaceIamRoleAuthorizationHelper
extends Object

A helper for NamespaceIamRoleAuthorization

Constructor Summary

Constructors

Constructor and Description
NamespaceIamRoleAuthorizationHelper()

Method Summary

Modifier and Type	Method and Description
void	checkPermissions(NamespaceEntity namespaceEntity, Collection<String> requestedIamRoleNames) Throws AccessDeniedException if the given namespace is not authorized to access any of the given IAM role names.
void	checkPermissions(NamespaceEntity namespaceEntity, String... requestedIamRoleNames) Throws AccessDeniedException if the given namespace is not authorized to access any of the given IAM role names.
NamespaceIamRoleAuthorizationEntity	createNamespaceIamRoleAuthorizationEntity(NamespaceIamRoleAuthorizationKey namespaceIamRoleAuthorizationKey, String iamRoleDescription) Creates a new NamespaceIamRoleAuthorizationEntity from the given parameters.
void	validateAndTrimNamespaceIamRoleAuthorizationKey(NamespaceIamRoleAuthorizationKey namespaceIamRoleAuthorizationKey) Validates a namespace IAM role authorization key.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespaceIamRoleAuthorizationHelper

public NamespaceIamRoleAuthorizationHelper()

Method Detail

checkPermissions

public void checkPermissions(NamespaceEntity namespaceEntity,
                             String... requestedIamRoleNames)

Throws AccessDeniedException if the given namespace is not authorized to access any of the given IAM role names. The IAM role names are case-insensitive. This method does nothing if ConfigurationValue.NAMESPACE_IAM_ROLE_AUTHORIZATION_ENABLED is false.

Parameters:

namespaceEntity - The namespace entity

requestedIamRoleNames - The requested IAM role names

checkPermissions

public void checkPermissions(NamespaceEntity namespaceEntity,
                             Collection<String> requestedIamRoleNames)

Throws AccessDeniedException if the given namespace is not authorized to access any of the given IAM role names. The IAM role names are case-insensitive. This method does nothing if ConfigurationValue.NAMESPACE_IAM_ROLE_AUTHORIZATION_ENABLED is false.

Parameters:

namespaceEntity - The namespace entity

requestedIamRoleNames - The collection of requested IAM role names

createNamespaceIamRoleAuthorizationEntity

public NamespaceIamRoleAuthorizationEntity createNamespaceIamRoleAuthorizationEntity(NamespaceIamRoleAuthorizationKey namespaceIamRoleAuthorizationKey,
                                                                                     String iamRoleDescription)

Creates a new NamespaceIamRoleAuthorizationEntity from the given parameters.

Parameters:

namespaceIamRoleAuthorizationKey - The namespace IAM role authorization key

iamRoleDescription - The IAM role description

Returns:

The NamespaceIamRoleAuthorizationEntity

validateAndTrimNamespaceIamRoleAuthorizationKey

public void validateAndTrimNamespaceIamRoleAuthorizationKey(NamespaceIamRoleAuthorizationKey namespaceIamRoleAuthorizationKey)

Validates a namespace IAM role authorization key. This method also trims the key parameters.

Parameters:

namespaceIamRoleAuthorizationKey - the namespace IAM role authorization key