Skip to content

Commit f4c785d

Browse files
nvazqueznvazquez
committed
CLOUDSTACK-9574: Redesign storage tags and remove details from listImageStores response and UI
1 parent bc86bae commit f4c785d

10 files changed

Lines changed: 265 additions & 112 deletions

File tree

‎api/src/org/apache/cloudstack/api/response/ImageStoreResponse.java‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@
1616
// under the License.
1717
package org.apache.cloudstack.api.response;
1818

19-
import java.util.LinkedHashSet;
20-
import java.util.Set;
21-
2219
import com.google.gson.annotations.SerializedName;
2320

2421
import org.apache.cloudstack.api.ApiConstants;
@@ -63,12 +60,7 @@ public class ImageStoreResponse extends BaseResponse {
6360
@Param(description = "the scope of the image store")
6461
private ScopeType scope;
6562

66-
@SerializedName("details")
67-
@Param(description = "the details of the image store")
68-
private Set<ImageStoreDetailResponse> details;
69-
7063
public ImageStoreResponse() {
71-
this.details = new LinkedHashSet<ImageStoreDetailResponse>();
7264
}
7365

7466
@Override
@@ -140,16 +132,4 @@ public void setProtocol(String protocol) {
140132
this.protocol = protocol;
141133
}
142134

143-
public Set<ImageStoreDetailResponse> getDetails() {
144-
return details;
145-
}
146-
147-
public void setDetails(Set<ImageStoreDetailResponse> details) {
148-
this.details = details;
149-
}
150-
151-
public void addDetail(ImageStoreDetailResponse detail) {
152-
this.details.add(detail);
153-
}
154-
155135
}

‎engine/schema/resources/META-INF/cloudstack/core/spring-engine-schema-core-daos-context.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,7 @@
266266
<bean id="storageNetworkIpRangeDaoImpl" class="com.cloud.dc.dao.StorageNetworkIpRangeDaoImpl" />
267267
<bean id="storagePoolDetailsDaoImpl" class="com.cloud.storage.dao.StoragePoolDetailsDaoImpl" />
268268
<bean id="storagePoolJoinDaoImpl" class="com.cloud.api.query.dao.StoragePoolJoinDaoImpl" />
269+
<bean id="storagePoolTagsDaoImpl" class="com.cloud.storage.dao.StoragePoolTagsDaoImpl" />
269270
<bean id="storageTagDaoImpl" class="com.cloud.api.query.dao.StorageTagDaoImpl" />
270271
<bean id="hostTagDaoImpl" class="com.cloud.api.query.dao.HostTagDaoImpl" />
271272
<bean id="storagePoolWorkDaoImpl" class="com.cloud.storage.dao.StoragePoolWorkDaoImpl" />

‎engine/schema/src/com/cloud/storage/StoragePoolTagVO.java‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
// Licensed to the Apache Software Foundation (ASF) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The ASF licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
package com.cloud.storage;
18+
19+
import javax.persistence.Column;
20+
import javax.persistence.Entity;
21+
import javax.persistence.GeneratedValue;
22+
import javax.persistence.GenerationType;
23+
import javax.persistence.Id;
24+
import javax.persistence.Table;
25+
26+
import org.apache.cloudstack.api.InternalIdentity;
27+
28+
@Entity
29+
@Table(name = "storage_pool_tags")
30+
public class StoragePoolTagVO implements InternalIdentity {
31+
32+
protected StoragePoolTagVO() {
33+
}
34+
35+
@Id
36+
@GeneratedValue(strategy = GenerationType.IDENTITY)
37+
@Column(name = "id")
38+
private long id;
39+
40+
@Column(name = "pool_id")
41+
private long poolId;
42+
43+
@Column(name = "tag")
44+
private String tag;
45+
46+
public StoragePoolTagVO(long poolId, String tag) {
47+
this.poolId = poolId;
48+
this.tag = tag;
49+
}
50+
51+
@Override
52+
public long getId() {
53+
return this.id;
54+
}
55+
56+
public long getPoolId() {
57+
return poolId;
58+
}
59+
60+
public String getTag() {
61+
return tag;
62+
}
63+
64+
}

‎engine/schema/src/com/cloud/storage/dao/StoragePoolTagsDao.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Licensed to the Apache Software Foundation (ASF) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The ASF licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
package com.cloud.storage.dao;
18+
19+
import java.util.List;
20+
21+
import com.cloud.storage.StoragePoolTagVO;
22+
import com.cloud.utils.db.GenericDao;
23+
24+
public interface StoragePoolTagsDao extends GenericDao<StoragePoolTagVO, Long> {
25+
26+
void persist(long poolId, List<String> storagePoolTags);
27+
List<String> getStoragePoolTags(long poolId);
28+
void deleteTags(long poolId);
29+
30+
}

