enhance messages and normalize terms

erikbocks · erikbocks · commit 2b5b429c0000 · 2026-01-22T08:57:07.000-03:00
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForClusterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForClusterCmd.java
@@ -103,6 +103,6 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Enable HA for cluster with ID: " + getResourceUuid(ApiConstants.CLUSTER_ID);
+        return "Enabling HA for cluster with ID: " + getResourceUuid(ApiConstants.CLUSTER_ID);
     }
 }
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateManagementNetworkIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateManagementNetworkIpRangeCmd.java
@@ -132,7 +132,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Creating management ip range from " + getStartIp() + " to " + getEndIp() + ", with gateway: " + getGateWay() + ", netmask:" + getNetmask() + " of pod:" + getPodId();
+        return "Creating management IP range from " + getStartIp() + " to " + getEndIp() + ", with gateway: " + getGateWay() + ", netmask:" + getNetmask() + " on pod:" + getPodId();
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DedicateIpv4SubnetForZoneCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DedicateIpv4SubnetForZoneCmd.java
@@ -82,7 +82,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Dedicating zone IPv4 subnet " + getResourceUuid(ApiConstants.ID);
+        return "Dedicating zone's IPv4 subnet with ID: " + getResourceUuid(ApiConstants.ID);
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteManagementNetworkIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteManagementNetworkIpRangeCmd.java
@@ -100,7 +100,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Deleting management ip range from " + getStartIp() + " to " + getEndIp() + " from Pod: " + getResourceUuid(ApiConstants.POD_ID);
+        return "Deleting management IP range from " + getStartIp() + " to " + getEndIp() + " from Pod: " + getResourceUuid(ApiConstants.POD_ID);
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteStorageNetworkIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteStorageNetworkIpRangeCmd.java
@@ -64,7 +64,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Deleting storage ip range with ID: " + getResourceUuid(ApiConstants.ID);
+        return "Deleting storage IP range with ID: " + getResourceUuid(ApiConstants.ID);
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/MigrateNetworkCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/MigrateNetworkCmd.java
@@ -115,7 +115,7 @@ public void execute() {
 
     @Override
     public String getEventDescription() {
-        StringBuilder eventMsg = new StringBuilder("Migrating network: " + getResourceUuid(ApiConstants.NETWORK_ID));
+        StringBuilder eventMsg = new StringBuilder("Migrating network with ID: " + getResourceUuid(ApiConstants.NETWORK_ID));
         if (getNetworkOfferingId() != null) {
             Network network = _networkService.getNetwork(getId());
             if (network == null) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/bgp/ChangeBgpPeersForVpcCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/bgp/ChangeBgpPeersForVpcCmd.java
@@ -80,7 +80,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Changing bgp Peers for VPC with ID: " + getResourceUuid(ApiConstants.VPC_ID);
+        return "Changing BGP Peers for VPC with ID: " + getResourceUuid(ApiConstants.VPC_ID);
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForHostCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForHostCmd.java
@@ -94,7 +94,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Disable out-of-band management password for host with ID: " + getResourceUuid(ApiConstants.HOST_ID);
+        return "Disabling out-of-band management password for host with ID: " + getResourceUuid(ApiConstants.HOST_ID);
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForClusterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForClusterCmd.java
@@ -93,7 +93,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Enable out-of-band management password for cluster with ID: " + getResourceUuid(ApiConstants.CLUSTER_ID);
+        return "Enabling out-of-band management password for cluster with ID: " + getResourceUuid(ApiConstants.CLUSTER_ID);
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/PatchSystemVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/PatchSystemVMCmd.java
@@ -71,7 +71,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return String.format("Attempting to live patch System VM with Id: %s ", getResourceUuid(ApiConstants.ID));
+        return String.format("Attempting to live patch System VM with ID: %s ", getResourceUuid(ApiConstants.ID));
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/DeleteVPCOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/DeleteVPCOfferingCmd.java
@@ -76,7 +76,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Deleting VPC offering with id: " + getResourceUuid(ApiConstants.ID);
+        return "Deleting VPC offering with ID: " + getResourceUuid(ApiConstants.ID);
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ExtractIsoCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ExtractIsoCmd.java
@@ -101,14 +101,13 @@ public long getEntityOwnerId() {
 
     @Override
     public String getEventDescription() {
-        String baseDescription = "Extracting ISO: " +  getResourceUuid(ApiConstants.ID);
+        String description = "Extracting ISO: " +  getResourceUuid(ApiConstants.ID);
 
-        Long zoneId = getZoneId();
-        if (zoneId == null) {
-            return baseDescription;
+        if (getZoneId() == null) {
+            description += "from zone: " + getResourceUuid(ApiConstants.ZONE_ID);
         }
 
-        return String.format("%s from zone: %s", baseDescription, getResourceUuid(ApiConstants.ZONE_ID));
+        return description;
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ReplaceNetworkACLListCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ReplaceNetworkACLListCmd.java
@@ -76,7 +76,13 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Associating network ACL with ID:" + getResourceUuid(ApiConstants.ACL_ID) + " with network with ID:" + getResourceUuid(ApiConstants.NETWORK_ID);
+        String description = "Associating network ACL with ID:" + getResourceUuid(ApiConstants.ACL_ID);
+
+        if (getNetworkId() != null) {
+            description += " to network with ID:" + getResourceUuid(ApiConstants.NETWORK_ID);
+        }
+
+        return description;
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/template/CopyTemplateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/template/CopyTemplateCmd.java
@@ -136,19 +136,21 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        StringBuilder descBuilder = new StringBuilder();
-        if (getDestinationZoneIds() != null) {
+        StringBuilder descBuilder = new StringBuilder("Copying template: " + getResourceUuid(ApiConstants.ID));
+
+        if (getSourceZoneId() != null) {
+            descBuilder.append(" from zone: ").append(getResourceUuid(ApiConstants.SOURCE_ZONE_ID));
+        }
 
+        if (getDestinationZoneIds() != null) {
+            descBuilder.append(" to zones: ");
             for (Long destId : getDestinationZoneIds()) {
-                descBuilder.append(", ");
                 descBuilder.append(this._uuidMgr.getUuid(DataCenter.class, destId));
-            }
-            if (descBuilder.length() > 0) {
-                descBuilder.deleteCharAt(0);
+                descBuilder.append(", ");
             }
         }
 
-        return  "Copying Template: " + getResourceUuid(ApiConstants.ID) + ((getSourceZoneId() != null) ? " from zone: " + getResourceUuid(ApiConstants.SOURCE_ZONE_ID) : "") + ((descBuilder.length() > 0) ? " to zones: " + descBuilder.toString() : "");
+        return descBuilder.toString();
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/AddNicToVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/AddNicToVMCmd.java
@@ -121,7 +121,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Adding network " + getResourceUuid(ApiConstants.NETWORK_ID) + " to User Instance: " + getResourceUuid(ApiConstants.VIRTUAL_MACHINE_ID);
+        return "Adding NIC on network " + getResourceUuid(ApiConstants.NETWORK_ID) + " to User Instance: " + getResourceUuid(ApiConstants.VIRTUAL_MACHINE_ID);
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RestoreVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RestoreVMCmd.java
@@ -90,7 +90,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Restore Instance with ID: " + getResourceUuid(ApiConstants.VIRTUAL_MACHINE_ID) + " to original Template or specific Snapshot";
+        return "Restoring Instance with ID: " + getResourceUuid(ApiConstants.VIRTUAL_MACHINE_ID) + " to original Template or specific Snapshot";
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateDefaultNicForVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateDefaultNicForVMCmd.java
@@ -90,7 +90,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return  "Updating NIC " + getResourceUuid(ApiConstants.NIC_ID) + " on User Instance: " + getResourceUuid(ApiConstants.VIRTUAL_MACHINE_ID);
+        return "Setting NIC " + getResourceUuid(ApiConstants.NIC_ID) + " as default to User Instance: " + getResourceUuid(ApiConstants.VIRTUAL_MACHINE_ID);
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/CreateVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/CreateVolumeCmd.java
@@ -203,7 +203,11 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        String description = "Creating volume: " + getVolumeName();
+        String description = "Creating volume ";
+
+        if (getVolumeName() != null) {
+            description += getVolumeName();
+        }
 
         if (getSnapshotId() != null) {
             description += " from Snapshot: " + getResourceUuid(ApiConstants.SNAPSHOT_ID);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DetachVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DetachVolumeCmd.java
@@ -126,15 +126,17 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        StringBuilder sb = new StringBuilder();
+        StringBuilder sb = new StringBuilder("Detaching volume");
+
         if (id != null) {
-            sb.append(": " + getResourceUuid(ApiConstants.ID));
+            sb.append(": ").append(getResourceUuid(ApiConstants.ID));
         } else if ((deviceId != null) && (virtualMachineId != null)) {
             sb.append(" with device id: " + deviceId + " from Instance: " + ((getVirtualMachineId() != null) ? getResourceUuid(ApiConstants.VIRTUAL_MACHINE_ID) : ""));
         } else {
             sb.append(" <error:  either volume id or deviceId/vmId need to be specified>");
         }
-        return  "detaching volume" + sb.toString();
+
+        return  sb.toString();
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/UploadVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/UploadVolumeCmd.java
@@ -168,7 +168,7 @@ public long getEntityOwnerId() {
 
     @Override
     public String getEventDescription() {
-        return  "Uploading volume: " + getVolumeName() + " in the zone with ID: " + getResourceUuid(ApiConstants.ZONE_ID);
+        return  "Uploading volume: " + getVolumeName() + " to zone with ID: " + getResourceUuid(ApiConstants.ZONE_ID);
     }
 
     @Override
diff --git a/plugins/hypervisors/baremetal/src/main/java/org/apache/cloudstack/api/AddBaremetalPxeCmd.java b/plugins/hypervisors/baremetal/src/main/java/org/apache/cloudstack/api/AddBaremetalPxeCmd.java
@@ -72,7 +72,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Adding an external pxe server to physical network with ID: " + getResourceUuid(ApiConstants.PHYSICAL_NETWORK_ID);
+        return "Adding an external PXE server to physical network with ID: " + getResourceUuid(ApiConstants.PHYSICAL_NETWORK_ID);
     }
 
     @Override
diff --git a/plugins/network-elements/netscaler/src/main/java/com/cloud/api/commands/DeleteNetscalerLoadBalancerCmd.java b/plugins/network-elements/netscaler/src/main/java/com/cloud/api/commands/DeleteNetscalerLoadBalancerCmd.java
@@ -88,7 +88,7 @@ public void execute() throws ResourceUnavailableException, InsufficientCapacityE
 
     @Override
     public String getEventDescription() {
-        return "Deleting netscaler load balancer device with ID: " + getResourceUuid(ApiConstants.LOAD_BALANCER_DEVICE_ID);
+        return "Deleting NetScaler load balancer device with ID: " + getResourceUuid(ApiConstants.LOAD_BALANCER_DEVICE_ID);
     }
 
     @Override
diff --git a/plugins/network-elements/netscaler/src/main/java/com/cloud/api/commands/DeployNetscalerVpxCmd.java b/plugins/network-elements/netscaler/src/main/java/com/cloud/api/commands/DeployNetscalerVpxCmd.java
@@ -117,7 +117,7 @@ public Long getTemplateId() {
 
     @Override
     public String getEventDescription() {
-        return "Adding a netscaler load balancer device in zone: " + getResourceUuid(ApiConstants.ZONE_ID) ;
+        return "Adding a NetScaler load balancer device in zone: " + getResourceUuid(ApiConstants.ZONE_ID) ;
     }
 
     @Override
diff --git a/plugins/network-elements/netscaler/src/main/java/com/cloud/api/commands/StopNetScalerVMCmd.java b/plugins/network-elements/netscaler/src/main/java/com/cloud/api/commands/StopNetScalerVMCmd.java
@@ -91,7 +91,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Stopping Netscaler VM with ID: " + getResourceUuid(ApiConstants.ID);
+        return "Stopping NetScaler VM with ID: " + getResourceUuid(ApiConstants.ID);
     }
 
     @Override
diff --git a/plugins/network-elements/nicira-nvp/src/main/java/com/cloud/api/commands/DeleteNiciraNvpDeviceCmd.java b/plugins/network-elements/nicira-nvp/src/main/java/com/cloud/api/commands/DeleteNiciraNvpDeviceCmd.java
@@ -100,7 +100,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Deleting Nicira Nvp Controller with ID: " + getResourceUuid(ApiConstants.NICIRA_NVP_DEVICE_ID);
+        return "Deleting Nicira NVP Controller with ID: " + getResourceUuid(ApiConstants.NICIRA_NVP_DEVICE_ID);
     }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,6 @@ public String getEventType() {`
`103`	`103`
`104`	`104`	`@Override`
`105`	`105`	`public String getEventDescription() {`
`106`		`- return "Enable HA for cluster with ID: " + getResourceUuid(ApiConstants.CLUSTER_ID);`
	`106`	`+ return "Enabling HA for cluster with ID: " + getResourceUuid(ApiConstants.CLUSTER_ID);`
`107`	`107`	`}`
`108`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,7 @@ public String getEventType() {`
`132`	`132`
`133`	`133`	`@Override`
`134`	`134`	`public String getEventDescription() {`
`135`		`- return "Creating management ip range from " + getStartIp() + " to " + getEndIp() + ", with gateway: " + getGateWay() + ", netmask:" + getNetmask() + " of pod:" + getPodId();`
	`135`	`+ return "Creating management IP range from " + getStartIp() + " to " + getEndIp() + ", with gateway: " + getGateWay() + ", netmask:" + getNetmask() + " on pod:" + getPodId();`
`136`	`136`	`}`
`137`	`137`
`138`	`138`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ public String getEventType() {`
`82`	`82`
`83`	`83`	`@Override`
`84`	`84`	`public String getEventDescription() {`
`85`		`- return "Dedicating zone IPv4 subnet " + getResourceUuid(ApiConstants.ID);`
	`85`	`+ return "Dedicating zone's IPv4 subnet with ID: " + getResourceUuid(ApiConstants.ID);`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ public String getEventType() {`
`100`	`100`
`101`	`101`	`@Override`
`102`	`102`	`public String getEventDescription() {`
`103`		`- return "Deleting management ip range from " + getStartIp() + " to " + getEndIp() + " from Pod: " + getResourceUuid(ApiConstants.POD_ID);`
	`103`	`+ return "Deleting management IP range from " + getStartIp() + " to " + getEndIp() + " from Pod: " + getResourceUuid(ApiConstants.POD_ID);`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public String getEventType() {`
`64`	`64`
`65`	`65`	`@Override`
`66`	`66`	`public String getEventDescription() {`
`67`		`- return "Deleting storage ip range with ID: " + getResourceUuid(ApiConstants.ID);`
	`67`	`+ return "Deleting storage IP range with ID: " + getResourceUuid(ApiConstants.ID);`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ public String getEventType() {`
`80`	`80`
`81`	`81`	`@Override`
`82`	`82`	`public String getEventDescription() {`
`83`		`- return "Changing bgp Peers for VPC with ID: " + getResourceUuid(ApiConstants.VPC_ID);`
	`83`	`+ return "Changing BGP Peers for VPC with ID: " + getResourceUuid(ApiConstants.VPC_ID);`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ public String getEventType() {`
`94`	`94`
`95`	`95`	`@Override`
`96`	`96`	`public String getEventDescription() {`
`97`		`- return "Disable out-of-band management password for host with ID: " + getResourceUuid(ApiConstants.HOST_ID);`
	`97`	`+ return "Disabling out-of-band management password for host with ID: " + getResourceUuid(ApiConstants.HOST_ID);`
`98`	`98`	`}`
`99`	`99`
`100`	`100`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ public String getEventType() {`
`93`	`93`
`94`	`94`	`@Override`
`95`	`95`	`public String getEventDescription() {`
`96`		`- return "Enable out-of-band management password for cluster with ID: " + getResourceUuid(ApiConstants.CLUSTER_ID);`
	`96`	`+ return "Enabling out-of-band management password for cluster with ID: " + getResourceUuid(ApiConstants.CLUSTER_ID);`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public String getEventType() {`
`71`	`71`
`72`	`72`	`@Override`
`73`	`73`	`public String getEventDescription() {`
`74`		`- return String.format("Attempting to live patch System VM with Id: %s ", getResourceUuid(ApiConstants.ID));`
	`74`	`+ return String.format("Attempting to live patch System VM with ID: %s ", getResourceUuid(ApiConstants.ID));`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`@Override`