add paging indicator

Author: DaanHoogland

plugins/hypervisors/vmware/src/main/java/com/cloud/hypervisor/vmware/manager/VmwareManagerImpl.java

@@ -1593,7 +1593,8 @@ public List<UnmanagedInstanceTO> listVMsInDatacenter(ListVmwareDcVmsCmd cmd) {
         String datacenterName = cmd.getDatacenterName();
         String username = cmd.getUsername();
         String password = cmd.getPassword();
-        Integer maxObjects = cmd.getMaxNumber();
+        Integer maxObjects = cmd.getPageSize();
+        boolean nextPage = cmd.getPageNumber() != null && cmd.getPageNumber() > 1 ? false : true;
         Long existingVcenterId = cmd.getExistingVcenterId();
         String keyword = cmd.getKeyword();
 
@@ -1633,7 +1634,7 @@ public List<UnmanagedInstanceTO> listVMsInDatacenter(ListVmwareDcVmsCmd cmd) {
                 s_logger.error(msg);
                 throw new InvalidParameterValueException(msg);
             }
-            List<UnmanagedInstanceTO> instances = dcMo.getVmsOnDatacenter(maxObjects);
+            List<UnmanagedInstanceTO> instances = dcMo.getVmsOnDatacenter(maxObjects, nextPage);
             return StringUtils.isBlank(keyword) ? instances :
                     instances.stream().filter(x -> x.getName().toLowerCase().contains(keyword.toLowerCase())).collect(Collectors.toList());
         } catch (Exception e) {

plugins/hypervisors/vmware/src/main/java/org/apache/cloudstack/api/command/admin/zone/ListVmwareDcVmsCmd.java

@@ -70,8 +70,14 @@ public class ListVmwareDcVmsCmd extends BaseListCmd {
     @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, description = "The password for specified username.")
     private String password;
 
-    @Parameter(name = ApiConstants.MAX_NUMBER, type = CommandType.INTEGER, description = "The maximum number of results to return.")
-    private Integer maxNumber;
+    @Parameter(name = ApiConstants.PAGE_SIZE, type = CommandType.INTEGER, description = "The maximum number of results to return.")
+    private Integer pageSize;
+
+    @Parameter(name = ApiConstants.PAGE, type = CommandType.INTEGER,
+            description = "For listVmwareDcVms, the maximum number of results to return is either 0, 1 or more." +
+                    " When more than 1, the next page as returned by the vcenter will be propagated to the caller." +
+                    " If no previous call has been done, this is the same as the first page")
+    private Integer pageNumber;
 
     public String getVcenter() {
         return vcenter;
@@ -85,8 +91,12 @@ public String getPassword() {
         return password;
     }
 
-    public Integer getMaxNumber() {
-        return maxNumber;
+    public Integer getPageSize() {
+        return pageSize;
+    }
+
+    public Integer getPageNumber() {
+        return pageNumber;
     }
 
     public String getDatacenterName() {

vmware-base/src/main/java/com/cloud/hypervisor/vmware/mo/DatacenterMO.java

@@ -162,9 +162,9 @@ public VirtualMachineMO checkIfVmAlreadyExistsInVcenter(String vmNameOnVcenter,
         return null;
     }
 
-    public List<UnmanagedInstanceTO> getVmsOnDatacenter(Integer maxObjects) throws Exception {
+    public List<UnmanagedInstanceTO> getVmsOnDatacenter(Integer maxObjects, boolean nextPage) throws Exception {
         List<UnmanagedInstanceTO> vms = new ArrayList<>();
-        List<ObjectContent> ocs = getVmPropertiesOnDatacenterVmFolder(new String[] {"name"}, maxObjects);
+        List<ObjectContent> ocs = getVmPropertiesOnDatacenterVmFolder(new String[] {"name"}, maxObjects, nextPage);
         if (ocs != null) {
             for (ObjectContent oc : ocs) {
                 ManagedObjectReference vmMor = oc.getObj();
@@ -312,10 +312,18 @@ public List<ObjectContent> getDatastorePropertiesOnDatacenter(String[] propertyP
     }
 
     public List<ObjectContent> getVmPropertiesOnDatacenterVmFolder(String[] propertyPaths) throws Exception {
-        return getVmPropertiesOnDatacenterVmFolder(propertyPaths, null);
+        return getVmPropertiesOnDatacenterVmFolder(propertyPaths, null, false);
     }
 
-    public List<ObjectContent> getVmPropertiesOnDatacenterVmFolder(String[] propertyPaths, Integer maxObjects) throws Exception {
+    /**
+     *
+     * @param propertyPaths Vmware side property names to query, for instance {"name"}
+     * @param maxObjects the number of objects to retrieve
+     * @param nextPage restart the query or continue a previous query
+     * @return The propertyPaths requested for the objects of type "VirtualMachine" in a list are found/returned by the DC
+     * @throws Exception generic {code}Exception{code} as thrown by Vmware.
+     */
+    public List<ObjectContent> getVmPropertiesOnDatacenterVmFolder(String[] propertyPaths, Integer maxObjects, boolean nextPage) throws Exception {
         PropertySpec pSpec = new PropertySpec();
         pSpec.setType("VirtualMachine");
         pSpec.getPathSet().addAll(Arrays.asList(propertyPaths));