‎engine/schema/src/com/cloud/storage/dao/StoragePoolTagsDaoImpl.java‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
// Licensed to the Apache Software Foundation (ASF) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The ASF licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
package com.cloud.storage.dao;
18+
19+
import java.util.ArrayList;
20+
import java.util.List;
21+
import com.cloud.storage.StoragePoolTagVO;
22+
import com.cloud.utils.db.GenericDaoBase;
23+
import com.cloud.utils.db.SearchBuilder;
24+
import com.cloud.utils.db.SearchCriteria;
25+
import com.cloud.utils.db.TransactionLegacy;
26+
27+
public class StoragePoolTagsDaoImpl extends GenericDaoBase<StoragePoolTagVO, Long> implements StoragePoolTagsDao {
28+
29+
protected final SearchBuilder<StoragePoolTagVO> StoragePoolSearch;
30+
31+
public StoragePoolTagsDaoImpl() {
32+
StoragePoolSearch = createSearchBuilder();
33+
StoragePoolSearch.and("poolId", StoragePoolSearch.entity().getPoolId(), SearchCriteria.Op.EQ);
34+
StoragePoolSearch.done();
35+
}
36+
37+
@Override
38+
public void persist(long poolId, List<String> storagePoolTags) {
39+
TransactionLegacy txn = TransactionLegacy.currentTxn();
40+
41+
txn.start();
42+
SearchCriteria<StoragePoolTagVO> sc = StoragePoolSearch.create();
43+
sc.setParameters("poolId", poolId);
44+
expunge(sc);
45+
46+
for (String tag : storagePoolTags) {
47+
tag = tag.trim();
48+
if (tag.length() > 0) {
49+
StoragePoolTagVO vo = new StoragePoolTagVO(poolId, tag);
50+
persist(vo);
51+
}
52+
}
53+
txn.commit();
54+
}
55+
56+
@Override
57+
public List<String> getStoragePoolTags(long poolId) {
58+
SearchCriteria<StoragePoolTagVO> sc = StoragePoolSearch.create();
59+
sc.setParameters("poolId", poolId);
60+
61+
List<StoragePoolTagVO> results = search(sc, null);
62+
List<String> storagePoolTags = new ArrayList<String>(results.size());
63+
for (StoragePoolTagVO result : results) {
64+
storagePoolTags.add(result.getTag());
65+
}
66+
67+
return storagePoolTags;
68+
}
69+
70+
@Override
71+
public void deleteTags(long poolId) {
72+
TransactionLegacy txn = TransactionLegacy.currentTxn();
73+
txn.start();
74+
SearchCriteria<StoragePoolTagVO> sc = StoragePoolSearch.create();
75+
sc.setParameters("poolId", poolId);
76+
expunge(sc);
77+
txn.commit();
78+
}
79+
80+
}

‎server/src/com/cloud/api/query/dao/ImageStoreJoinDaoImpl.java‎

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@
2424
import org.apache.log4j.Logger;
2525
import org.springframework.stereotype.Component;
2626

27-
import org.apache.cloudstack.api.ApiConstants;
28-
import org.apache.cloudstack.api.response.ImageStoreDetailResponse;
2927
import org.apache.cloudstack.api.response.ImageStoreResponse;
3028
import org.apache.cloudstack.framework.config.dao.ConfigurationDao;
3129

@@ -77,32 +75,12 @@ public ImageStoreResponse newImageStoreResponse(ImageStoreJoinVO ids) {
7775
osResponse.setZoneId(ids.getZoneUuid());
7876
osResponse.setZoneName(ids.getZoneName());
7977

80-
String detailName = ids.getDetailName();
81-
if ( detailName != null && detailName.length() > 0 && !detailName.equals(ApiConstants.PASSWORD)) {
82-
String detailValue = ids.getDetailValue();
83-
if (detailName.equals(ApiConstants.KEY) || detailName.equals(ApiConstants.S3_SECRET_KEY)) {
84-
// ALWAYS return an empty value for the S3 secret key since that key is managed by Amazon and not CloudStack
85-
detailValue = "";
86-
}
87-
ImageStoreDetailResponse osdResponse = new ImageStoreDetailResponse(detailName, detailValue);
88-
osResponse.addDetail(osdResponse);
89-
}
9078
osResponse.setObjectName("imagestore");
9179
return osResponse;
9280
}
9381

9482
@Override
9583
public ImageStoreResponse setImageStoreResponse(ImageStoreResponse response, ImageStoreJoinVO ids) {
96-
String detailName = ids.getDetailName();
97-
if ( detailName != null && detailName.length() > 0 && !detailName.equals(ApiConstants.PASSWORD)) {
98-
String detailValue = ids.getDetailValue();
99-
if (detailName.equals(ApiConstants.KEY) || detailName.equals(ApiConstants.S3_SECRET_KEY)) {
100-
// ALWAYS return an empty value for the S3 secret key since that key is managed by Amazon and not CloudStack
101-
detailValue = "";
102-
}
103-
ImageStoreDetailResponse osdResponse = new ImageStoreDetailResponse(detailName, detailValue);
104-
response.addDetail(osdResponse);
105-
}
10684
return response;
10785
}
10886

‎server/src/com/cloud/api/query/vo/ImageStoreJoinVO.java‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,6 @@ public class ImageStoreJoinVO extends BaseViewVO implements InternalIdentity, Id
7676
@Column(name = "data_center_name")
7777
private String zoneName;
7878

