Package org.apache.hadoop.ozone.om.multitenant

Interface MultiTenantAccessController

All Known Implementing Classes:

InMemoryMultiTenantAccessController

public interface MultiTenantAccessController

Defines the operations needed for multi-tenant access control.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MultiTenantAccessController.Acl	Define an acl.
static class	MultiTenantAccessController.Policy	Define a policy to be created.
static class	MultiTenantAccessController.Role	Define a role to be created.

Method Summary

Modifier and Type	Method	Description
static MultiTenantAccessController	create(org.apache.hadoop.hdds.conf.ConfigurationSource conf)	Create MultiTenantAccessController implementation.
MultiTenantAccessController.Policy	createPolicy(MultiTenantAccessController.Policy policy)	This operation will fail if a policy with the same name already exists, or a policy for the same set of resources already exists.
MultiTenantAccessController.Role	createRole(MultiTenantAccessController.Role role)	This operation will fail if a role with the same name already exists.
void	deletePolicy(String policyName)
void	deleteRole(String roleName)
List<MultiTenantAccessController.Policy>	getLabeledPolicies(String label)
MultiTenantAccessController.Policy	getPolicy(String policyName)
static Map<org.apache.hadoop.ozone.security.acl.IAccessAuthorizer.ACLType,String>	getRangerAclStrings()
long	getRangerServicePolicyVersion()
MultiTenantAccessController.Role	getRole(String roleName)
MultiTenantAccessController.Policy	updatePolicy(MultiTenantAccessController.Policy policy)
MultiTenantAccessController.Role	updateRole(long roleId, MultiTenantAccessController.Role role)	Replaces the role given by roleId with the contents of role.

Method Details

createPolicy

MultiTenantAccessController.Policy createPolicy(MultiTenantAccessController.Policy policy)
                                         throws IOException

This operation will fail if a policy with the same name already exists, or a policy for the same set of resources already exists. Roles defined in this policy that do not already exist will be created.

Throws:

IOException

getPolicy

MultiTenantAccessController.Policy getPolicy(String policyName)
                                      throws IOException

Throws:

IOException

getLabeledPolicies

List<MultiTenantAccessController.Policy> getLabeledPolicies(String label)
                                                     throws IOException

Throws:

IOException

updatePolicy

MultiTenantAccessController.Policy updatePolicy(MultiTenantAccessController.Policy policy)
                                         throws IOException

Throws:

IOException

deletePolicy

void deletePolicy(String policyName)
           throws IOException

Throws:

IOException

createRole

MultiTenantAccessController.Role createRole(MultiTenantAccessController.Role role)
                                     throws IOException

This operation will fail if a role with the same name already exists.

Returns:

Role ID returned from remote server.

Throws:

IOException

getRole

MultiTenantAccessController.Role getRole(String roleName)
                                  throws IOException

Throws:

IOException

updateRole

MultiTenantAccessController.Role updateRole(long roleId,
 MultiTenantAccessController.Role role)
                                     throws IOException

Replaces the role given by roleId with the contents of role. If roleId does not correspond to a role, an exception is thrown. The roleId of a given role can be retrieved from the getRole method.

Throws:

IOException

deleteRole

void deleteRole(String roleName)
         throws IOException

Throws:

IOException

getRangerServicePolicyVersion

long getRangerServicePolicyVersion()
                            throws IOException

Throws:

IOException

getRangerAclStrings

static Map<org.apache.hadoop.ozone.security.acl.IAccessAuthorizer.ACLType,String> getRangerAclStrings()

create

static MultiTenantAccessController create(org.apache.hadoop.hdds.conf.ConfigurationSource conf)

Create MultiTenantAccessController implementation.