Merge remote-tracking branch 'apache/main' into 4.20-dynamic-routing

api/src/main/java/org/apache/cloudstack/affinity/AffinityGroupResponse.java

@@ -56,6 +56,10 @@ public class AffinityGroupResponse extends BaseResponse implements ControlledVie
     @Param(description = "the domain name of the affinity group")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the Domain the affinity group belongs to", since = "4.19.2.0")
+    private String domainPath;
+
     @SerializedName(ApiConstants.PROJECT_ID)
     @Param(description = "the project ID of the affinity group")
     private String projectId;
@@ -115,6 +119,11 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
+
     @Override
     public int hashCode() {
         final int prime = 31;

api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVMCmd.java

@@ -143,7 +143,7 @@ public class UpdateVMCmd extends BaseCustomIdCmd implements SecurityGroupAction,
             + " Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com")
     private Map dhcpOptionsNetworkList;
 
-    @Parameter(name = ApiConstants.EXTRA_CONFIG, type = CommandType.STRING, since = "4.12", description = "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", authorized = { RoleType.Admin }, length = 5120)
+    @Parameter(name = ApiConstants.EXTRA_CONFIG, type = CommandType.STRING, since = "4.12", description = "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", length = 5120)
     private String extraConfig;
 
     /////////////////////////////////////////////////////

api/src/main/java/org/apache/cloudstack/api/command/user/vpn/AddVpnUserCmd.java

