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

Class OMKeyPurgeRequest

java.lang.Object

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

org.apache.hadoop.ozone.om.request.key.OMKeyRequest

org.apache.hadoop.ozone.om.request.key.OMKeyPurgeRequest

All Implemented Interfaces:

RequestAuditor

public class OMKeyPurgeRequest
extends OMKeyRequest

Handles purging of keys from OM DB.

Nested Class Summary

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

OMClientRequest.Result

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
OMClientResponse	validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context)	Validate the OMRequest and update the cache.

Methods inherited from class org.apache.hadoop.ozone.om.request.key.OMKeyRequest

addKeyInfoToDeleteMap, allocateBlock, checkBucketAcls, checkBucketQuotaInBytes, checkBucketQuotaInNamespace, checkDirectoryAlreadyExists, checkKeyAcls, checkKeyAcls, checkKeyAclsInOpenKeyTable, createDirectoryInfoWithACL, createDirectoryKeyInfoWithACL, createFileInfo, dirKeyInfoBuilderNoACL, filterOutBlocksStillInUse, generateRequiredEncryptionInfo, getAclsForDir, getAclsForKey, getAllMissingParentDirInfo, getAllParentInfo, getBucketInfo, getBucketLayout, getDBMultipartOpenKey, getFileEncryptionInfo, getFileEncryptionInfo, getFileEncryptionInfoForMpuKey, getOldVersionsToCleanUp, getOzoneLockStrategy, getRemoteUser, getVolumeOwner, prepareFileInfo, prepareKeyInfo, resolveBucketAndCheckKeyAcls, resolveBucketAndCheckKeyAclsWithFSO, resolveBucketAndCheckOpenKeyAcls, resolveBucketLink, resolveBucketLink, sumBlockLengths, validateBucketAndVolume, validateEncryptionKeyInfo, wrapUncommittedBlocksAsPseudoKey

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

OMKeyPurgeRequest

public OMKeyPurgeRequest(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.