79-
@Column(name = "detail_name")
80-
private String detailName;
81-
82-
@Column(name = "detail_value")
83-
private String detailValue;
84-
8579
@Column(name = GenericDao.REMOVED_COLUMN)
8680
private Date removed;
8781

@@ -127,14 +121,6 @@ public ScopeType getScope() {
127121
return scope;
128122
}
129123

130-
public String getDetailName() {
131-
return detailName;
132-
}
133-
134-
public String getDetailValue() {
135-
return detailValue;
136-
}
137-
138124
public DataStoreRole getRole() {
139125
return role;
140126
}

‎server/src/com/cloud/storage/StorageManagerImpl.java‎

Lines changed: 8 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131
import java.util.List;
3232
import java.util.Map;
3333
import java.util.Random;
34-
import java.util.Set;
3534
import java.util.concurrent.ExecutionException;
3635
import java.util.concurrent.Executors;
3736
import java.util.concurrent.ScheduledExecutorService;
@@ -157,6 +156,7 @@
157156
import com.cloud.storage.dao.DiskOfferingDao;
158157
import com.cloud.storage.dao.SnapshotDao;
159158
import com.cloud.storage.dao.StoragePoolHostDao;
159+
import com.cloud.storage.dao.StoragePoolTagsDao;
160160
import com.cloud.storage.dao.StoragePoolWorkDao;
161161
import com.cloud.storage.dao.VMTemplateDao;
162162
import com.cloud.storage.dao.VMTemplatePoolDao;
@@ -290,6 +290,8 @@ public class StorageManagerImpl extends ManagerBase implements StorageManager, C
290290
ResourceLimitService _resourceLimitMgr;
291291
@Inject
292292
EntityManager _entityMgr;
293+
@Inject
294+
StoragePoolTagsDao _storagePoolTagsDao;
293295

294296
protected List<StoragePoolDiscoverer> _discoverers;
295297

@@ -776,51 +778,18 @@ private void enablePrimaryStoragePool(StoragePoolVO primaryStorage) {
776778
public PrimaryDataStoreInfo updateStoragePool(UpdateStoragePoolCmd cmd) throws IllegalArgumentException {
777779
// Input validation
778780
Long id = cmd.getId();
779-
List<String> tags = cmd.getTags();
780781

781782
StoragePoolVO pool = _storagePoolDao.findById(id);
782783
if (pool == null) {
783784
throw new IllegalArgumentException("Unable to find storage pool with ID: " + id);
784785
}
785786

786-
Map<String, String> updatedDetails = new HashMap<String, String>();
787-
788-
if (tags != null) {
789-
Map<String, String> existingDetails = _storagePoolDetailsDao.listDetailsKeyPairs(id);
790-
Set<String> existingKeys = existingDetails.keySet();
791-
792-
Map<String, String> existingDetailsToKeep = new HashMap<String, String>();
793-
794-
for (String existingKey : existingKeys) {
795-
String existingValue = existingDetails.get(existingKey);
796-
797-
if (!Boolean.TRUE.toString().equalsIgnoreCase(existingValue)) {
798-
existingDetailsToKeep.put(existingKey, existingValue);
799-
}
800-
}
801-
802-
Map<String, String> details = new HashMap<String, String>();
803-
for (String tag : tags) {
804-
tag = tag.trim();
805-
if (tag.length() > 0 && !details.containsKey(tag)) {
806-
details.put(tag, "true");
807-
}
808-
}
809-
810-
Set<String> existingKeysToKeep = existingDetailsToKeep.keySet();
811-
812-
for (String existingKeyToKeep : existingKeysToKeep) {
813-
String existingValueToKeep = existingDetailsToKeep.get(existingKeyToKeep);
814-
815-
if (details.containsKey(existingKeyToKeep)) {
816-
throw new CloudRuntimeException("Storage tag '" + existingKeyToKeep +
817-
"' conflicts with a stored property of this primary storage. No changes were made.");
818-
}
819-
820-
details.put(existingKeyToKeep, existingValueToKeep);
787+
final List<String> storagePoolTags = cmd.getTags();
788+
if (storagePoolTags != null) {
789+
if (s_logger.isDebugEnabled()) {
790+
s_logger.debug("Updating Storage Pool Tags to :" + storagePoolTags);
821791
}
822-
823-
updatedDetails.putAll(details);
792+
_storagePoolTagsDao.persist(pool.getId(), storagePoolTags);
824793
}
825794

826795
Long updatedCapacityBytes = null;
@@ -863,8 +832,6 @@ public PrimaryDataStoreInfo updateStoragePool(UpdateStoragePoolCmd cmd) throws I
863832
} else {
864833
disablePrimaryStoragePool(pool);
865834
}
866-
} else if (updatedDetails.size() >= 0) {
867-
_storagePoolDao.updateDetails(id, updatedDetails);
868835
}
869836

870837
if (updatedCapacityBytes != null) {

0 commit comments

Comments
 (0)