minor code refactoring

Author: vishesh92

api/src/main/java/org/apache/cloudstack/userdata/UserDataManager.java

@@ -22,12 +22,23 @@
 
 import com.cloud.utils.component.Manager;
 
+import java.io.IOException;
+
 public interface UserDataManager extends Manager, Configurable {
     String VM_USERDATA_MAX_LENGTH_STRING = "vm.userdata.max.length";
     ConfigKey<Integer> VM_USERDATA_MAX_LENGTH = new ConfigKey<>("Advanced", Integer.class, VM_USERDATA_MAX_LENGTH_STRING, "32768",
             "Max length of vm userdata after base64 encoding. Default is 32768 and maximum is 1048576", true);
 
     String concatenateUserData(String userdata1, String userdata2, String userdataProvider);
     String validateUserData(String userData, BaseCmd.HTTPMethod httpmethod);
-    String validateAndGetUserDataForSystemVM(String userDataUuid);
+
+    /**
+     * This method validates the user data uuid for system VMs and returns the user data
+     * after compression and base64 encoding for the system VM to consume.
+     *
+     * @param userDataUuid
+     * @return a String containing the user data after compression and base64 encoding
+     * @throws IOException
+     */
+    String validateAndGetUserDataForSystemVM(String userDataUuid) throws IOException;
 }

engine/userdata/src/main/java/org/apache/cloudstack/userdata/UserDataManagerImpl.java

@@ -16,6 +16,7 @@
 // under the License.
 package org.apache.cloudstack.userdata;
 
+import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 import java.net.URLDecoder;
 import java.util.HashMap;
@@ -26,6 +27,7 @@
 import com.cloud.user.User;
 import com.cloud.user.UserDataVO;
 import com.cloud.user.dao.UserDataDao;
+import com.cloud.utils.compression.CompressionUtil;
 import org.apache.cloudstack.api.BaseCmd;
 import org.apache.cloudstack.framework.config.ConfigKey;
 import org.apache.commons.codec.binary.Base64;
@@ -128,7 +130,7 @@ public String validateUserData(String userData, BaseCmd.HTTPMethod httpmethod) {
     }
 
     @Override
