Package org.apache.hadoop.ozone.om.request.key.acl

Class OMKeyAclRequest

java.lang.Object

org.apache.hadoop.ozone.om.request.OMClientRequest

org.apache.hadoop.ozone.om.request.key.acl.OMKeyAclRequest

All Implemented Interfaces:

RequestAuditor

Direct Known Subclasses:

OMKeyAclRequestWithFSO, OMKeyAddAclRequest, OMKeyRemoveAclRequest, OMKeySetAclRequest

public abstract class OMKeyAclRequest
extends OMClientRequest

Base class for Bucket acl request.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.ozone.om.request.OMClientRequest

OMClientRequest.Result

Constructor Summary

Constructors

Constructor	Description
OMKeyAclRequest(org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest omRequest)

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.ozone.om.helpers.BucketLayout	getBucketLayout()
void	initializeBucketLayout(OzoneManager ozoneManager)
void	setBucketLayout(org.apache.hadoop.ozone.om.helpers.BucketLayout bucketLayout)
OMClientResponse	validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context)	Validate the OMRequest and update the cache.

Methods inherited from class org.apache.hadoop.ozone.om.request.OMClientRequest

buildAuditMessage, buildVolumeAuditMap, checkAcls, checkAcls, checkAcls, checkACLsWithFSO, createErrorOMResponse, createUGI, createUGIForApi, getAuditBuilder, getHostName, getOmLockDetails, getOmRequest, getRemoteAddress, getUserIfNotExists, getUserInfo, handleRequestFailure, isValidKeyPath, markForAudit, mergeOmLockDetails, normalizeKeyPath, preExecute, setUGI, validateAndNormalizeKey, validateAndNormalizeKey, validateAndNormalizeKey, validateAndUpdateCache

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.ozone.om.request.RequestAuditor

buildKeyArgsAuditMap, buildLightKeyArgsAuditMap

Constructor Details

OMKeyAclRequest

public OMKeyAclRequest(org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest omRequest)

Method Details

validateAndUpdateCache

public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager,
 ExecutionContext context)

Description copied from class: OMClientRequest

Validate the OMRequest and update the cache. This step should verify that the request can be executed, perform any authorization steps and update the in-memory cache. This step does not persist the changes to the database. To coders and reviewers, CAUTION: Do NOT bring external dependencies into this method, doing so could potentially cause divergence in OM DB states in HA. If you have to, be extremely careful. e.g. Do NOT invoke ACL check inside validateAndUpdateCache, which can use Ranger plugin that relies on external DB.

Specified by:

validateAndUpdateCache in class OMClientRequest

Returns:

the response that will be returned to the client.

initializeBucketLayout

public void initializeBucketLayout(OzoneManager ozoneManager)

setBucketLayout

public void setBucketLayout(org.apache.hadoop.ozone.om.helpers.BucketLayout bucketLayout)

getBucketLayout

public org.apache.hadoop.ozone.om.helpers.BucketLayout getBucketLayout()