From 1cb2f1b875746f73473b2d476bbb1c866b4a3901 Mon Sep 17 00:00:00 2001 From: erikbocks Date: Tue, 20 Jan 2026 09:47:44 -0300 Subject: [PATCH] normalize descriptions to use string contatenation and enhance some descriptions --- .../admin/network/MigrateNetworkCmd.java | 6 +++--- .../api/command/admin/vm/MigrateVMCmd.java | 12 ++++++------ .../admin/volume/UnmanageVolumeCmd.java | 2 +- .../command/user/template/CopyTemplateCmd.java | 12 ++++++------ .../user/template/ExtractTemplateCmd.java | 8 ++++---- .../user/volume/CheckAndRepairVolumeCmd.java | 2 +- .../command/user/volume/DetachVolumeCmd.java | 18 ++++++++++-------- .../AddNodesToKubernetesClusterCmd.java | 2 +- .../cluster/DeleteKubernetesClusterCmd.java | 9 +-------- .../RemoveNodesFromKubernetesClusterCmd.java | 2 +- .../cluster/UpgradeKubernetesClusterCmd.java | 9 +-------- 11 files changed, 35 insertions(+), 47 deletions(-) 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 index 0d020d92ed4..af5ec358fd2 100644 --- 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 class MigrateNetworkCmd extends BaseAsyncCmd { @Override public String getEventDescription() { - StringBuilder eventMsg = new StringBuilder("Migrating network with ID: " + getResourceUuid(ApiConstants.NETWORK_ID)); + String description = "Migrating network with ID: " + getResourceUuid(ApiConstants.NETWORK_ID); if (getNetworkOfferingId() != null) { Network network = _networkService.getNetwork(getId()); if (network == null) { @@ -128,11 +128,11 @@ public class MigrateNetworkCmd extends BaseAsyncCmd { throw new InvalidParameterValueException("Network offering id supplied is invalid"); } - eventMsg.append(". Original network offering id: " + oldOff.getUuid() + ", new network offering id: " + newOff.getUuid()); + description += ". Original network offering id: " + oldOff.getUuid() + ", new network offering id: " + newOff.getUuid(); } } - return eventMsg.toString(); + return description; } @Override diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/MigrateVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/MigrateVMCmd.java index 435ea43246a..3edfd4e119f 100644 --- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/MigrateVMCmd.java +++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/MigrateVMCmd.java @@ -124,15 +124,15 @@ public class MigrateVMCmd extends BaseAsyncCmd { @Override public String getEventDescription() { - String eventDescription; + String description = "Attempting to migrate Instance with ID: " + getResourceUuid(ApiConstants.VIRTUAL_MACHINE_ID); + if (getHostId() != null) { - eventDescription = String.format("Attempting to migrate Instance with ID: %s to host with ID: %s", getResourceUuid(ApiConstants.VIRTUAL_MACHINE_ID), getResourceUuid(ApiConstants.HOST_ID)); + description += " to host with ID: " +getResourceUuid(ApiConstants.HOST_ID); } else if (getStoragePoolId() != null) { - eventDescription = String.format("Attempting to migrate Instance with ID: %s to storage pool with ID: %s", getResourceUuid(ApiConstants.VIRTUAL_MACHINE_ID), getResourceUuid(ApiConstants.STORAGE_ID)); - } else { - eventDescription = String.format("Attempting to migrate Instance with ID: %s", getResourceUuid(ApiConstants.VIRTUAL_MACHINE_ID)); + description = " to storage pool with ID: " + getResourceUuid(ApiConstants.STORAGE_ID); } - return eventDescription; + + return description; } @Override diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/UnmanageVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/UnmanageVolumeCmd.java index fba53907749..ac573dd4ecb 100644 --- a/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/UnmanageVolumeCmd.java +++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/UnmanageVolumeCmd.java @@ -81,7 +81,7 @@ public class UnmanageVolumeCmd extends BaseAsyncCmd { @Override public String getEventDescription() { - return String.format("Unmanaging Volume with ID %s", getResourceUuid(ApiConstants.ID)); + return "Unmanaging Volume with ID: " + getResourceUuid(ApiConstants.ID); } ///////////////////////////////////////////////////// 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 index 4aa2c9e62dc..080a6148faf 100644 --- 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,21 +136,21 @@ public class CopyTemplateCmd extends BaseAsyncCmd implements UserCmd { @Override public String getEventDescription() { - StringBuilder descBuilder = new StringBuilder("Copying template: " + getResourceUuid(ApiConstants.ID)); + String description = "Copying template: " + getResourceUuid(ApiConstants.ID); if (getSourceZoneId() != null) { - descBuilder.append(" from zone: ").append(getResourceUuid(ApiConstants.SOURCE_ZONE_ID)); + description += " from zone: " + getResourceUuid(ApiConstants.SOURCE_ZONE_ID); } if (getDestinationZoneIds() != null) { - descBuilder.append(" to zones: "); + description += " to zones: "; for (Long destId : getDestinationZoneIds()) { - descBuilder.append(this._uuidMgr.getUuid(DataCenter.class, destId)); - descBuilder.append(", "); + description += this._uuidMgr.getUuid(DataCenter.class, destId); + description += ", "; } } - return descBuilder.toString(); + return description; } @Override diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/template/ExtractTemplateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/template/ExtractTemplateCmd.java index 05e789f6663..d3f039ce38d 100644 --- a/api/src/main/java/org/apache/cloudstack/api/command/user/template/ExtractTemplateCmd.java +++ b/api/src/main/java/org/apache/cloudstack/api/command/user/template/ExtractTemplateCmd.java @@ -100,14 +100,14 @@ public class ExtractTemplateCmd extends BaseAsyncCmd { @Override public String getEventDescription() { - String baseDescription = String.format("Extracting Template with ID: %s", getResourceUuid(ApiConstants.ID)); + String description = "Extracting Template with ID: " + getResourceUuid(ApiConstants.ID); Long zoneId = getZoneId(); - if (zoneId == null) { - return baseDescription; + if (zoneId != null) { + description += "from zone with ID: " + getResourceUuid(ApiConstants.ZONE_ID); } - return String.format("%s from zone with ID: %s", baseDescription, getResourceUuid(ApiConstants.ZONE_ID)); + return description; } @Override diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/CheckAndRepairVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/CheckAndRepairVolumeCmd.java index 0cfa6c4b0df..ada296825e4 100644 --- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/CheckAndRepairVolumeCmd.java +++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/CheckAndRepairVolumeCmd.java @@ -105,7 +105,7 @@ public class CheckAndRepairVolumeCmd extends BaseAsyncCmd { @Override public String getEventDescription() { - return String.format("Starting checking and repairing operation on volume: %s", getResourceUuid(ApiConstants.ID)); + return "Starting checking and repairing operation on volume: " + getResourceUuid(ApiConstants.ID); } @Override 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 index f1d8bdb4c5e..66a558abf98 100644 --- 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 @@ -38,7 +38,7 @@ import com.cloud.user.Account; import com.cloud.uservm.UserVm; import com.cloud.vm.VirtualMachine; -@APICommand(name = "detachVolume", description = "Detaches a disk volume from an Instance.", responseObject = VolumeResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class}, +@APICommand(name = "detachVolume", description = "Detaches a disk volume from an Instance.", responseObject = VolumeResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class}, requestHasSensitiveInfo = false, responseHasSensitiveInfo = false) public class DetachVolumeCmd extends BaseAsyncCmd implements UserCmd { private static final String s_name = "detachvolumeresponse"; @@ -126,17 +126,19 @@ public class DetachVolumeCmd extends BaseAsyncCmd implements UserCmd { @Override public String getEventDescription() { - StringBuilder sb = new StringBuilder("Detaching volume"); + String description = "Detaching volume"; if (id != null) { - 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(" "); + description += ": " + getResourceUuid(ApiConstants.ID); } - return sb.toString(); + if ((deviceId != null) && (virtualMachineId != null)) { + description += " with device id: " + deviceId + " from Instance: " + getResourceUuid(ApiConstants.VIRTUAL_MACHINE_ID); + } else { + description += " "; + } + + return description; } @Override diff --git a/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/AddNodesToKubernetesClusterCmd.java b/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/AddNodesToKubernetesClusterCmd.java index cae175c49cb..f47bc8ee324 100644 --- a/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/AddNodesToKubernetesClusterCmd.java +++ b/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/AddNodesToKubernetesClusterCmd.java @@ -99,7 +99,7 @@ public class AddNodesToKubernetesClusterCmd extends BaseAsyncCmd { @Override public String getEventDescription() { - return String.format("Adding %s nodes to the Kubernetes cluster with ID: %s", nodeIds.size(), getResourceUuid(ApiConstants.ID)); + return "Adding " + nodeIds.size() + " nodes to Kubernetes cluster with ID: " + getResourceUuid(ApiConstants.ID); } @Override diff --git a/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/DeleteKubernetesClusterCmd.java b/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/DeleteKubernetesClusterCmd.java index 644c904eb34..10a5bcc3cb1 100644 --- a/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/DeleteKubernetesClusterCmd.java +++ b/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/DeleteKubernetesClusterCmd.java @@ -126,14 +126,7 @@ public class DeleteKubernetesClusterCmd extends BaseAsyncCmd { @Override public String getEventDescription() { - String description = "Deleting Kubernetes cluster"; - KubernetesCluster cluster = _entityMgr.findById(KubernetesCluster.class, getId()); - if (cluster != null) { - description += String.format(" with ID: %s", cluster.getUuid()); - } else { - description += String.format(" with ID: %s", getResourceUuid(ApiConstants.ID)); - } - return description; + return "Deleting Kubernetes cluster with ID: " + getResourceUuid(ApiConstants.ID); } } diff --git a/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/RemoveNodesFromKubernetesClusterCmd.java b/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/RemoveNodesFromKubernetesClusterCmd.java index a35b685230d..1eae69377c4 100644 --- a/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/RemoveNodesFromKubernetesClusterCmd.java +++ b/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/RemoveNodesFromKubernetesClusterCmd.java @@ -89,7 +89,7 @@ public class RemoveNodesFromKubernetesClusterCmd extends BaseAsyncCmd { @Override public String getEventDescription() { - return String.format("Removing %s nodes from the Kubernetes Cluster with ID: %s", nodeIds.size(), getResourceUuid(ApiConstants.ID)); + return "Removing " + nodeIds.size() + " nodes from the Kubernetes Cluster with ID: " + getResourceUuid(ApiConstants.ID); } @Override diff --git a/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/UpgradeKubernetesClusterCmd.java b/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/UpgradeKubernetesClusterCmd.java index b6b661a9aa3..fb576e9ef82 100644 --- a/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/UpgradeKubernetesClusterCmd.java +++ b/plugins/integrations/kubernetes-service/src/main/java/org/apache/cloudstack/api/command/user/kubernetes/cluster/UpgradeKubernetesClusterCmd.java @@ -82,14 +82,7 @@ public class UpgradeKubernetesClusterCmd extends BaseAsyncCmd { @Override public String getEventDescription() { - String description = "Upgrading Kubernetes cluster"; - KubernetesCluster cluster = _entityMgr.findById(KubernetesCluster.class, getId()); - if (cluster != null) { - description += String.format(" ID: %s", cluster.getUuid()); - } else { - description += String.format(" ID: %d", getResourceUuid(ApiConstants.ID)); - } - return description; + return "Upgrading Kubernetes cluster with ID: " + getResourceUuid(ApiConstants.ID); } @Override