apache · nvazquez · Sep 15, 2021 · Jun 14, 2021 · Jun 16, 2021 · Jun 17, 2021
diff --git a/api/src/main/java/com/cloud/event/EventTypes.java b/api/src/main/java/com/cloud/event/EventTypes.java
@@ -493,6 +493,10 @@ public class EventTypes {
     public static final String EVENT_TAGS_CREATE = "CREATE_TAGS";
     public static final String EVENT_TAGS_DELETE = "DELETE_TAGS";
 
+    // resource icon related events
+    public static final String EVENT_RESOURCE_ICON_UPLOAD = "UPLOAD.RESOURCE.ICON";
+    public static final String EVENT_RESOURCE_ICON_DELETE = "DELETE.RESOURCE.ICON";
+
     // meta data related events
     public static final String EVENT_RESOURCE_DETAILS_CREATE = "CREATE_RESOURCE_DETAILS";
     public static final String EVENT_RESOURCE_DETAILS_DELETE = "DELETE_RESOURCE_DETAILS";

diff --git a/api/src/main/java/com/cloud/server/ResourceIcon.java b/api/src/main/java/com/cloud/server/ResourceIcon.java
@@ -0,0 +1,32 @@
+// 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 com.cloud.server;
+
+import org.apache.cloudstack.api.Identity;
+import org.apache.cloudstack.api.InternalIdentity;
+
+public interface ResourceIcon extends Identity, InternalIdentity {
+    long getResourceId();
+
+    void setResourceId(long resourceId);
+
+    ResourceTag.ResourceObjectType getResourceType();
+
+    String getResourceUuid();
+
+    String getIcon();
+}
diff --git a/api/src/main/java/com/cloud/server/ResourceIconManager.java b/api/src/main/java/com/cloud/server/ResourceIconManager.java
@@ -0,0 +1,28 @@
+// 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 com.cloud.server;
+
+import java.util.List;
+
+public interface ResourceIconManager {
+
+    boolean uploadResourceIcon(List<String> resourceIds, ResourceTag.ResourceObjectType resourceType, String base64Image);
+
+    boolean deleteResourceIcon(List<String> resourceIds, ResourceTag.ResourceObjectType resourceType);
+
+    ResourceIcon getByResourceTypeAndUuid(ResourceTag.ResourceObjectType type, String resourceId);
+}
diff --git a/api/src/main/java/com/cloud/server/ResourceManagerUtil.java b/api/src/main/java/com/cloud/server/ResourceManagerUtil.java
@@ -0,0 +1,24 @@
+// 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 com.cloud.server;
+
+public interface ResourceManagerUtil {
+    long getResourceId(String resourceId, ResourceTag.ResourceObjectType resourceType);
+    String getUuid(String resourceId, ResourceTag.ResourceObjectType resourceType);
+    ResourceTag.ResourceObjectType getResourceType(String resourceTypeStr);
+    void checkResourceAccessible(Long accountId, Long domainId, String exceptionMessage);
+}
diff --git a/api/src/main/java/com/cloud/server/ResourceTag.java b/api/src/main/java/com/cloud/server/ResourceTag.java
@@ -24,36 +24,36 @@ public interface ResourceTag extends ControlledEntity, Identity, InternalIdentit
 
     // FIXME - extract enum to another interface as its used both by resourceTags and resourceMetaData code
     public enum ResourceObjectType {
-        UserVm(true, true),
-        Template(true, true),
-        ISO(true, false),
+        UserVm(true, true, true),
+        Template(true, true, true),
+        ISO(true, false, true),
         Volume(true, true),
         Snapshot(true, false),
         Backup(true, false),
-        Network(true, true),
+        Network(true, true, true),
         Nic(false, true),
         LoadBalancer(true, true),
         PortForwardingRule(true, true),
         FirewallRule(true, true),
         SecurityGroup(true, false),
         SecurityGroupRule(true, false),
         PublicIpAddress(true, true),
-        Project(true, false),
-        Account(true, false),
-        Vpc(true, true),
+        Project(true, false, true),
+        Account(true, false, true),
+        Vpc(true, true, true),
         NetworkACL(true, true),
         StaticRoute(true, false),
         VMSnapshot(true, false),
         RemoteAccessVpn(true, true),
-        Zone(false, true),
+        Zone(false, true, true),
         ServiceOffering(false, true),
         Storage(false, true),
         PrivateGateway(false, true),
         NetworkACLList(false, true),
         VpnGateway(false, true),
         CustomerGateway(false, true),
         VpnConnection(false, true),
-        User(true, true),
+        User(true, true, true),
         DiskOffering(false, true),
         AutoScaleVmProfile(false, true),
         AutoScaleVmGroup(false, true),
@@ -62,16 +62,23 @@ public enum ResourceObjectType {
         SnapshotPolicy(true, true),
         GuestOs(false, true),
         NetworkOffering(false, true),
-        VpcOffering(true, false);
+        VpcOffering(true, false),
+        Domain(false, false, true);
 
 
         ResourceObjectType(boolean resourceTagsSupport, boolean resourceMetadataSupport) {
             this.resourceTagsSupport = resourceTagsSupport;
             metadataSupport = resourceMetadataSupport;
         }
 
+        ResourceObjectType(boolean resourceTagsSupport, boolean resourceMetadataSupport, boolean resourceIconSupport) {
+            this(resourceTagsSupport, resourceMetadataSupport);
+            this.resourceIconSupport = resourceIconSupport;
+        }
+
         private final boolean resourceTagsSupport;
         private final boolean metadataSupport;
+        private boolean resourceIconSupport;
 
         public boolean resourceTagsSupport() {
             return resourceTagsSupport;
@@ -80,6 +87,10 @@ public boolean resourceTagsSupport() {
         public boolean resourceMetadataSupport() {
             return metadataSupport;
         }
+
+        public boolean resourceIconSupport() {
+            return resourceIconSupport;
+        }
     }
 
     /**

diff --git a/api/src/main/java/com/cloud/server/TaggedResourceService.java b/api/src/main/java/com/cloud/server/TaggedResourceService.java
@@ -43,18 +43,6 @@ public interface TaggedResourceService {
 
     List<? extends ResourceTag> listByResourceTypeAndId(ResourceObjectType type, long resourceId);
 
-    //FIXME - the methods below should be extracted to its separate manager/service responsible just for retrieving object details
-    ResourceObjectType getResourceType(String resourceTypeStr);
-
-    /**
-     * @param resourceId
-     * @param resourceType
-     * @return
-     */
-    String getUuid(String resourceId, ResourceObjectType resourceType);
-
-    public long getResourceId(String resourceId, ResourceObjectType resourceType);
-
     /**
      * Retrieves tags from resource.
      * @param type

diff --git a/api/src/main/java/org/apache/cloudstack/api/ApiConstants.java b/api/src/main/java/org/apache/cloudstack/api/ApiConstants.java
@@ -37,6 +37,7 @@ public class ApiConstants {
     public static final String BACKUP_ID = "backupid";
     public static final String BACKUP_OFFERING_NAME = "backupofferingname";
     public static final String BACKUP_OFFERING_ID = "backupofferingid";
+    public static final String BASE64_IMAGE = "base64image";
     public static final String BITS = "bits";
     public static final String BOOTABLE = "bootable";
     public static final String BIND_DN = "binddn";
@@ -333,6 +334,7 @@ public class ApiConstants {
     public static final String SESSIONKEY = "sessionkey";
     public static final String SHOW_CAPACITIES = "showcapacities";
     public static final String SHOW_REMOVED = "showremoved";
+    public static final String SHOW_RESOURCE_ICON = "showicon";
     public static final String SHOW_UNIQUE = "showunique";
     public static final String SIGNATURE = "signature";
     public static final String SIGNATURE_VERSION = "signatureversion";
@@ -747,6 +749,7 @@ public class ApiConstants {
     public static final String ACCESS_TYPE = "accesstype";
 
     public static final String RESOURCE_DETAILS = "resourcedetails";
+    public static final String RESOURCE_ICON = "icon";
     public static final String EXPUNGE = "expunge";
     public static final String FOR_DISPLAY = "fordisplay";
     public static final String PASSIVE = "passive";

diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseCmd.java b/api/src/main/java/org/apache/cloudstack/api/BaseCmd.java
@@ -29,6 +29,11 @@
 
 import javax.inject.Inject;
 
+import com.cloud.server.ManagementService;
+import com.cloud.server.ResourceIconManager;
+import com.cloud.server.ResourceManagerUtil;
+import com.cloud.server.ResourceMetaDataService;
+import com.cloud.server.TaggedResourceService;
 import org.apache.cloudstack.acl.ProjectRoleService;
 import org.apache.cloudstack.acl.RoleService;
 import org.apache.cloudstack.acl.RoleType;
@@ -67,9 +72,6 @@
 import com.cloud.network.vpn.Site2SiteVpnService;
 import com.cloud.projects.ProjectService;
 import com.cloud.resource.ResourceService;
-import com.cloud.server.ManagementService;
-import com.cloud.server.ResourceMetaDataService;
-import com.cloud.server.TaggedResourceService;
 import com.cloud.storage.DataStoreProviderApiService;
 import com.cloud.storage.StorageService;
 import com.cloud.storage.VolumeApiService;
@@ -164,6 +166,8 @@ public static enum CommandType {
     @Inject
     public TaggedResourceService _taggedResourceService;
     @Inject
+    public ResourceManagerUtil resourceManagerUtil;
+    @Inject
     public ResourceMetaDataService _resourceMetaDataService;
     @Inject
     public VpcService _vpcService;
@@ -201,6 +205,8 @@ public static enum CommandType {
     public UUIDManager _uuidMgr;
     @Inject
     public AnnotationService annotationService;
+    @Inject
+    public ResourceIconManager resourceIconManager;
 
     public abstract void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException,
         ResourceAllocationException, NetworkRuleConflictException;

diff --git a/api/src/main/java/org/apache/cloudstack/api/ResponseGenerator.java b/api/src/main/java/org/apache/cloudstack/api/ResponseGenerator.java
@@ -22,6 +22,8 @@
 import java.util.Map;
 import java.util.Set;
 
+import com.cloud.server.ResourceIcon;
+import org.apache.cloudstack.api.response.ResourceIconResponse;
 import org.apache.cloudstack.api.response.RouterHealthCheckResultResponse;
 import com.cloud.resource.RollingMaintenanceManager;
 import org.apache.cloudstack.api.response.RollingMaintenanceResponse;
@@ -270,7 +272,7 @@ public interface ResponseGenerator {
 
     PodResponse createPodResponse(Pod pod, Boolean showCapacities);
 
-    ZoneResponse createZoneResponse(ResponseView view, DataCenter dataCenter, Boolean showCapacities);
+    ZoneResponse createZoneResponse(ResponseView view, DataCenter dataCenter, Boolean showCapacities, Boolean showResourceIcon);
 
     VolumeResponse createVolumeResponse(ResponseView view, Volume volume);
 
@@ -487,4 +489,6 @@ List<TemplateResponse> createTemplateResponses(ResponseView view, VirtualMachine
 
     RollingMaintenanceResponse createRollingMaintenanceResponse(Boolean success, String details, List<RollingMaintenanceManager.HostUpdated> hostsUpdated, List<RollingMaintenanceManager.HostSkipped> hostsSkipped);
 
+    ResourceIconResponse createResourceIconResponse(ResourceIcon resourceIcon);
+
 }
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainChildrenCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainChildrenCmd.java
@@ -19,6 +19,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import com.cloud.server.ResourceIcon;
+import com.cloud.server.ResourceTag;
+import org.apache.cloudstack.api.response.ResourceIconResponse;
 import org.apache.log4j.Logger;
 
 import org.apache.cloudstack.api.APICommand;
@@ -58,6 +61,10 @@ public class ListDomainChildrenCmd extends BaseListCmd {
                description = "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false")
     private Boolean listAll;
 
+    @Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN,
+            description = "flag to display the resource icon for domains")
+    private Boolean showIcon;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -78,6 +85,10 @@ public boolean isRecursive() {
         return recursive == null ? false : recursive;
     }
 
+    public Boolean getShowIcon() {
+        return showIcon != null ? showIcon : false;
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////
@@ -100,6 +111,20 @@ public void execute() {
 
         response.setResponses(domainResponses, result.second());
         response.setResponseName(getCommandName());
+        if (response != null && response.getCount() > 0 && getShowIcon()) {
+            updateDomainResponse(response.getResponses());
+        }
         this.setResponseObject(response);
     }
+
+    private void updateDomainResponse(List<DomainResponse> response) {
+        for (DomainResponse domainResponse : response) {
+            ResourceIcon resourceIcon = resourceIconManager.getByResourceTypeAndUuid(ResourceTag.ResourceObjectType.Domain, domainResponse.getId());
+            if (resourceIcon == null) {
+                continue;
+            }
+            ResourceIconResponse iconResponse = _responseGenerator.createResourceIconResponse(resourceIcon);
+            domainResponse.setResourceIconResponse(iconResponse);
+        }
+    }
 }
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainsCmd.java
@@ -20,6 +20,9 @@
 import java.util.EnumSet;
 import java.util.List;
 
+import com.cloud.server.ResourceIcon;
+import com.cloud.server.ResourceTag;
+import org.apache.cloudstack.api.response.ResourceIconResponse;
 import org.apache.log4j.Logger;
 
 import org.apache.cloudstack.api.APICommand;
@@ -66,6 +69,10 @@ public class ListDomainsCmd extends BaseListCmd implements UserCmd {
                description = "comma separated list of domain details requested, value can be a list of [ all, resource, min]")
     private List<String> viewDetails;
 
+    @Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN,
+            description = "flag to display the resource icon for domains")
+    private Boolean showIcon;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -105,6 +112,10 @@ public EnumSet<DomainDetails> getDetails() throws InvalidParameterValueException
         return dv;
     }
 
+    public Boolean getShowIcon() {
+        return showIcon != null ? showIcon : false;
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////
@@ -119,5 +130,19 @@ public void execute() {
         ListResponse<DomainResponse> response = _queryService.searchForDomains(this);
         response.setResponseName(getCommandName());
         this.setResponseObject(response);
+        if (response != null && response.getCount() > 0 && getShowIcon()) {
+            updateDomainResponse(response.getResponses());
+        }
+    }
+
+    private void updateDomainResponse(List<DomainResponse> response) {
+        for (DomainResponse domainResponse : response) {
+            ResourceIcon resourceIcon = resourceIconManager.getByResourceTypeAndUuid(ResourceTag.ResourceObjectType.Domain, domainResponse.getId());
+            if (resourceIcon == null) {
+                continue;
+            }
+            ResourceIconResponse iconResponse = _responseGenerator.createResourceIconResponse(resourceIcon);
+            domainResponse.setResourceIconResponse(iconResponse);
+        }
     }
 }