@@ -131,6 +131,7 @@ public void execute() {
         if (domain != null) {
             vpnResponse.setDomainId(domain.getUuid());
             vpnResponse.setDomainName(domain.getName());
+            vpnResponse.setDomainPath(domain.getPath());
         }
 
         vpnResponse.setResponseName(getCommandName());

api/src/main/java/org/apache/cloudstack/api/response/AcquireIPAddressResponse.java

@@ -75,6 +75,10 @@ public class AcquireIPAddressResponse  extends BaseResponse implements Controlle
  @Param(description = "the domain the public IP address is associated with")
  private String domainName;
 
+ @SerializedName(ApiConstants.DOMAIN_PATH)
+ @Param(description = "path of the domain to which the public IP address belongs", since = "4.19.2.0")
+ private String domainPath;
+
  @SerializedName(ApiConstants.FOR_VIRTUAL_NETWORK)
  @Param(description = "the virtual network for the IP address")
  private Boolean forVirtualNetwork;
@@ -190,6 +194,11 @@ public void setDomainName(String domainName) {
      this.domainName = domainName;
  }
 
+ @Override
+ public void setDomainPath(String domainPath) {
+  this.domainPath = domainPath;
+ }
+
  public void setForVirtualNetwork(Boolean forVirtualNetwork) {
      this.forVirtualNetwork = forVirtualNetwork;
  }

api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerResponse.java

@@ -76,6 +76,10 @@ public class ApplicationLoadBalancerResponse extends BaseResponse implements Con
     @Param(description = "the domain of the Load Balancer")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the domain to which the Load Balancer belongs", since = "4.19.2.0")
+    private String domainPath;
+
     @SerializedName("loadbalancerrule")
     @Param(description = "the list of rules associated with the Load Balancer", responseObject = ApplicationLoadBalancerRuleResponse.class)
     private List<ApplicationLoadBalancerRuleResponse> lbRules;
@@ -107,6 +111,11 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
+
     @Override
     public void setProjectId(String projectId) {
         this.projectId = projectId;

api/src/main/java/org/apache/cloudstack/api/response/AutoScalePolicyResponse.java

@@ -74,6 +74,10 @@ public class AutoScalePolicyResponse extends BaseResponse implements ControlledE
     @Param(description = "the domain name of the autoscale policy")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the domain to which the autoscale policy belongs", since = "4.19.2.0")
+    private String domainPath;
+
     @Override
     public String getObjectId() {
         return this.id;
@@ -118,6 +122,11 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
+
     @Override
     public void setProjectId(String projectId) {
         this.projectId = projectId;

api/src/main/java/org/apache/cloudstack/api/response/AutoScaleVmGroupResponse.java

@@ -123,6 +123,10 @@ public class AutoScaleVmGroupResponse extends BaseResponseWithAnnotations implem
     @Param(description = "the domain name of the vm group")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the domain to which the vm group belongs", since = "4.19.2.0")
+    private String domainPath;
+
     @SerializedName(ApiConstants.FOR_DISPLAY)
     @Param(description = "is group for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
     private Boolean forDisplay;
@@ -227,6 +231,11 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
+
     @Override
     public void setProjectId(String projectId) {
         this.projectId = projectId;

api/src/main/java/org/apache/cloudstack/api/response/AutoScaleVmProfileResponse.java

@@ -114,6 +114,10 @@ public class AutoScaleVmProfileResponse extends BaseResponse implements Controll
     @Param(description = "the domain name of the vm profile")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the domain to which the vm profile belongs", since = "4.19.2.0")
+    private String domainPath;
+
     @SerializedName(ApiConstants.FOR_DISPLAY)
     @Param(description = "is profile for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
     private Boolean forDisplay;
@@ -196,6 +200,10 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
     @Override
     public void setProjectId(String projectId) {
         this.projectId = projectId;

api/src/main/java/org/apache/cloudstack/api/response/BucketResponse.java

@@ -54,6 +54,10 @@ public class BucketResponse extends BaseResponseWithTagInformation implements Co
     @SerializedName(ApiConstants.DOMAIN)
     @Param(description = "the domain associated with the bucket")
     private String domainName;
+
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the domain to which the bucket belongs", since = "4.19.2.0")
+    private String domainPath;
     @SerializedName(ApiConstants.OBJECT_STORAGE_ID)
     @Param(description = "id of the object storage hosting the Bucket; returned to admin user only")
     private String objectStoragePoolId;
@@ -146,6 +150,11 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
+
     @Override
     public void setProjectId(String projectId) {
         this.projectId = projectId;

api/src/main/java/org/apache/cloudstack/api/response/ConditionResponse.java

@@ -61,6 +61,10 @@ public class ConditionResponse extends BaseResponse implements ControlledEntityR
     @Param(description = "the domain name of the owner.")
     private String domain;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the domain to which the Condition owner belongs", since = "4.19.2.0")
+    private String domainPath;
+
     @SerializedName(ApiConstants.ZONE_ID)
     @Param(description = "zone id of counter")
     private String zoneId;
@@ -138,4 +142,9 @@ public void setDomainId(String domainId) {
     public void setDomainName(String domainName) {
         this.domain = domainName;
     }
+
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
 }

api/src/main/java/org/apache/cloudstack/api/response/ControlledEntityResponse.java

@@ -27,4 +27,6 @@ public interface ControlledEntityResponse {
     public void setDomainId(String domainId);
 
     public void setDomainName(String domainName);
+
+    public void setDomainPath(String domainPath);
 }

api/src/main/java/org/apache/cloudstack/api/response/ControlledViewEntityResponse.java

@@ -27,4 +27,6 @@ public interface ControlledViewEntityResponse {
     public void setDomainId(String domainId);
 
     public void setDomainName(String domainName);
+
+    public void setDomainPath(String domainPath);
 }

api/src/main/java/org/apache/cloudstack/api/response/DomainRouterResponse.java

@@ -185,6 +185,10 @@ public class DomainRouterResponse extends BaseResponseWithAnnotations implements
     @Param(description = "the domain associated with the router")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the Domain the router belongs to", since = "4.19.2.0")
+    private String domainPath;
+
     @SerializedName(ApiConstants.SERVICE_OFFERING_ID)
     @Param(description = "the ID of the service offering of the virtual machine")
     private String serviceOfferingId;
@@ -381,6 +385,10 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
     public void setPublicNetworkId(String publicNetworkId) {
         this.publicNetworkId = publicNetworkId;
     }

api/src/main/java/org/apache/cloudstack/api/response/EventResponse.java

@@ -69,6 +69,10 @@ public class EventResponse extends BaseResponse implements ControlledViewEntityR
     @Param(description = "the name of the account's domain")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the Domain the account's domain belongs to", since = "4.19.2.0")
+    private String domainPath;
+
     @SerializedName(ApiConstants.RESOURCE_ID)
     @Param(description = "the id of the resource", since = "4.17.0")
     private String resourceId;
@@ -132,6 +136,11 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
+
     public void setResourceId(String resourceId) {
         this.resourceId = resourceId;
     }

api/src/main/java/org/apache/cloudstack/api/response/GlobalLoadBalancerResponse.java

@@ -82,6 +82,10 @@ public class GlobalLoadBalancerResponse extends BaseResponse implements Controll
     @Param(description = "the domain of the load balancer rule")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the domain to which the load balancer rule belongs", since = "4.19.2.0")
+    private String domainPath;
+
     @SerializedName(ApiConstants.LOAD_BALANCER_RULE)
     @Param(description = "List of load balancer rules that are part of GSLB rule", responseObject = LoadBalancerResponse.class)
     private List<LoadBalancerResponse> siteLoadBalancers;
@@ -143,6 +147,11 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
+
     public void setSiteLoadBalancers(List<LoadBalancerResponse> siteLoadBalancers) {
         this.siteLoadBalancers = siteLoadBalancers;
     }

api/src/main/java/org/apache/cloudstack/api/response/GuestVlanRangeResponse.java

@@ -44,6 +44,10 @@ public class GuestVlanRangeResponse extends BaseResponse implements ControlledEn
     @Param(description = "the domain name of the guest VLAN range")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the domain to which the guest VLAN range belongs", since = "4.19.2.0")
+    private String domainPath;
+
     @SerializedName(ApiConstants.GUEST_VLAN_RANGE)
     @Param(description = "the guest VLAN range")
     private String guestVlanRange;
@@ -83,6 +87,10 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
     public void setGuestVlanRange(String guestVlanRange) {
         this.guestVlanRange = guestVlanRange;
     }

api/src/main/java/org/apache/cloudstack/api/response/GuestVlanResponse.java

@@ -49,6 +49,10 @@ public class GuestVlanResponse extends BaseResponse implements ControlledEntityR
     @Param(description = "the domain name of the guest VLAN range")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the domain to which the guest VLAN range belongs", since = "4.19.2.0")
+    private String domainPath;
+
     @SerializedName(ApiConstants.PROJECT_ID)
     @Param(description = "the project id of the guest VLAN range")
     private String projectId;
@@ -108,6 +112,10 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
     @Override
     public void setProjectId(String projectId) {
         this.projectId = projectId;

api/src/main/java/org/apache/cloudstack/api/response/IPAddressResponse.java

@@ -75,6 +75,10 @@ public class IPAddressResponse extends BaseResponseWithAnnotations implements Co
     @Param(description = "the domain the public IP address is associated with")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the domain to which the public IP address belongs", since = "4.19.2.0")
+    private String domainPath;
+
     @SerializedName(ApiConstants.FOR_VIRTUAL_NETWORK)
     @Param(description = "the virtual network for the IP address")
     private Boolean forVirtualNetwork;
@@ -211,6 +215,10 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
     public void setForVirtualNetwork(Boolean forVirtualNetwork) {
         this.forVirtualNetwork = forVirtualNetwork;
     }

api/src/main/java/org/apache/cloudstack/api/response/InstanceGroupResponse.java

@@ -63,6 +63,10 @@ public class InstanceGroupResponse extends BaseResponseWithAnnotations implement
     @Param(description = "the domain name of the instance group")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the Domain the instance group belongs to", since = "4.19.2.0")
+    private String domainPath;
+
     public void setId(String id) {
         this.id = id;
     }
@@ -90,6 +94,11 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
+
     @Override
     public void setProjectId(String projectId) {
         this.projectId = projectId;

api/src/main/java/org/apache/cloudstack/api/response/LoadBalancerResponse.java

@@ -87,6 +87,10 @@ public class LoadBalancerResponse extends BaseResponse implements ControlledEnti
     @Param(description = "the domain of the load balancer rule")
     private String domainName;
 
+    @SerializedName(ApiConstants.DOMAIN_PATH)
+    @Param(description = "path of the domain to which the load balancer rule belongs", since = "4.19.2.0")
+    private String domainPath;
+
     @SerializedName(ApiConstants.STATE)
     @Param(description = "the state of the rule")
     private String state;
@@ -158,6 +162,11 @@ public void setDomainName(String domainName) {
         this.domainName = domainName;
     }
 
+    @Override
+    public void setDomainPath(String domainPath) {
+        this.domainPath = domainPath;
+    }
+
     public void setState(String state) {
         this.state = state;
     }

api/src/main/java/org/apache/cloudstack/api/response/NetworkResponse.java

@@ -453,6 +453,7 @@ public void setDomainName(String domain) {
         this.domain = domain;
     }
 
+    @Override
     public void setDomainPath(String domainPath) {
         this.domainPath = domainPath;
     }