Skip to content

Commit ac2242e

Browse files
shwstpprharikrishna-patnala
shwstppr
and
harikrishna-patnala
authored
api,server,ui: support tags for domains (#11964)
* api,server,ui: support tags for domains Fixes #11608 Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * address copilot comment Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * fix import Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * Added tags support to listDomains API --------- Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com> Co-authored-by: Harikrishna Patnala <harikrishna.patnala@gmail.com>
1 parent f292143 commit ac2242e

7 files changed

Lines changed: 81 additions & 33 deletions

File tree

‎api/src/main/java/com/cloud/server/ResourceTag.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@
1616
// under the License.
1717
package com.cloud.server;
1818

19-
import org.apache.cloudstack.acl.ControlledEntity;
20-
import org.apache.cloudstack.api.Identity;
21-
import org.apache.cloudstack.api.InternalIdentity;
22-
2319
import java.util.HashMap;
2420
import java.util.Locale;
2521
import java.util.Map;
2622

23+
import org.apache.cloudstack.acl.ControlledEntity;
24+
import org.apache.cloudstack.api.Identity;
25+
import org.apache.cloudstack.api.InternalIdentity;
26+
2727
public interface ResourceTag extends ControlledEntity, Identity, InternalIdentity {
2828

2929
// FIXME - extract enum to another interface as its used both by resourceTags and resourceMetaData code
@@ -70,7 +70,7 @@ public enum ResourceObjectType {
7070
GuestOs(false, true),
7171
NetworkOffering(false, true),
7272
VpcOffering(true, false),
73-
Domain(false, false, true),
73+
Domain(true, false, true),
7474
ObjectStore(false, false, true);
7575

7676

‎api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainsCmd.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import org.apache.cloudstack.api.APICommand;
2424
import org.apache.cloudstack.api.ApiConstants;
2525
import org.apache.cloudstack.api.ApiConstants.DomainDetails;
26-
import org.apache.cloudstack.api.BaseListCmd;
26+
import org.apache.cloudstack.api.BaseListTaggedResourcesCmd;
2727
import org.apache.cloudstack.api.Parameter;
2828
import org.apache.cloudstack.api.ResponseObject.ResponseView;
2929
import org.apache.cloudstack.api.command.user.UserCmd;
@@ -39,7 +39,7 @@
3939

4040
@APICommand(name = "listDomains", description = "Lists domains and provides detailed information for listed domains", responseObject = DomainResponse.class, responseView = ResponseView.Restricted, entityType = {Domain.class},
4141
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
42-
public class ListDomainsCmd extends BaseListCmd implements UserCmd {
42+
public class ListDomainsCmd extends BaseListTaggedResourcesCmd implements UserCmd {
4343

4444
private static final String s_name = "listdomainsresponse";
4545

‎api/src/main/java/org/apache/cloudstack/api/response/DomainResponse.java‎

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

19-
import com.google.gson.annotations.SerializedName;
19+
import java.util.Date;
20+
import java.util.List;
21+
import java.util.Map;
22+
import java.util.Set;
2023

2124
import org.apache.cloudstack.api.ApiConstants;
22-
import org.apache.cloudstack.api.BaseResponseWithAnnotations;
25+
import org.apache.cloudstack.api.BaseResponseWithTagInformation;
2326
import org.apache.cloudstack.api.EntityReference;
2427

2528
import com.cloud.domain.Domain;
2629
import com.cloud.serializer.Param;
27-
28-
import java.util.Date;
29-
import java.util.List;
30-
import java.util.Map;
30+
import com.google.gson.annotations.SerializedName;
3131

3232
@EntityReference(value = Domain.class)
33-
public class DomainResponse extends BaseResponseWithAnnotations implements ResourceLimitAndCountResponse, SetResourceIconResponse {
33+
public class DomainResponse extends BaseResponseWithTagInformation implements ResourceLimitAndCountResponse, SetResourceIconResponse {
3434
@SerializedName(ApiConstants.ID)
3535
@Param(description = "The ID of the domain")
3636
private String id;
@@ -589,4 +589,8 @@ public void setDetails(Map<String, String> details) {
589589
public void setTaggedResourceLimitsAndCounts(List<TaggedResourceLimitAndCountResponse> taggedResourceLimitsAndCounts) {
590590
this.taggedResources = taggedResourceLimitsAndCounts;
591591
}
592+
593+
public void setTags(Set<ResourceTagResponse> tags) {
594+
this.tags = tags;
595+
}
592596
}

‎server/src/main/java/com/cloud/api/ApiResponseHelper.java‎

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,19 +39,6 @@
3939

4040
import javax.inject.Inject;
4141

42-
import com.cloud.bgp.ASNumber;
43-
import com.cloud.bgp.ASNumberRange;
44-
import com.cloud.configuration.ConfigurationService;
45-
import com.cloud.dc.ASNumberRangeVO;
46-
import com.cloud.dc.ASNumberVO;
47-
import com.cloud.dc.VlanDetailsVO;
48-
import com.cloud.dc.dao.ASNumberDao;
49-
import com.cloud.dc.dao.ASNumberRangeDao;
50-
import com.cloud.dc.dao.VlanDetailsDao;
51-
import com.cloud.hypervisor.Hypervisor;
52-
import com.cloud.network.vpc.VpcGateway;
53-
import com.cloud.network.vpn.Site2SiteVpnManager;
54-
import com.cloud.storage.BucketVO;
5542
import org.apache.cloudstack.acl.ControlledEntity;
5643
import org.apache.cloudstack.acl.ControlledEntity.ACLType;
5744
import org.apache.cloudstack.affinity.AffinityGroup;
@@ -277,14 +264,19 @@
277264
import com.cloud.api.query.vo.VolumeJoinVO;
278265
import com.cloud.api.query.vo.VpcOfferingJoinVO;
279266
import com.cloud.api.response.ApiResponseSerializer;
267+
import com.cloud.bgp.ASNumber;
268+
import com.cloud.bgp.ASNumberRange;
280269
import com.cloud.capacity.Capacity;
281270
import com.cloud.capacity.CapacityVO;
282271
import com.cloud.capacity.dao.CapacityDaoImpl.SummedCapacity;
283272
import com.cloud.configuration.ConfigurationManager;
273+
import com.cloud.configuration.ConfigurationService;
284274
import com.cloud.configuration.Resource.ResourceOwnerType;
285275
import com.cloud.configuration.Resource.ResourceType;
286276
import com.cloud.configuration.ResourceCount;
287277
import com.cloud.configuration.ResourceLimit;
278+
import com.cloud.dc.ASNumberRangeVO;
279+
import com.cloud.dc.ASNumberVO;
288280
import com.cloud.dc.ClusterDetailsDao;
289281
import com.cloud.dc.ClusterVO;
290282
import com.cloud.dc.DataCenter;
@@ -295,7 +287,11 @@
295287
import com.cloud.dc.StorageNetworkIpRange;
296288
import com.cloud.dc.Vlan;
297289
import com.cloud.dc.Vlan.VlanType;
290+
import com.cloud.dc.VlanDetailsVO;
298291
import com.cloud.dc.VlanVO;
292+
import com.cloud.dc.dao.ASNumberDao;
293+
import com.cloud.dc.dao.ASNumberRangeDao;
294+
import com.cloud.dc.dao.VlanDetailsDao;
299295
import com.cloud.domain.Domain;
300296
import com.cloud.domain.DomainVO;
301297
import com.cloud.event.Event;
@@ -304,6 +300,7 @@
304300
import com.cloud.host.ControlState;
305301
import com.cloud.host.Host;
306302
import com.cloud.host.HostVO;
303+
import com.cloud.hypervisor.Hypervisor;
307304
import com.cloud.hypervisor.HypervisorCapabilities;
308305
import com.cloud.network.GuestVlan;
309306
import com.cloud.network.GuestVlanRange;
@@ -367,9 +364,11 @@
367364
import com.cloud.network.vpc.PrivateGateway;
368365
import com.cloud.network.vpc.StaticRoute;
369366
import com.cloud.network.vpc.Vpc;
367+
import com.cloud.network.vpc.VpcGateway;
370368
import com.cloud.network.vpc.VpcOffering;
371369
import com.cloud.network.vpc.VpcVO;
372370
import com.cloud.network.vpc.dao.VpcOfferingDao;
371+
import com.cloud.network.vpn.Site2SiteVpnManager;
373372
import com.cloud.offering.DiskOffering;
374373
import com.cloud.offering.NetworkOffering;
375374
import com.cloud.offering.NetworkOffering.Detail;
@@ -388,6 +387,7 @@
388387
import com.cloud.server.ResourceTag;
389388
import com.cloud.server.ResourceTag.ResourceObjectType;
390389
import com.cloud.service.ServiceOfferingVO;
390+
import com.cloud.storage.BucketVO;
391391
import com.cloud.storage.DataStoreRole;
392392
import com.cloud.storage.DiskOfferingVO;
393393
import com.cloud.storage.GuestOS;
@@ -586,6 +586,7 @@ public DomainResponse createDomainResponse(Domain domain) {
586586
if (domain.getChildCount() > 0) {
587587
domainResponse.setHasChild(true);
588588
}
589+
populateDomainTags(domain.getUuid(), domainResponse);
589590
domainResponse.setObjectName("domain");
590591
return domainResponse;
591592
}
@@ -3048,6 +3049,20 @@ public static void populateOwner(ControlledViewEntityResponse response, Controll
30483049
response.setDomainPath(getPrettyDomainPath(object.getDomainPath()));
30493050
}
30503051

3052+
public static void populateDomainTags(String domainUuid, DomainResponse domainResponse) {
3053+
List<ResourceTagJoinVO> tags = ApiDBUtils.listResourceTagViewByResourceUUID(domainUuid,
3054+
ResourceTag.ResourceObjectType.Domain);
3055+
if (CollectionUtils.isEmpty(tags)) {
3056+
return;
3057+
}
3058+
Set<ResourceTagResponse> tagResponses = new HashSet<>();
3059+
for (ResourceTagJoinVO tag : tags) {
3060+
ResourceTagResponse tagResponse = ApiDBUtils.newResourceTagResponse(tag, true);
3061+
tagResponses.add(tagResponse);
3062+
}
3063+
domainResponse.setTags(tagResponses);
3064+
}
3065+
30513066
private void populateAccount(ControlledEntityResponse response, long accountId) {
30523067
Account account = ApiDBUtils.findAccountById(accountId);
30533068
if (account == null) {

‎server/src/main/java/com/cloud/api/query/QueryManagerImpl.java‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2860,6 +2860,7 @@ private Pair<List<Long>, Integer> searchForDomainIdsAndCount(ListDomainsCmd cmd)
28602860
boolean listAll = cmd.listAll();
28612861
boolean isRecursive = false;
28622862
Domain domain = null;
2863+
Map<String, String> tags = cmd.getTags();
28632864

28642865
if (domainId != null) {
28652866
domain = _domainDao.findById(domainId);
@@ -2889,6 +2890,24 @@ private Pair<List<Long>, Integer> searchForDomainIdsAndCount(ListDomainsCmd cmd)
28892890
domainSearchBuilder.and("path", domainSearchBuilder.entity().getPath(), SearchCriteria.Op.LIKE);
28902891
domainSearchBuilder.and("state", domainSearchBuilder.entity().getState(), SearchCriteria.Op.EQ);
28912892

2893+
if (MapUtils.isNotEmpty(tags)) {
2894+
SearchBuilder<ResourceTagVO> resourceTagSearch = resourceTagDao.createSearchBuilder();
2895+
resourceTagSearch.and("resourceType", resourceTagSearch.entity().getResourceType(), Op.EQ);
2896+
resourceTagSearch.and().op();
2897+
for (int count = 0; count < tags.size(); count++) {
2898+
if (count == 0) {
2899+
resourceTagSearch.op("tagKey" + count, resourceTagSearch.entity().getKey(), Op.EQ);
2900+
} else {
2901+
resourceTagSearch.or().op("tagKey" + count, resourceTagSearch.entity().getKey(), Op.EQ);
2902+
}
2903+
resourceTagSearch.and("tagValue" + count, resourceTagSearch.entity().getValue(), Op.EQ);
2904+
resourceTagSearch.cp();
2905+
}
2906+
resourceTagSearch.cp();
2907+
2908+
domainSearchBuilder.join("tags", resourceTagSearch, resourceTagSearch.entity().getResourceId(), domainSearchBuilder.entity().getId(), JoinBuilder.JoinType.INNER);
2909+
}
2910+
28922911
if (keyword != null) {
28932912
domainSearchBuilder.and("keywordName", domainSearchBuilder.entity().getName(), SearchCriteria.Op.LIKE);
28942913
}
@@ -2918,6 +2937,16 @@ private Pair<List<Long>, Integer> searchForDomainIdsAndCount(ListDomainsCmd cmd)
29182937
}
29192938
}
29202939

2940+
if (MapUtils.isNotEmpty(tags)) {
2941+
int count = 0;
2942+
sc.setJoinParameters("tags", "resourceType", ResourceObjectType.Domain);
2943+
for (Map.Entry<String, String> entry : tags.entrySet()) {
2944+
sc.setJoinParameters("tags", "tagKey" + count, entry.getKey());
2945+
sc.setJoinParameters("tags", "tagValue" + count, entry.getValue());
2946+
count++;
2947+
}
2948+
}
2949+
29212950
// return only Active domains to the API
29222951
sc.setParameters("state", Domain.State.Active);
29232952

‎server/src/main/java/com/cloud/api/query/dao/DomainJoinDaoImpl.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,8 @@
2020
import java.util.EnumSet;
2121
import java.util.List;
2222

23+
import javax.inject.Inject;
2324

24-
import com.cloud.api.ApiResponseHelper;
25-
import com.cloud.configuration.Resource;
26-
import com.cloud.user.AccountManager;
2725
import org.apache.cloudstack.annotation.AnnotationService;
2826
import org.apache.cloudstack.annotation.dao.AnnotationDao;
2927
import org.apache.cloudstack.api.ApiConstants.DomainDetails;
@@ -35,15 +33,16 @@
3533
import org.springframework.stereotype.Component;
3634

3735
import com.cloud.api.ApiDBUtils;
36+
import com.cloud.api.ApiResponseHelper;
3837
import com.cloud.api.query.vo.DomainJoinVO;
38+
import com.cloud.configuration.Resource;
3939
import com.cloud.configuration.Resource.ResourceType;
4040
import com.cloud.domain.Domain;
41+
import com.cloud.user.AccountManager;
4142
import com.cloud.utils.db.GenericDaoBase;
4243
import com.cloud.utils.db.SearchBuilder;
4344
import com.cloud.utils.db.SearchCriteria;
4445

45-
import javax.inject.Inject;
46-
4746
@Component
4847
public class DomainJoinDaoImpl extends GenericDaoBase<DomainJoinVO, Long> implements DomainJoinDao {
4948

@@ -110,6 +109,7 @@ public DomainResponse newDomainResponse(ResponseView view, EnumSet<DomainDetails
110109
}
111110

112111
domainResponse.setDetails(ApiDBUtils.getDomainDetails(domain.getId()));
112+
ApiResponseHelper.populateDomainTags(domain.getUuid(), domainResponse);
113113
domainResponse.setObjectName("domain");
114114

115115
return domainResponse;

‎ui/src/components/view/InfoCard.vue‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1094,7 +1094,7 @@ export default {
10941094
return ['UserVm', 'Template', 'ISO', 'Volume', 'Snapshot', 'Backup', 'Network',
10951095
'LoadBalancer', 'PortForwardingRule', 'FirewallRule', 'SecurityGroup', 'SecurityGroupRule',
10961096
'PublicIpAddress', 'Project', 'Account', 'Vpc', 'NetworkACL', 'StaticRoute', 'VMSnapshot',
1097-
'RemoteAccessVpn', 'User', 'SnapshotPolicy', 'VpcOffering']
1097+
'RemoteAccessVpn', 'User', 'SnapshotPolicy', 'VpcOffering', 'Domain']
10981098
},
10991099
name () {
11001100
return this.resource.displayname || this.resource.name || this.resource.displaytext || this.resource.username ||

0 commit comments

Comments
 (0)