errose28 commented on a change in pull request #1435: URL: https://github.com/apache/hadoop-ozone/pull/1435#discussion_r499578543
########## File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/response/key/AbstractOMKeyDeleteResponse.java ########## @@ -0,0 +1,150 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.om.response.key; + +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.om.OMMetadataManager; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyLocationInfoGroup; +import org.apache.hadoop.ozone.om.helpers.OmVolumeArgs; +import org.apache.hadoop.ozone.om.helpers.RepeatedOmKeyInfo; +import org.apache.hadoop.ozone.om.response.CleanupTableInfo; +import org.apache.hadoop.ozone.om.response.OMClientResponse; +import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos + .OMResponse; +import org.apache.hadoop.hdds.utils.db.BatchOperation; + +import java.io.IOException; +import javax.annotation.Nullable; +import javax.annotation.Nonnull; + +import static org.apache.hadoop.ozone.om.OmMetadataManagerImpl.DELETED_TABLE; + +/** + * Response for DeleteKey request. + */ +@CleanupTableInfo(cleanupTables = {DELETED_TABLE}) +public abstract class AbstractOMKeyDeleteResponse extends OMClientResponse { + + private boolean isRatisEnabled; + + public AbstractOMKeyDeleteResponse( + @Nonnull OMResponse omResponse, boolean isRatisEnabled) { + + super(omResponse); + this.isRatisEnabled = isRatisEnabled; + } + + /** + * For when the request is not successful. + * For a successful request, the other constructor should be used. + */ + public AbstractOMKeyDeleteResponse(@Nonnull OMResponse omResponse) { + super(omResponse); + checkStatusNotOK(); + } + + /** + * Adds the operation of deleting the {@code keyName omKeyInfo} pair from + * {@code fromTable} to the batch operation {@code batchOperation}. The + * batch operation is not committed, so no changes are persisted to disk. + * The log transaction index used will be retrieved by calling + * {@link OmKeyInfo#getUpdateID} on {@code omKeyInfo}. + */ + protected void deleteFromTable( + OMMetadataManager omMetadataManager, + BatchOperation batchOperation, + Table<String, ?> fromTable, + String keyName, + OmKeyInfo omKeyInfo) throws IOException { + + deleteFromTable(omMetadataManager, batchOperation, fromTable, keyName, + omKeyInfo, omKeyInfo.getUpdateID()); + } + + /** + * Adds the operation of deleting the {@code keyName omKeyInfo} pair from + * {@code fromTable} to the batch operation {@code batchOperation}. The + * batch operation is not committed, so no changes are persisted to disk. + */ + protected void deleteFromTable( + OMMetadataManager omMetadataManager, + BatchOperation batchOperation, + Table<String, ?> fromTable, + String keyName, + OmKeyInfo omKeyInfo, long trxnLogIndex) throws IOException { + + // For OmResponse with failure, this should do nothing. This method is + // not called in failure scenario in OM code. + fromTable.deleteWithBatch(batchOperation, keyName); + + // If Key is not empty add this to delete table. + if (!isKeyEmpty(omKeyInfo)) { + // If a deleted key is put in the table where a key with the same + // name already exists, then the old deleted key information would be + // lost. To avoid this, first check if a key with same name exists. + // deletedTable in OM Metadata stores <KeyName, RepeatedOMKeyInfo>. + // The RepeatedOmKeyInfo is the structure that allows us to store a + // list of OmKeyInfo that can be tied to same key name. For a keyName + // if RepeatedOMKeyInfo structure is null, we create a new instance, + // if it is not null, then we simply add to the list and store this + // instance in deletedTable. + RepeatedOmKeyInfo repeatedOmKeyInfo = + omMetadataManager.getDeletedTable().get(keyName); + repeatedOmKeyInfo = OmUtils.prepareKeyForDelete( + omKeyInfo, repeatedOmKeyInfo, trxnLogIndex, + isRatisEnabled); + omMetadataManager.getDeletedTable().putWithBatch( + batchOperation, keyName, repeatedOmKeyInfo); + } + } + + protected void addVolumeArgsToBatch(OMMetadataManager metadataManager, + BatchOperation batch, OmVolumeArgs volumeArgs) throws IOException { + + Table<String, OmVolumeArgs> volumeTable = metadataManager.getVolumeTable(); + String volumeKey = metadataManager.getVolumeKey(volumeArgs.getVolume()); + volumeTable.putWithBatch(batch, volumeKey, volumeArgs); + } + + @Override + public abstract void addToDBBatch(OMMetadataManager omMetadataManager, + BatchOperation batchOperation) throws IOException; + + /** + * Check if the key is empty or not. Key will be empty if it does not have + * blocks. + * + * @param keyInfo + * @return if empty true, else false. + */ + private boolean isKeyEmpty(@Nullable OmKeyInfo keyInfo) { Review comment: Yes, the idea of creating this abstract class was to eventually consolidate the duplicate code between OMOpenKeysDeleteResponse, OMKeyDeleteResponse, and OMKeysDeleteResponse. I had originally refactored the other classes as well to use this code, but since HDDS-451 (quota support) is moving along at a brisk pace, I could not keep up with the merge conflicts as the other response classes kept changing, and decided it was better to do this in a later PR. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: ozone-issues-unsubscr...@hadoop.apache.org For additional commands, e-mail: ozone-issues-h...@hadoop.apache.org
