| /** |
| * 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; |
| |
| import org.apache.hadoop.hdds.conf.OzoneConfiguration; |
| import org.apache.hadoop.hdds.utils.db.Table; |
| import org.apache.hadoop.ozone.common.BlockGroup; |
| import org.apache.hadoop.ozone.om.exceptions.OMException; |
| import org.apache.hadoop.ozone.om.helpers.BucketLayout; |
| import org.apache.hadoop.ozone.om.helpers.OmKeyArgs; |
| import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; |
| import org.apache.hadoop.ozone.om.helpers.OmMultipartUploadList; |
| import org.apache.hadoop.ozone.om.helpers.OmMultipartUploadListParts; |
| import org.apache.hadoop.ozone.om.fs.OzoneManagerFS; |
| import org.apache.hadoop.hdds.utils.BackgroundService; |
| import org.apache.hadoop.ozone.om.helpers.RepeatedOmKeyInfo; |
| import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKeyBucket; |
| |
| import java.io.IOException; |
| import java.time.Duration; |
| import java.util.List; |
| |
| /** |
| * Handles key level commands. |
| */ |
| public interface KeyManager extends OzoneManagerFS, IOzoneAcl { |
| |
| /** |
| * Start key manager. |
| * |
| * @param configuration |
| * @throws IOException |
| */ |
| void start(OzoneConfiguration configuration); |
| |
| /** |
| * Stop key manager. |
| */ |
| void stop() throws IOException; |
| |
| /** |
| * Look up an existing key. Return the info of the key to client side, which |
| * DistributedStorageHandler will use to access the data on datanode. |
| * |
| * @param args the args of the key provided by client. |
| * @param clientAddress a hint to key manager, order the datanode in returned |
| * pipeline by distance between client and datanode. |
| * @return a OmKeyInfo instance client uses to talk to container. |
| * @throws IOException |
| */ |
| OmKeyInfo lookupKey(OmKeyArgs args, String clientAddress) throws IOException; |
| |
| |
| /** |
| * Returns a list of keys represented by {@link OmKeyInfo} |
| * in the given bucket. |
| * |
| * @param volumeName |
| * the name of the volume. |
| * @param bucketName |
| * the name of the bucket. |
| * @param startKey |
| * the start key name, only the keys whose name is |
| * after this value will be included in the result. |
| * This key is excluded from the result. |
| * @param keyPrefix |
| * key name prefix, only the keys whose name has |
| * this prefix will be included in the result. |
| * @param maxKeys |
| * the maximum number of keys to return. It ensures |
| * the size of the result will not exceed this limit. |
| * @return a list of keys. |
| * @throws IOException |
| */ |
| List<OmKeyInfo> listKeys(String volumeName, |
| String bucketName, String startKey, String keyPrefix, int maxKeys) |
| throws IOException; |
| |
| /** |
| * List trash allows the user to list the keys that were marked as deleted, |
| * but not actually deleted by Ozone Manager. This allows a user to recover |
| * keys within a configurable window. |
| * @param volumeName - The volume name, which can also be a wild card |
| * using '*'. |
| * @param bucketName - The bucket name, which can also be a wild card |
| * using '*'. |
| * @param startKeyName - List keys from a specific key name. |
| * @param keyPrefix - List keys using a specific prefix. |
| * @param maxKeys - The number of keys to be returned. This must be below |
| * the cluster level set by admins. |
| * @return The list of keys that are deleted from the deleted table. |
| * @throws IOException |
| */ |
| List<RepeatedOmKeyInfo> listTrash(String volumeName, String bucketName, |
| String startKeyName, String keyPrefix, int maxKeys) throws IOException; |
| |
| /** |
| * Returns a list of pending deletion key info that ups to the given count. |
| * Each entry is a {@link BlockGroup}, which contains the info about the |
| * key name and all its associated block IDs. A pending deletion key is |
| * stored with #deleting# prefix in OM DB. |
| * |
| * @param count max number of keys to return. |
| * @return a list of {@link BlockGroup} representing keys and blocks. |
| * @throws IOException |
| */ |
| List<BlockGroup> getPendingDeletionKeys(int count) throws IOException; |
| |
| /** |
| * Returns the names of up to {@code count} open keys whose age is |
| * greater than or equal to {@code expireThreshold}. |
| * |
| * @param count The maximum number of expired open keys to return. |
| * @param expireThreshold The threshold of open key expiration age. |
| * @param bucketLayout The type of open keys to get (e.g. DEFAULT or FSO). |
| * @return a {@link List} of {@link OpenKeyBucket}, the expired open keys. |
| * @throws IOException |
| */ |
| List<OpenKeyBucket> getExpiredOpenKeys(Duration expireThreshold, int count, |
| BucketLayout bucketLayout) throws IOException; |
| |
| /** |
| * Returns the metadataManager. |
| * @return OMMetadataManager. |
| */ |
| OMMetadataManager getMetadataManager(); |
| |
| /** |
| * Returns the instance of Deleting Service. |
| * @return Background service. |
| */ |
| BackgroundService getDeletingService(); |
| |
| |
| OmMultipartUploadList listMultipartUploads(String volumeName, |
| String bucketName, String prefix) throws OMException; |
| |
| /** |
| * Returns list of parts of a multipart upload key. |
| * @param volumeName |
| * @param bucketName |
| * @param keyName |
| * @param uploadID |
| * @param partNumberMarker |
| * @param maxParts |
| * @return OmMultipartUploadListParts |
| */ |
| OmMultipartUploadListParts listParts(String volumeName, String bucketName, |
| String keyName, String uploadID, int partNumberMarker, |
| int maxParts) throws IOException; |
| |
| /** |
| * Refresh the key block location information by get latest info from SCM. |
| * @param key |
| */ |
| void refresh(OmKeyInfo key) throws IOException; |
| |
| /** |
| * Assume OM has FS namespace like below, deleteDirTable stores absolute |
| * path name as existing KeyDeletionService expects full key name. |
| * For example, if user deletes directory 'd1' then the entry in OM DB looks |
| * like, DBKey = 1030/d3 and DBValue = KeyInfo with keyName "a/b2/d3" |
| * |
| * vol1 |
| * | |
| * buck-1 |
| * | |
| * a |
| * | |
| * ----------------------------------- |
| * | | | |
| * b1 b2 b3 |
| * ----- --------- ---------- |
| * | | | | | | | | |
| * c1 c2 d1 d2 d3 e1 e2 e3 |
| * | | |
| * -------- | |
| * | | | |
| * d21.txt d22.txt e11.txt |
| * |
| * @return OmKeyInfo |
| * @throws IOException |
| */ |
| Table.KeyValue<String, OmKeyInfo> getPendingDeletionDir() throws IOException; |
| |
| /** |
| * Returns all sub directories under the given parent directory. |
| * |
| * @param parentInfo |
| * @param numEntries |
| * @return list of dirs |
| * @throws IOException |
| */ |
| List<OmKeyInfo> getPendingDeletionSubDirs(long volumeId, long bucketId, |
| OmKeyInfo parentInfo, long numEntries) throws IOException; |
| |
| /** |
| * Returns all sub files under the given parent directory. |
| * |
| * @param parentInfo |
| * @param numEntries |
| * @return list of files |
| * @throws IOException |
| */ |
| List<OmKeyInfo> getPendingDeletionSubFiles(long volumeId, |
| long bucketId, OmKeyInfo parentInfo, long numEntries) |
| throws IOException; |
| |
| /** |
| * Returns the instance of Directory Deleting Service. |
| * @return Background service. |
| */ |
| BackgroundService getDirDeletingService(); |
| |
| /** |
| * Returns the instance of Open Key Cleanup Service. |
| * @return Background service. |
| */ |
| BackgroundService getOpenKeyCleanupService(); |
| } |
