Create new generic method for resource UUID obtention in event's descriptions (#12502)

Author: erikbocks

api/src/main/java/org/apache/cloudstack/api/BaseCmd.java

@@ -27,6 +27,7 @@
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.UUID;
 import java.util.regex.Pattern;
 
 import javax.inject.Inject;
@@ -498,4 +499,14 @@ public Map<String, String> convertExternalDetailsToMap(Map externalDetails) {
         }
         return details;
     }
+
+    public String getResourceUuid(String parameterName) {
+        UUID resourceUuid = CallContext.current().getApiResourceUuid(parameterName);
+
+        if (resourceUuid != null) {
+            return resourceUuid.toString();
+        }
+
+        return null;
+    }
 }

api/src/main/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmd.java

@@ -177,7 +177,7 @@ public long getEntityOwnerId() {
     @Override
     public void execute() {
         validateParams();
-        CallContext.current().setEventDetails("Account Name: " + getUsername() + ", Domain Id:" + getDomainId());
+        CallContext.current().setEventDetails("Account Name: " + getUsername() + ", Domain ID:" + getResourceUuid(ApiConstants.DOMAIN_ID));
         UserAccount userAccount =
             _accountService.createUserAccount(this);
         if (userAccount != null) {

api/src/main/java/org/apache/cloudstack/api/command/admin/account/DisableAccountCmd.java

@@ -108,12 +108,20 @@ public long getEntityOwnerId() {
 
     @Override
     public String getEventDescription() {
-        return  "Disabling Account: " + getAccountName() + " in domain: " + getDomainId();
+        String message = "Disabling Account ";
+
+        if (getId() != null) {
+            message += "with ID: " + getResourceUuid(ApiConstants.ID);
+        } else {
+            message += getAccountName() + " in Domain: " + getResourceUuid(ApiConstants.DOMAIN_ID);
+        }
+
+        return message;
     }
 
     @Override
     public void execute() throws ConcurrentOperationException, ResourceUnavailableException {
-        CallContext.current().setEventDetails("Account Name: " + getAccountName() + ", Domain Id:" + getDomainId());
+        CallContext.current().setEventDetails("Account Name: " + getAccountName() + ", Domain Id:" + getResourceUuid(ApiConstants.DOMAIN_ID));
         Account result = _regionService.disableAccount(this);
         if (result != null){
             AccountResponse response = _responseGenerator.createAccountResponse(ResponseView.Full, result);

api/src/main/java/org/apache/cloudstack/api/command/admin/acl/CreateRolePermissionCmd.java

@@ -81,7 +81,7 @@ public void execute() {
         if (role == null) {
             throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Invalid role id provided");
         }
-        CallContext.current().setEventDetails("Role id: " + role.getId() + ", rule:" + getRule() + ", permission: " + getPermission() + ", description: " + getDescription());
+        CallContext.current().setEventDetails("Role ID: " + role.getUuid() + ", rule:" + getRule() + ", permission: " + getPermission() + ", description: " + getDescription());
         final RolePermission rolePermission = roleService.createRolePermission(role, getRule(), getPermission(), getDescription());
         if (rolePermission == null) {
             throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create role permission");

api/src/main/java/org/apache/cloudstack/api/command/admin/acl/DeleteRoleCmd.java

@@ -70,7 +70,7 @@ public void execute() {
         if (role == null) {
             throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Cannot find the role with provided id");
         }
-        CallContext.current().setEventDetails("Role id: " + role.getId());
+        CallContext.current().setEventDetails("Role ID: " + role.getUuid());
         boolean result = roleService.deleteRole(role);
         SuccessResponse response = new SuccessResponse(getCommandName());
         response.setSuccess(result);

api/src/main/java/org/apache/cloudstack/api/command/admin/acl/DeleteRolePermissionCmd.java

@@ -68,7 +68,7 @@ public void execute() {
         if (rolePermission == null) {
             throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Invalid role permission id provided");
         }
-        CallContext.current().setEventDetails("Role permission id: " + rolePermission.getId());
+        CallContext.current().setEventDetails("Role permission ID: " + rolePermission.getUuid());
         boolean result = roleService.deleteRolePermission(rolePermission);
         SuccessResponse response = new SuccessResponse(getCommandName());
         response.setSuccess(result);

api/src/main/java/org/apache/cloudstack/api/command/admin/acl/DisableRoleCmd.java

@@ -55,7 +55,7 @@ public void execute() throws ResourceUnavailableException, InsufficientCapacityE
         if (role == null) {
             throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Cannot find the role with provided id");
         }
-        CallContext.current().setEventDetails("Role id: " + role.getId());
+        CallContext.current().setEventDetails("Role ID: " + role.getUuid());
         boolean result = roleService.disableRole(role);
         SuccessResponse response = new SuccessResponse(getCommandName());
         response.setSuccess(result);

api/src/main/java/org/apache/cloudstack/api/command/admin/acl/EnableRoleCmd.java

@@ -55,7 +55,7 @@ public void execute() throws ResourceUnavailableException, InsufficientCapacityE
         if (role == null) {
             throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Cannot find the role with provided id");
         }
-        CallContext.current().setEventDetails("Role id: " + role.getId());
+        CallContext.current().setEventDetails("Role ID: " + role.getUuid());
         boolean result = roleService.enableRole(role);
         SuccessResponse response = new SuccessResponse(getCommandName());
         response.setSuccess(result);

api/src/main/java/org/apache/cloudstack/api/command/admin/acl/UpdateRolePermissionCmd.java

@@ -111,7 +111,7 @@ public void execute() {
             if (getRuleId() != null || getRulePermission() != null) {
                 throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Parameters permission and ruleid must be mutually exclusive with ruleorder");
             }
-            CallContext.current().setEventDetails("Reordering permissions for role id: " + role.getId());
+            CallContext.current().setEventDetails("Reordering permissions for role with ID: " + role.getUuid());
             final List<RolePermission> rolePermissionsOrder = new ArrayList<>();
             for (Long rolePermissionId : getRulePermissionOrder()) {
                 final RolePermission rolePermission = roleService.findRolePermission(rolePermissionId);
@@ -129,7 +129,7 @@ public void execute() {
             if (rolePermission == null) {
                 throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Invalid rule id provided");
             }
-            CallContext.current().setEventDetails("Updating permission for rule id: " + getRuleId() + " to: " + getRulePermission().toString());
+            CallContext.current().setEventDetails("Updating permission for rule with ID: " + getResourceUuid(ApiConstants.RULE_ID) + " to: " + getRulePermission().toString());
             result = roleService.updateRolePermission(role, rolePermission, getRulePermission());
         }
         SuccessResponse response = new SuccessResponse(getCommandName());

api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/CreateProjectRolePermissionCmd.java

@@ -72,7 +72,7 @@ public void execute() {
         if (projectRole == null) {
             throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Invalid project role ID provided");
         }
-        CallContext.current().setEventDetails("Project Role ID: " + projectRole.getId() + ", Rule:" + getRule() + ", Permission: " + getPermission() + ", Description: " + getDescription());
+        CallContext.current().setEventDetails("Project Role ID: " + projectRole.getUuid() + ", Rule:" + getRule() + ", Permission: " + getPermission() + ", Description: " + getDescription());
         final ProjectRolePermission projectRolePermission = projRoleService.createProjectRolePermission(this);
         if (projectRolePermission == null) {
             throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create project role permission");