Skip to content

Commit 2e1fd44

Browse files
anuengineeranuengineer
authored
HDDS-2201. Rename VolumeList to UserVolumeInfo. (#1566)
1 parent 61a8436 commit 2e1fd44

24 files changed

+159
-92
lines changed

‎hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/OMMetadataManager.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
import org.apache.hadoop.ozone.om.helpers.S3SecretValue;
3131
import org.apache.hadoop.ozone.om.lock.OzoneManagerLock;
3232
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos
33-
.VolumeList;
33+
.UserVolumeInfo;
3434
import org.apache.hadoop.ozone.security.OzoneTokenIdentifier;
3535
import org.apache.hadoop.hdds.utils.db.DBStore;
3636
import org.apache.hadoop.hdds.utils.db.Table;
@@ -225,7 +225,7 @@ List<OmVolumeArgs> listVolumes(String userName, String prefix,
225225
*
226226
* @return UserTable.
227227
*/
228-
Table<String, VolumeList> getUserTable();
228+
Table<String, UserVolumeInfo> getUserTable();
229229

230230
/**
231231
* Returns the Volume Table.

‎hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/codec/VolumeListCodec.java‎ renamed to ‎hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/codec/UserVolumeInfoCodec.java‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,31 +18,32 @@
1818
package org.apache.hadoop.ozone.om.codec;
1919

2020
import java.io.IOException;
21-
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.VolumeList;
21+
import org.apache.hadoop.ozone.protocol.proto
22+
.OzoneManagerProtocolProtos.UserVolumeInfo;
2223
import org.apache.hadoop.hdds.utils.db.Codec;
2324

2425
import com.google.common.base.Preconditions;
2526
import com.google.protobuf.InvalidProtocolBufferException;
2627

2728
/**
28-
* Codec to encode VolumeList as byte array.
29+
* Codec to encode UserVolumeInfo as byte array.
2930
*/
30-
public class VolumeListCodec implements Codec<VolumeList> {
31+
public class UserVolumeInfoCodec implements Codec<UserVolumeInfo> {
3132

3233
@Override
33-
public byte[] toPersistedFormat(VolumeList object) throws IOException {
34+
public byte[] toPersistedFormat(UserVolumeInfo object) throws IOException {
3435
Preconditions
3536
.checkNotNull(object, "Null object can't be converted to byte array.");
3637
return object.toByteArray();
3738
}
3839

3940
@Override
40-
public VolumeList fromPersistedFormat(byte[] rawData) throws IOException {
41+
public UserVolumeInfo fromPersistedFormat(byte[] rawData) throws IOException {
4142
Preconditions
4243
.checkNotNull(rawData,
4344
"Null byte array can't converted to real object.");
4445
try {
45-
return VolumeList.parseFrom(rawData);
46+
return UserVolumeInfo.parseFrom(rawData);
4647
} catch (InvalidProtocolBufferException e) {
4748
throw new IllegalArgumentException(
4849
"Can't encode the the raw data from the byte array", e);

‎hadoop-ozone/common/src/main/proto/OzoneManagerProtocol.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ message CreateVolumeResponse {
352352

353353
}
354354

355-
message VolumeList {
355+
message UserVolumeInfo {
356356
repeated string volumeNames = 1;
357357
optional uint64 objectID = 2;
358358
optional uint64 updateID = 3;

‎hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OmMetadataManagerImpl.java‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
import org.apache.hadoop.ozone.om.codec.RepeatedOmKeyInfoCodec;
4848
import org.apache.hadoop.ozone.om.codec.S3SecretValueCodec;
4949
import org.apache.hadoop.ozone.om.codec.TokenIdentifierCodec;
50-
import org.apache.hadoop.ozone.om.codec.VolumeListCodec;
50+
import org.apache.hadoop.ozone.om.codec.UserVolumeInfoCodec;
5151
import org.apache.hadoop.ozone.om.exceptions.OMException;
5252
import org.apache.hadoop.ozone.om.exceptions.OMException.ResultCodes;
5353
import org.apache.hadoop.ozone.om.helpers.OmBucketInfo;
@@ -61,7 +61,8 @@
6161
import org.apache.hadoop.ozone.om.helpers.RepeatedOmKeyInfo;
6262
import org.apache.hadoop.ozone.om.helpers.S3SecretValue;
6363
import org.apache.hadoop.ozone.om.lock.OzoneManagerLock;
64-
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.VolumeList;
64+
import org.apache.hadoop.ozone.protocol.proto
65+
.OzoneManagerProtocolProtos.UserVolumeInfo;
6566
import org.apache.hadoop.ozone.security.OzoneTokenIdentifier;
6667

6768
import com.google.common.annotations.VisibleForTesting;
@@ -92,7 +93,7 @@ public class OmMetadataManagerImpl implements OMMetadataManager {
9293
* |----------------------------------------------------------------------|
9394
* | Column Family | VALUE |
9495
* |----------------------------------------------------------------------|
95-
* | userTable | user->VolumeList |
96+
* | userTable | /user->UserVolumeInfo |
9697
* |----------------------------------------------------------------------|
9798
* | volumeTable | /volume->VolumeInfo |
9899
* |----------------------------------------------------------------------|
@@ -170,7 +171,7 @@ protected OmMetadataManagerImpl() {
170171
}
171172

172173
@Override
173-
public Table<String, VolumeList> getUserTable() {
174+
public Table<String, UserVolumeInfo> getUserTable() {
174175
return userTable;
175176
}
176177

@@ -266,7 +267,7 @@ protected DBStoreBuilder addOMTablesAndCodecs(DBStoreBuilder builder) {
266267
.addCodec(RepeatedOmKeyInfo.class, new RepeatedOmKeyInfoCodec())
267268
.addCodec(OmBucketInfo.class, new OmBucketInfoCodec())
268269
.addCodec(OmVolumeArgs.class, new OmVolumeArgsCodec())
269-
.addCodec(VolumeList.class, new VolumeListCodec())
270+
.addCodec(UserVolumeInfo.class, new UserVolumeInfoCodec())
270271
.addCodec(OmMultipartKeyInfo.class, new OmMultipartKeyInfoCodec())
271272
.addCodec(S3SecretValue.class, new S3SecretValueCodec())
272273
.addCodec(OmPrefixInfo.class, new OmPrefixInfoCodec());
@@ -279,7 +280,7 @@ protected DBStoreBuilder addOMTablesAndCodecs(DBStoreBuilder builder) {
279280
*/
280281
protected void initializeOmTables() throws IOException {
281282
userTable =
282-
this.store.getTable(USER_TABLE, String.class, VolumeList.class);
283+
this.store.getTable(USER_TABLE, String.class, UserVolumeInfo.class);
283284
checkTableStatus(userTable, USER_TABLE);
284285

285286
TableCacheImpl.CacheCleanupPolicy cleanupPolicy =
@@ -706,7 +707,7 @@ public List<OmKeyInfo> listKeys(String volumeName, String bucketName,
706707
public List<OmVolumeArgs> listVolumes(String userName,
707708
String prefix, String startKey, int maxKeys) throws IOException {
708709
List<OmVolumeArgs> result = Lists.newArrayList();
709-
VolumeList volumes;
710+
UserVolumeInfo volumes;
710711
if (StringUtil.isBlank(userName)) {
711712
throw new OMException("User name is required to list Volumes.",
712713
ResultCodes.USER_NOT_FOUND);
@@ -747,15 +748,15 @@ public List<OmVolumeArgs> listVolumes(String userName,
747748
return result;
748749
}
749750

750-
private VolumeList getVolumesByUser(String userNameKey)
751+
private UserVolumeInfo getVolumesByUser(String userNameKey)
751752
throws OMException {
752753
try {
753-
VolumeList volumeList = getUserTable().get(userNameKey);
754-
if (volumeList == null) {
754+
UserVolumeInfo userVolInfo = getUserTable().get(userNameKey);
755+
if (userVolInfo == null) {
755756
// No volume found for this user, return an empty list
756-
return VolumeList.newBuilder().build();
757+
return UserVolumeInfo.newBuilder().build();
757758
} else {
758-
return volumeList;
759+
return userVolInfo;
759760
}
760761
} catch (IOException e) {
761762
throw new OMException("Unable to get volumes info by the given user, "

‎hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/VolumeManagerImpl.java‎

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,10 @@
2828
import org.apache.hadoop.ozone.OzoneConfigKeys;
2929
import org.apache.hadoop.ozone.om.exceptions.OMException;
3030
import org.apache.hadoop.ozone.om.helpers.OmVolumeArgs;
31-
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OzoneAclInfo;
32-
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.VolumeList;
31+
import org.apache.hadoop.ozone.protocol.proto
32+
.OzoneManagerProtocolProtos.OzoneAclInfo;
33+
import org.apache.hadoop.ozone.protocol.proto
34+
.OzoneManagerProtocolProtos.UserVolumeInfo;
3335
import org.apache.hadoop.ozone.security.acl.IAccessAuthorizer;
3436
import org.apache.hadoop.ozone.security.acl.OzoneObj;
3537
import org.apache.hadoop.ozone.security.acl.RequestContext;
@@ -73,11 +75,11 @@ public VolumeManagerImpl(OMMetadataManager metadataManager,
7375
}
7476

7577
// Helpers to add and delete volume from user list
76-
private VolumeList addVolumeToOwnerList(String volume, String owner)
78+
private UserVolumeInfo addVolumeToOwnerList(String volume, String owner)
7779
throws IOException {
7880
// Get the volume list
7981
String dbUserKey = metadataManager.getUserKey(owner);
80-
VolumeList volumeList = metadataManager.getUserTable().get(dbUserKey);
82+
UserVolumeInfo volumeList = metadataManager.getUserTable().get(dbUserKey);
8183
List<String> prevVolList = new ArrayList<>();
8284
if (volumeList != null) {
8385
prevVolList.addAll(volumeList.getVolumeNamesList());
@@ -92,16 +94,16 @@ private VolumeList addVolumeToOwnerList(String volume, String owner)
9294

9395
// Add the new volume to the list
9496
prevVolList.add(volume);
95-
VolumeList newVolList = VolumeList.newBuilder()
97+
UserVolumeInfo newVolList = UserVolumeInfo.newBuilder()
9698
.addAllVolumeNames(prevVolList).build();
9799

98100
return newVolList;
99101
}
100102

101-
private VolumeList delVolumeFromOwnerList(String volume, String owner)
103+
private UserVolumeInfo delVolumeFromOwnerList(String volume, String owner)
102104
throws IOException {
103105
// Get the volume list
104-
VolumeList volumeList = metadataManager.getUserTable().get(owner);
106+
UserVolumeInfo volumeList = metadataManager.getUserTable().get(owner);
105107
List<String> prevVolList = new ArrayList<>();
106108
if (volumeList != null) {
107109
prevVolList.addAll(volumeList.getVolumeNamesList());
@@ -112,7 +114,7 @@ private VolumeList delVolumeFromOwnerList(String volume, String owner)
112114

113115
// Remove the volume from the list
114116
prevVolList.remove(volume);
115-
VolumeList newVolList = VolumeList.newBuilder()
117+
UserVolumeInfo newVolList = UserVolumeInfo.newBuilder()
116118
.addAllVolumeNames(prevVolList).build();
117119
return newVolList;
118120
}
@@ -144,7 +146,7 @@ public void createVolume(OmVolumeArgs omVolumeArgs) throws IOException {
144146
throw new OMException(ResultCodes.VOLUME_ALREADY_EXISTS);
145147
}
146148

147-
VolumeList volumeList = addVolumeToOwnerList(omVolumeArgs.getVolume(),
149+
UserVolumeInfo volumeList = addVolumeToOwnerList(omVolumeArgs.getVolume(),
148150
omVolumeArgs.getOwnerName());
149151

150152
// Set creation time
@@ -173,7 +175,7 @@ public void createVolume(OmVolumeArgs omVolumeArgs) throws IOException {
173175
}
174176

175177
private void createVolumeCommitToDB(OmVolumeArgs omVolumeArgs,
176-
VolumeList volumeList, String dbVolumeKey, String dbUserKey)
178+
UserVolumeInfo volumeList, String dbVolumeKey, String dbUserKey)
177179
throws IOException {
178180
try (BatchOperation batch = metadataManager.getStore()
179181
.initBatchOperation()) {
@@ -222,11 +224,12 @@ public void setOwner(String volume, String owner)
222224

223225
acquiredUsersLock = metadataManager.getLock().acquireMultiUserLock(owner,
224226
originalOwner);
225-
VolumeList oldOwnerVolumeList = delVolumeFromOwnerList(volume,
227+
UserVolumeInfo oldOwnerVolumeList = delVolumeFromOwnerList(volume,
226228
originalOwner);
227229

228230
String newOwner = metadataManager.getUserKey(owner);
229-
VolumeList newOwnerVolumeList = addVolumeToOwnerList(volume, newOwner);
231+
UserVolumeInfo newOwnerVolumeList = addVolumeToOwnerList(volume,
232+
newOwner);
230233

231234
volumeArgs.setOwnerName(owner);
232235
setOwnerCommitToDB(oldOwnerVolumeList, newOwnerVolumeList,
@@ -246,8 +249,8 @@ public void setOwner(String volume, String owner)
246249
}
247250

248251

249-
private void setOwnerCommitToDB(VolumeList oldOwnerVolumeList,
250-
VolumeList newOwnerVolumeList, OmVolumeArgs newOwnerVolumeArgs,
252+
private void setOwnerCommitToDB(UserVolumeInfo oldOwnerVolumeList,
253+
UserVolumeInfo newOwnerVolumeList, OmVolumeArgs newOwnerVolumeArgs,
251254
String oldOwner) throws IOException {
252255
try (BatchOperation batch = metadataManager.getStore()
253256
.initBatchOperation()) {
@@ -370,7 +373,7 @@ public void deleteVolume(String volume) throws IOException {
370373
Preconditions.checkState(volume.equals(volumeArgs.getVolume()));
371374
// delete the volume from the owner list
372375
// as well as delete the volume entry
373-
VolumeList newVolumeList = delVolumeFromOwnerList(volume,
376+
UserVolumeInfo newVolumeList = delVolumeFromOwnerList(volume,
374377
volumeArgs.getOwnerName());
375378

376379

@@ -390,7 +393,7 @@ public void deleteVolume(String volume) throws IOException {
390393
}
391394

392395

393-
private void deleteVolumeCommitToDB(VolumeList newVolumeList,
396+
private void deleteVolumeCommitToDB(UserVolumeInfo newVolumeList,
394397
String volume, String owner) throws IOException {
395398
try (BatchOperation batch = metadataManager.getStore()
396399
.initBatchOperation()) {

‎hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/s3/bucket/S3BucketCreateRequest.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,7 @@
5757
.S3CreateBucketResponse;
5858
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos
5959
.S3CreateVolumeInfo;
60-
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos
61-
.VolumeList;
60+
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.UserVolumeInfo;
6261
import org.apache.hadoop.util.Time;
6362
import org.apache.hadoop.hdds.utils.db.cache.CacheKey;
6463
import org.apache.hadoop.hdds.utils.db.cache.CacheValue;
@@ -176,7 +175,7 @@ public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager,
176175
OmVolumeArgs omVolumeArgs = createOmVolumeArgs(volumeName, userName,
177176
s3CreateBucketRequest.getS3CreateVolumeInfo()
178177
.getCreationTime());
179-
VolumeList volumeList = omMetadataManager.getUserTable().get(
178+
UserVolumeInfo volumeList = omMetadataManager.getUserTable().get(
180179
omMetadataManager.getUserKey(userName));
181180
volumeList = addVolumeToOwnerList(volumeList,
182181
volumeName, userName, ozoneManager.getMaxUserVolumeCount(),

‎hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/volume/OMVolumeCreateRequest.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@
4747
.OMResponse;
4848
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos
4949
.VolumeInfo;
50-
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos
51-
.VolumeList;
50+
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.UserVolumeInfo;
5251
import org.apache.hadoop.util.Time;
5352

5453
import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_ADMINISTRATORS_WILDCARD;
@@ -133,7 +132,7 @@ public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager,
133132
}
134133
}
135134

136-
VolumeList volumeList = null;
135+
UserVolumeInfo volumeList = null;
137136

138137
// acquire lock.
139138
acquiredVolumeLock = omMetadataManager.getLock().acquireLock(VOLUME_LOCK,

‎hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/volume/OMVolumeDeleteRequest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager,
9595
}
9696

9797
OmVolumeArgs omVolumeArgs = null;
98-
OzoneManagerProtocolProtos.VolumeList newVolumeList = null;
98+
OzoneManagerProtocolProtos.UserVolumeInfo newVolumeList = null;
9999

100100
acquiredVolumeLock = omMetadataManager.getLock().acquireLock(VOLUME_LOCK,
101101
volume);

‎hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/volume/OMVolumeRequest.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos
2727
.OMRequest;
2828
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos
29-
.VolumeList;
29+
.UserVolumeInfo;
3030
import org.apache.hadoop.hdds.utils.db.cache.CacheKey;
3131
import org.apache.hadoop.hdds.utils.db.cache.CacheValue;
3232

@@ -50,10 +50,10 @@ public OMVolumeRequest(OMRequest omRequest) {
5050
* @param volume - volume which needs to deleted from the volume list.
5151
* @param owner - Name of the Owner.
5252
* @param txID - The transaction ID that is updating this value.
53-
* @return VolumeList - updated volume list for the user.
53+
* @return UserVolumeInfo - updated UserVolumeInfo.
5454
* @throws IOException
5555
*/
56-
protected VolumeList delVolumeFromOwnerList(VolumeList volumeList,
56+
protected UserVolumeInfo delVolumeFromOwnerList(UserVolumeInfo volumeList,
5757
String volume, String owner, long txID) throws IOException {
5858

5959
List<String> prevVolList = new ArrayList<>();
@@ -68,7 +68,7 @@ protected VolumeList delVolumeFromOwnerList(VolumeList volumeList,
6868

6969
// Remove the volume from the list
7070
prevVolList.remove(volume);
71-
VolumeList newVolList = VolumeList.newBuilder()
71+
UserVolumeInfo newVolList = UserVolumeInfo.newBuilder()
7272
.addAllVolumeNames(prevVolList)
7373
.setObjectID(volumeList.getObjectID())
7474
.setUpdateID(txID)
@@ -88,7 +88,7 @@ protected VolumeList delVolumeFromOwnerList(VolumeList volumeList,
8888
* @throws OMException - if user has volumes greater than
8989
* maxUserVolumeCount, an exception is thrown.
9090
*/
91-
protected VolumeList addVolumeToOwnerList(VolumeList volumeList,
91+
protected UserVolumeInfo addVolumeToOwnerList(UserVolumeInfo volumeList,
9292
String volume, String owner, long maxUserVolumeCount, long txID)
9393
throws IOException {
9494

@@ -109,7 +109,7 @@ protected VolumeList addVolumeToOwnerList(VolumeList volumeList,
109109

110110
// Add the new volume to the list
111111
prevVolList.add(volume);
112-
VolumeList newVolList = VolumeList.newBuilder()
112+
UserVolumeInfo newVolList = UserVolumeInfo.newBuilder()
113113
.setObjectID(objectID)
114114
.setUpdateID(txID)
115115
.addAllVolumeNames(prevVolList).build();
@@ -129,7 +129,7 @@ protected VolumeList addVolumeToOwnerList(VolumeList volumeList,
129129
* @throws IOException
130130
*/
131131
protected void createVolume(final OMMetadataManager omMetadataManager,
132-
OmVolumeArgs omVolumeArgs, VolumeList volumeList, String dbVolumeKey,
132+
OmVolumeArgs omVolumeArgs, UserVolumeInfo volumeList, String dbVolumeKey,
133133
String dbUserKey, long transactionLogIndex) {
134134
// Update cache: Update user and volume cache.
135135
omMetadataManager.getUserTable().addCacheEntry(new CacheKey<>(dbUserKey),

‎hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/volume/OMVolumeSetOwnerRequest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager,
117117

118118
String dbVolumeKey = omMetadataManager.getVolumeKey(volume);
119119

120-
OzoneManagerProtocolProtos.VolumeList oldOwnerVolumeList = null;
121-
OzoneManagerProtocolProtos.VolumeList newOwnerVolumeList = null;
120+
OzoneManagerProtocolProtos.UserVolumeInfo oldOwnerVolumeList = null;
121+
OzoneManagerProtocolProtos.UserVolumeInfo newOwnerVolumeList = null;
122122
OmVolumeArgs omVolumeArgs = null;
123123

124124

0 commit comments

Comments
 (0)