-    public String validateAndGetUserDataForSystemVM(String userDataUuid) {
+    public String validateAndGetUserDataForSystemVM(String userDataUuid) throws IOException {
         if (StringUtils.isBlank(userDataUuid)) {
             return null;
         }
@@ -137,7 +139,11 @@ public String validateAndGetUserDataForSystemVM(String userDataUuid) {
             return null;
         }
         if (userDataVo.getDomainId() == Domain.ROOT_DOMAIN && userDataVo.getAccountId() == User.UID_ADMIN) {
-            return userDataVo.getUserData();
+            // Decode base64 user data, compress it, then re-encode to reduce command line length
+            String plainTextUserData = new String(java.util.Base64.getDecoder().decode(userDataVo.getUserData()));
+            CompressionUtil compressionUtil = new CompressionUtil();
+            byte[] compressedUserData = compressionUtil.compressString(plainTextUserData);
+            return java.util.Base64.getEncoder().encodeToString(compressedUserData);
         }
         throw new CloudRuntimeException("User data can only be used by system VMs if it belongs to the ROOT domain and ADMIN account.");
     }

plugins/network-elements/elastic-loadbalancer/src/main/java/com/cloud/network/lb/ElasticLoadBalancerManagerImpl.java

@@ -17,7 +17,6 @@
 package com.cloud.network.lb;
 
 import java.util.ArrayList;
-import java.util.Base64;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
@@ -31,7 +30,6 @@
 import javax.inject.Inject;
 import javax.naming.ConfigurationException;
 
-import com.cloud.utils.compression.CompressionUtil;
 import org.apache.cloudstack.api.command.user.loadbalancer.CreateLoadBalancerRuleCmd;
 import org.apache.cloudstack.config.ApiServiceConfiguration;
 import org.apache.cloudstack.engine.orchestration.service.NetworkOrchestrationService;
@@ -492,12 +490,7 @@ public boolean finalizeVirtualMachineProfile(VirtualMachineProfile profile, Depl
             try {
                 String userData = userDataManager.validateAndGetUserDataForSystemVM(userDataUuid);
                 if (StringUtils.isNotBlank(userData)) {
-                    // Decode base64 user data, compress it, then re-encode to reduce command line length
-                    String plainTextUserData = new String(Base64.getDecoder().decode(userData));
-                    CompressionUtil compressionUtil = new CompressionUtil();
-                    byte[] compressedUserData = compressionUtil.compressString(plainTextUserData);
-                    String encodedUserData = Base64.getEncoder().encodeToString(compressedUserData);
-                    buf.append(" userdata=").append(encodedUserData);
+                    buf.append(" userdata=").append(userData);
                 }
             } catch (Exception e) {
                 logger.warn("Failed to load user data for the elastic lb vm, ignored", e);

plugins/network-elements/internal-loadbalancer/src/main/java/org/apache/cloudstack/network/lb/InternalLoadBalancerVMManagerImpl.java

@@ -26,7 +26,6 @@
 
 import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.Base64;
 import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -37,7 +36,6 @@
 
 import com.cloud.event.ActionEvent;
 import com.cloud.event.EventTypes;
-import com.cloud.utils.compression.CompressionUtil;
 import org.apache.cloudstack.context.CallContext;
 import org.apache.cloudstack.engine.orchestration.service.NetworkOrchestrationService;
 import org.apache.cloudstack.framework.config.dao.ConfigurationDao;
@@ -257,12 +255,7 @@ public boolean finalizeVirtualMachineProfile(final VirtualMachineProfile profile
             try {
                 String userData = userDataManager.validateAndGetUserDataForSystemVM(userDataUuid);
                 if (StringUtils.isNotBlank(userData)) {
-                    // Decode base64 user data, compress it, then re-encode to reduce command line length
-                    String plainTextUserData = new String(Base64.getDecoder().decode(userData));
-                    CompressionUtil compressionUtil = new CompressionUtil();
-                    byte[] compressedUserData = compressionUtil.compressString(plainTextUserData);
-                    String encodedUserData = Base64.getEncoder().encodeToString(compressedUserData);
-                    buf.append(" userdata=").append(encodedUserData);
+                    buf.append(" userdata=").append(userData);
                 }
             } catch (Exception e) {
                 logger.warn("Failed to load user data for the internal lb vm, ignored", e);

server/src/main/java/com/cloud/consoleproxy/ConsoleProxyManagerImpl.java

@@ -19,7 +19,6 @@
 import java.nio.charset.Charset;
 import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.Base64;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -33,7 +32,6 @@
 import javax.inject.Inject;
 import javax.naming.ConfigurationException;
 
-import com.cloud.utils.compression.CompressionUtil;
 import org.apache.cloudstack.agent.lb.IndirectAgentLB;
 import org.apache.cloudstack.ca.CAManager;
 import org.apache.cloudstack.consoleproxy.ConsoleAccessManager;
@@ -1278,12 +1276,7 @@ public boolean finalizeVirtualMachineProfile(VirtualMachineProfile profile, Depl
             try {
                 String userData = userDataManager.validateAndGetUserDataForSystemVM(userDataUuid);
                 if (StringUtils.isNotBlank(userData)) {
-                    // Decode base64 user data, compress it, then re-encode to reduce command line length
-                    String plainTextUserData = new String(Base64.getDecoder().decode(userData));
-                    CompressionUtil compressionUtil = new CompressionUtil();
-                    byte[] compressedUserData = compressionUtil.compressString(plainTextUserData);
-                    String encodedUserData = Base64.getEncoder().encodeToString(compressedUserData);
-                    buf.append(" userdata=").append(encodedUserData);
+                    buf.append(" userdata=").append(userData);
                 }
             } catch (Exception e) {
                 logger.warn("Failed to load user data for the cpvm, ignored", e);

server/src/main/java/com/cloud/network/router/VirtualNetworkApplianceManagerImpl.java

@@ -28,7 +28,6 @@
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
 import java.util.ArrayList;
-import java.util.Base64;
 import java.util.Calendar;
 import java.util.Collections;
 import java.util.Date;
@@ -49,7 +48,6 @@
 import javax.inject.Inject;
 import javax.naming.ConfigurationException;
 
-import com.cloud.utils.compression.CompressionUtil;
 import com.google.gson.JsonSyntaxException;
 import com.google.gson.reflect.TypeToken;
 
@@ -2107,12 +2105,7 @@ public boolean finalizeVirtualMachineProfile(final VirtualMachineProfile profile
             try {
                 String userData = userDataManager.validateAndGetUserDataForSystemVM(userDataUuid);
                 if (StringUtils.isNotBlank(userData)) {
-                    // Decode base64 user data, compress it, then re-encode to reduce command line length
-                    String plainTextUserData = new String(Base64.getDecoder().decode(userData));
-                    CompressionUtil compressionUtil = new CompressionUtil();
-                    byte[] compressedUserData = compressionUtil.compressString(plainTextUserData);
-                    String encodedUserData = Base64.getEncoder().encodeToString(compressedUserData);
-                    buf.append(" userdata=").append(encodedUserData);
+                    buf.append(" userdata=").append(userData);
                 }
             } catch (Exception e) {
                 logger.warn("Failed to load user data for the virtual router, ignored", e);

services/secondary-storage/controller/src/main/java/org/apache/cloudstack/secondarystorage/SecondaryStorageManagerImpl.java

@@ -23,7 +23,6 @@
 import java.net.URISyntaxException;
 import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.Base64;
 import java.util.Collections;
 import java.util.Date;
 import java.util.HashMap;
@@ -36,7 +35,6 @@
 import javax.inject.Inject;
 import javax.naming.ConfigurationException;
 
-import com.cloud.utils.compression.CompressionUtil;
 import org.apache.cloudstack.agent.lb.IndirectAgentLB;
 import org.apache.cloudstack.ca.CAManager;
 import org.apache.cloudstack.context.CallContext;
@@ -1240,12 +1238,7 @@ public boolean finalizeVirtualMachineProfile(VirtualMachineProfile profile, Depl
             try {
                 String userData = userDataManager.validateAndGetUserDataForSystemVM(userDataUuid);
                 if (StringUtils.isNotBlank(userData)) {
-                    // Decode base64 user data, compress it, then re-encode to reduce command line length
-                    String plainTextUserData = new String(Base64.getDecoder().decode(userData));
-                    CompressionUtil compressionUtil = new CompressionUtil();
-                    byte[] compressedUserData = compressionUtil.compressString(plainTextUserData);
-                    String encodedUserData = Base64.getEncoder().encodeToString(compressedUserData);
-                    buf.append(" userdata=").append(encodedUserData);
+                    buf.append(" userdata=").append(userData);
                 }
             } catch (Exception e) {
                 logger.warn("Failed to load user data for the ssvm, ignored", e);