Big refactor and improvements

Author: nvazquez

api/pom.xml

@@ -56,6 +56,11 @@
       <artifactId>cloud-framework-ca</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.apache.cloudstack</groupId>
+      <artifactId>cloud-framework-backup-and-recovery</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-lang3</artifactId>

api/src/main/java/com/cloud/host/Host.java

@@ -33,7 +33,7 @@ public enum Type {
         Storage(false), Routing(false), SecondaryStorage(false), SecondaryStorageCmdExecutor(false), ConsoleProxy(true), ExternalFirewall(false), ExternalLoadBalancer(
                 false), ExternalVirtualSwitchSupervisor(false), PxeServer(false), BaremetalPxe(false), BaremetalDhcp(false), TrafficMonitor(false), NetScalerControlCenter(false),
 
-        ExternalDhcp(false), SecondaryStorageVM(true), LocalSecondaryStorage(false), L2Networking(false), BackupRecovery(true);
+        ExternalDhcp(false), SecondaryStorageVM(true), LocalSecondaryStorage(false), L2Networking(false);
         boolean _virtual;
 
         private Type(boolean virtual) {

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

@@ -720,9 +720,8 @@ public class ApiConstants {
     public static final String LDAP_DOMAIN = "ldapdomain";
 
     // Backup and Recovery
-    public static final String BACKUP_PROVIDER_ID = "backupproviderid";
-    public static final String BACKUP_POLICY_ID = "backuppolicyid";
-    public static final String BACKUP_POLICY_NAME = "backuppolicyname";
+    public static final String BR_PROVIDER_ID = "providerid";
+    public static final String BR_POLICY_ID = "policyid";
 
     public enum HostDetails {
         all, capacity, events, stats, min;

framework/backup-and-recovery/src/main/java/org/apache/cloudstack/framework/backuprecovery/api/AddBackupRecoveryPolicyCmd.java renamed to api/src/main/java/org/apache/cloudstack/api/command/admin/br/policy/AddBRPolicyCmd.java

@@ -1,10 +1,26 @@
-package org.apache.cloudstack.framework.backuprecovery.api;
+// 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 org.apache.cloudstack.api.command.admin.br.policy;
 
 import com.cloud.exception.ConcurrentOperationException;
 import com.cloud.exception.InsufficientCapacityException;
 import com.cloud.exception.InvalidParameterValueException;
 import com.cloud.exception.NetworkRuleConflictException;
-import com.cloud.exception.OperationTimedoutException;
 import com.cloud.exception.ResourceAllocationException;
 import com.cloud.exception.ResourceUnavailableException;
 import com.cloud.utils.exception.CloudRuntimeException;
@@ -16,40 +32,37 @@
 import org.apache.cloudstack.api.Parameter;
 import org.apache.cloudstack.api.ServerApiException;
 import org.apache.cloudstack.context.CallContext;
-import org.apache.cloudstack.framework.backuprecovery.BackupRecoveryManager;
-import org.apache.cloudstack.framework.backuprecovery.api.response.BackupPolicyResponse;
-import org.apache.cloudstack.framework.backuprecovery.api.response.BackupRecoveryProviderResponse;
-import org.apache.cloudstack.framework.backuprecovery.impl.BackupPolicyVO;
+import org.apache.cloudstack.br.BRManager;
+import org.apache.cloudstack.api.response.BRPolicyResponse;
+import org.apache.cloudstack.framework.br.BRPolicy;
 
 import javax.inject.Inject;
 
-@APICommand(name = AddBackupRecoveryPolicyCmd.APINAME,
+@APICommand(name = AddBRPolicyCmd.APINAME,
         description = "Adds a Backup policy",
-        responseObject = BackupPolicyResponse.class, since = "4.12.0",
+        responseObject = BRPolicyResponse.class, since = "4.12.0",
         authorized = {RoleType.Admin})
-public class AddBackupRecoveryPolicyCmd extends BaseCmd {
+public class AddBRPolicyCmd extends BaseCmd {
 
-    public static final String APINAME = "addBackupRecoveryPolicy";
+    public static final String APINAME = "addBRPolicy";
 
     @Inject
-    BackupRecoveryManager backupRecoveryManager;
+    BRManager brManager;
 
     @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the policy")
     private String policyName;
 
-    @Parameter(name = ApiConstants.BACKUP_POLICY_ID,
+    @Parameter(name = ApiConstants.BR_POLICY_ID,
             type = CommandType.STRING,
-            entityType = BackupRecoveryProviderResponse.class,
             required = true,
             description = "Backup Recovery Provider ID")
     private String policyId;
 
-    @Parameter(name = ApiConstants.BACKUP_PROVIDER_ID,
-            type = BaseCmd.CommandType.UUID,
-            entityType = BackupRecoveryProviderResponse.class,
+    @Parameter(name = ApiConstants.BR_PROVIDER_ID,
+            type = CommandType.STRING,
             required = true,
             description = "Backup Recovery Provider ID")
-    private Long providerId;
+    private String providerId;
 
     public String getPolicyName() {
         return policyName;
@@ -59,17 +72,17 @@ public String getPolicyId() {
         return policyId;
     }
 
-    public Long getProviderId() {
+    public String getProviderId() {
         return providerId;
     }
 
     @Override
     public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException, NetworkRuleConflictException {
         try {
-            BackupPolicyVO policyVO = backupRecoveryManager.addBackupPolicy(this);
-            if (policyVO != null) {
-                BackupPolicyResponse response = backupRecoveryManager.createBackupPolicyResponse(policyVO);
-                response.setObjectName("backuppolicy");
+            BRPolicy policy = brManager.addBRPolicy(policyId, policyName, providerId);
+            if (policy != null) {
+                BRPolicyResponse response = brManager.createBackupPolicyResponse(policy);
+                response.setObjectName("brpolicy");
                 response.setResponseName(getCommandName());
                 setResponseObject(response);
             } else {
@@ -79,14 +92,12 @@ public void execute() throws ResourceUnavailableException, InsufficientCapacityE
             throw new ServerApiException(ApiErrorCode.PARAM_ERROR, e.getMessage());
         } catch (CloudRuntimeException e) {
             throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
-        } catch (OperationTimedoutException e) {
-            e.printStackTrace();
         }
     }
 
     @Override
     public String getCommandName() {
-        return APINAME.toLowerCase() + BaseCmd.RESPONSE_SUFFIX;
+        return APINAME.toLowerCase() + RESPONSE_SUFFIX;
     }
 
     @Override

framework/backup-and-recovery/src/main/java/org/apache/cloudstack/framework/backuprecovery/api/AssignBackupPolicyCmd.java renamed to api/src/main/java/org/apache/cloudstack/api/command/admin/br/policy/AssignBRPolicyCmd.java

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-package org.apache.cloudstack.framework.backuprecovery.api;
+package org.apache.cloudstack.api.command.admin.br.policy;
 
 import com.cloud.exception.ConcurrentOperationException;
 import com.cloud.exception.InsufficientCapacityException;
@@ -33,33 +33,32 @@
 import org.apache.cloudstack.api.response.SuccessResponse;
 import org.apache.cloudstack.api.response.UserVmResponse;
 import org.apache.cloudstack.context.CallContext;
-import org.apache.cloudstack.framework.backuprecovery.BackupRecoveryManager;
-import org.apache.cloudstack.framework.backuprecovery.api.response.BackupRecoveryProviderResponse;
+import org.apache.cloudstack.br.BRManager;
+import org.apache.cloudstack.br.BRProviderDriver;
 
 import javax.inject.Inject;
 
-@APICommand(name = AssignBackupPolicyCmd.APINAME,
+@APICommand(name = AssignBRPolicyCmd.APINAME,
         description = "Assigns a VM to an existing backup policy",
         responseObject = SuccessResponse.class, since = "4.12.0")
-public class AssignBackupPolicyCmd extends BaseCmd {
+public class AssignBRPolicyCmd extends BaseCmd {
 
-    public static final String APINAME = "assignBackupPolicy";
+    public static final String APINAME = "assignBRPolicy";
 
     @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
             type = CommandType.UUID,
             entityType = UserVmResponse.class,
             required = true,
             description = "id of the VM to be moved")
-    private Long virtualMachineId;
+    private String virtualMachineId;
 
-    @Parameter(name = ApiConstants.BACKUP_POLICY_ID,
+    @Parameter(name = ApiConstants.BR_POLICY_ID,
             type = CommandType.STRING,
-            entityType = BackupRecoveryProviderResponse.class,
             required = true,
             description = "Backup Recovery Provider ID")
     private String policyId;
 
-    public Long getVirtualMachineId() {
+    public String getVirtualMachineId() {
         return virtualMachineId;
     }
 
@@ -68,12 +67,13 @@ public String getPolicyId() {
     }
 
     @Inject
-    BackupRecoveryManager backupRecoveryManager;
+    BRManager brManager;
 
     @Override
     public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException, NetworkRuleConflictException {
         try {
-            boolean result = backupRecoveryManager.assignVMToBackupPolicy(this);
+            BRProviderDriver provider = brManager.getBRProviderFromPolicy(getPolicyId());
+            boolean result = provider.assignVMToBackupPolicy(getPolicyId(), getVirtualMachineId());
             if (result) {
                 SuccessResponse response = new SuccessResponse(getCommandName());
                 response.setResponseName(getCommandName());
@@ -82,13 +82,13 @@ public void execute() throws ResourceUnavailableException, InsufficientCapacityE
                 throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to assign VM to backup policy");
             }
         } catch (Exception e) {
-
+            throw new ServerApiException(ApiErrorCode.PARAM_ERROR, e.getMessage());
         }
     }
 
     @Override
     public String getCommandName() {
-        return AssignBackupPolicyCmd.APINAME + BaseCmd.RESPONSE_SUFFIX;
+        return AssignBRPolicyCmd.APINAME + RESPONSE_SUFFIX;
     }
 
     @Override

framework/backup-and-recovery/src/main/java/org/apache/cloudstack/framework/backuprecovery/api/ListBackupRecoveryPoliciesCmd.java renamed to api/src/main/java/org/apache/cloudstack/api/command/admin/br/policy/ListBRPoliciesCmd.java

@@ -14,7 +14,7 @@
 // KIND, either express or implied.  See the License for the
 // specific language governing permissions and limitations
 // under the License.
-package org.apache.cloudstack.framework.backuprecovery.api;
+package org.apache.cloudstack.api.command.admin.br.policy;
 
 import com.cloud.exception.ConcurrentOperationException;
 import com.cloud.exception.InvalidParameterValueException;
@@ -23,56 +23,53 @@
 import org.apache.cloudstack.api.APICommand;
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.ApiErrorCode;
-import org.apache.cloudstack.api.BaseCmd;
 import org.apache.cloudstack.api.BaseListCmd;
 import org.apache.cloudstack.api.Parameter;
 import org.apache.cloudstack.api.ServerApiException;
 import org.apache.cloudstack.api.response.ListResponse;
-import org.apache.cloudstack.framework.backuprecovery.BackupRecoveryManager;
-import org.apache.cloudstack.framework.backuprecovery.api.response.BackupPolicyResponse;
-import org.apache.cloudstack.framework.backuprecovery.api.response.BackupRecoveryProviderResponse;
-import org.apache.cloudstack.framework.backuprecovery.impl.BackupPolicyVO;
+import org.apache.cloudstack.br.BRManager;
+import org.apache.cloudstack.api.response.BRPolicyResponse;
+import org.apache.cloudstack.framework.br.BRPolicy;
 import org.apache.commons.collections.CollectionUtils;
 
 import javax.inject.Inject;
 import java.util.ArrayList;
 import java.util.List;
 
-@APICommand(name = ListBackupRecoveryPoliciesCmd.APINAME,
+@APICommand(name = ListBRPoliciesCmd.APINAME,
         description = "Lists mapped Backup policies",
-        responseObject = BackupPolicyResponse.class, since = "4.12.0",
+        responseObject = BRPolicyResponse.class, since = "4.12.0",
         authorized = {RoleType.Admin})
-public class ListBackupRecoveryPoliciesCmd extends BaseListCmd {
+public class ListBRPoliciesCmd extends BaseListCmd {
 
-    public static final String APINAME = "listBackupRecoveryPolicies";
+    public static final String APINAME = "listBRPolicies";
 
-    @Parameter(name = ApiConstants.BACKUP_PROVIDER_ID,
-            type = BaseCmd.CommandType.UUID,
-            entityType = BackupRecoveryProviderResponse.class,
+    @Parameter(name = ApiConstants.BR_PROVIDER_ID,
+            type = CommandType.STRING,
             required = true,
             description = "Backup Recovery Provider ID")
-    private Long providerId;
+    private String providerId;
 
-    public long getProviderId() {
+    public String getProviderId() {
         return providerId;
     }
 
     @Inject
-    BackupRecoveryManager backupRecoveryManager;
+    BRManager brManager;
 
     @Override
     public void execute() throws ServerApiException, ConcurrentOperationException {
         try {
-            ListResponse<BackupPolicyResponse> response = new ListResponse<BackupPolicyResponse>();
-            List<BackupPolicyResponse> responses = new ArrayList<>();
-            List<BackupPolicyVO> policies = backupRecoveryManager.listBackupPolicies(this);
+            ListResponse<BRPolicyResponse> response = new ListResponse<BRPolicyResponse>();
+            List<BRPolicyResponse> responses = new ArrayList<>();
+            List<BRPolicy> policies = brManager.listBRPolicies(providerId);
             if (CollectionUtils.isNotEmpty(policies)) {
-                for (BackupPolicyVO policy : policies) {
-                    BackupPolicyResponse p = backupRecoveryManager.createBackupPolicyResponse(policy);
-                    responses.add(p);
+                for (BRPolicy policy : policies) {
+                    responses.add(brManager.createBackupPolicyResponse(policy));
                 }
             }
             response.setResponses(responses, responses.size());
+            response.setObjectName("brpolicies");
             response.setResponseName(getCommandName());
             setResponseObject(response);
         } catch (InvalidParameterValueException e) {
@@ -83,7 +80,7 @@ public void execute() throws ServerApiException, ConcurrentOperationException {
     }
     @Override
     public String getCommandName() {
-        return APINAME.toLowerCase() + BaseCmd.RESPONSE_SUFFIX;
+        return APINAME.toLowerCase() + RESPONSE_SUFFIX;
     }
 
 }