HDDS-15145. Use enum for the ID type in SequenceIdGenerator #10211
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| /* | ||
| * 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 | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * 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.hdds.scm.ha; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Represents the sequence ID types managed by {@link SequenceIdGenerator} and their persisted RocksDB keys. | ||
| */ | ||
| public enum SequenceIdType { | ||
|
|
||
| LOCAL_ID("localId"), | ||
|
|
||
| DEL_TXN_ID("delTxnId"), | ||
|
|
||
| CONTAINER_ID("containerId"), | ||
|
|
||
| /** Certificate ID for all services, including root certificates. */ | ||
| CERTIFICATE_ID("CertificateId"), | ||
|
|
||
| /** | ||
| * @deprecated Use {@link #CERTIFICATE_ID} instead. | ||
| */ | ||
| @Deprecated | ||
| ROOT_CERTIFICATE_ID("rootCertificateId"); | ||
|
|
||
| /** | ||
| * The key string stored in the RocksDB sequenceId table. | ||
| */ | ||
| private final String dbKey; | ||
|
|
||
| /** | ||
| * Reverse lookup map from db key string to enum constant. | ||
| */ | ||
| private static final Map<String, SequenceIdType> DB_KEY_MAP; | ||
|
|
||
| static { | ||
| Map<String, SequenceIdType> map = new HashMap<>(); | ||
| for (SequenceIdType type : values()) { | ||
| map.put(type.dbKey, type); | ||
| } | ||
| DB_KEY_MAP = Collections.unmodifiableMap(map); | ||
| } | ||
|
|
||
| SequenceIdType(String dbKey) { | ||
| this.dbKey = dbKey; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the key string used to persist this sequence ID in RocksDB. | ||
| * This value must not be changed to keep backward compatibility with | ||
| * existing databases. | ||
| */ | ||
| public String getDbKey() { | ||
| return dbKey; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the {@link SequenceIdType} corresponding to the provided RocksDB key string, or null if unmapped. | ||
| */ | ||
| public static SequenceIdType fromDbKey(String dbKey) { | ||
|
Contributor
There was a problem hiding this comment. This method is unused except testReturnsNullIfEnumConstantNotAvailable(). Let's remove it and also DB_KEY_MAP. Indeed, we should always use SequenceIdType and never convert a String to SequenceIdType. |
||
| if (dbKey == null) { | ||
| return null; | ||
| } | ||
| return DB_KEY_MAP.get(dbKey); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change them to private.