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

Class OMDirectoryCreateRequest

java.lang.Object

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

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

org.apache.hadoop.ozone.om.request.file.OMDirectoryCreateRequest

All Implemented Interfaces:

RequestAuditor

Direct Known Subclasses:

OMDirectoryCreateRequestWithFSO

public class OMDirectoryCreateRequest
extends OMKeyRequest

Handle create directory request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OMDirectoryCreateRequest.Result	Stores the result of request execution in OMClientRequest#validateAndUpdateCache.

Constructor Summary

Constructors

Constructor	Description
OMDirectoryCreateRequest(org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest omRequest, org.apache.hadoop.ozone.om.helpers.BucketLayout bucketLayout)

Method Summary

Modifier and Type	Method	Description
static org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest	blockCreateDirectoryWithBucketLayoutFromOldClient(org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest req, ValidationContext ctx)	Validates directory create requests.
static org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest	disallowCreateDirectoryWithECReplicationConfig(org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest req, ValidationContext ctx)
org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest	preExecute(OzoneManager ozoneManager)	Perform pre-execute steps on a OMRequest.
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, 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

OMDirectoryCreateRequest

public OMDirectoryCreateRequest(org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest omRequest,
 org.apache.hadoop.ozone.om.helpers.BucketLayout bucketLayout)

Method Details

preExecute

public org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest preExecute(OzoneManager ozoneManager)
                                                                                       throws IOException

Description copied from class: OMClientRequest

Perform pre-execute steps on a OMRequest. Called from the RPC context, and generates a OMRequest object which has all the information that will be either persisted in RocksDB or returned to the caller once this operation is executed.

Overrides:

preExecute in class OMClientRequest

Returns:

OMRequest that will be serialized and handed off to Ratis for consensus.

Throws:

IOException

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.

disallowCreateDirectoryWithECReplicationConfig

public static org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest disallowCreateDirectoryWithECReplicationConfig(org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest req,
 ValidationContext ctx)
                                                                                                                                  throws org.apache.hadoop.ozone.om.exceptions.OMException

Throws:

org.apache.hadoop.ozone.om.exceptions.OMException

blockCreateDirectoryWithBucketLayoutFromOldClient

public static org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest blockCreateDirectoryWithBucketLayoutFromOldClient(org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest req,
 ValidationContext ctx)
                                                                                                                                     throws IOException

Validates directory create requests. Handles the cases where an older client attempts to create a directory inside a bucket with a non LEGACY bucket layout. We do not want an older client modifying a bucket that it cannot understand.

Parameters:

req - - the request to validate

ctx - - the validation context

Returns:

the validated request

Throws:

org.apache.hadoop.ozone.om.exceptions.OMException - if the request is invalid

IOException