propagate token to user/UI

Author: DaanHoogland

plugins/hypervisors/vmware/src/main/java/com/cloud/hypervisor/vmware/VmwareDatacenterService.java

@@ -23,6 +23,7 @@
 import com.cloud.exception.DiscoveryException;
 import com.cloud.exception.ResourceInUseException;
 import com.cloud.storage.StoragePool;
+import com.cloud.utils.Pair;
 import com.cloud.utils.component.PluggableService;
 import com.cloud.utils.exception.CloudRuntimeException;
 import org.apache.cloudstack.api.command.admin.zone.AddVmwareDcCmd;
@@ -53,5 +54,5 @@ public interface VmwareDatacenterService extends PluggableService {
 
     List<StoragePool> listVsphereStoragePolicyCompatibleStoragePools(ListVsphereStoragePolicyCompatiblePoolsCmd cmd);
 
-    List<UnmanagedInstanceTO> listVMsInDatacenter(ListVmwareDcVmsCmd cmd);
+    Pair<String, List<UnmanagedInstanceTO>> listVMsInDatacenter(ListVmwareDcVmsCmd cmd);
 }

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

@@ -1558,21 +1558,13 @@ public List<StoragePool> listVsphereStoragePolicyCompatibleStoragePools(ListVsph
     }
 
     @Override
-    public List<UnmanagedInstanceTO> listVMsInDatacenter(ListVmwareDcVmsCmd cmd) {
+    public Pair<String, List<UnmanagedInstanceTO>> listVMsInDatacenter(ListVmwareDcVmsCmd cmd) {
         String vcenter = cmd.getVcenter();
         String datacenterName = cmd.getDatacenterName();
         String username = cmd.getUsername();
         String password = cmd.getPassword();
         Integer maxObjects = cmd.getPageSize();
-        boolean forced = cmd.isForced();
-        // TODO refactor to check if the page is available
-        boolean nextPage = cmd.getPageNumber() == null || cmd.getPageNumber() <= 1;
-        if (forced) {
-//             remove existing data from local map
-        }
-        if (nextPage) {
-//            check if there is a next page possible
-        }
+        String token = cmd.getToken();
 
         Long existingVcenterId = cmd.getExistingVcenterId();
         String keyword = cmd.getKeyword();
@@ -1613,10 +1605,7 @@ public List<UnmanagedInstanceTO> listVMsInDatacenter(ListVmwareDcVmsCmd cmd) {
                 s_logger.error(msg);
                 throw new InvalidParameterValueException(msg);
             }
-            List<UnmanagedInstanceTO> instances = Collections.synchronizedList(new ArrayList<>());
-            instances.addAll(dcMo.getVmsOnDatacenter(maxObjects, null).second());
-            return StringUtils.isBlank(keyword) ? instances :
-                    instances.stream().filter(x -> x.getName().toLowerCase().contains(keyword.toLowerCase())).collect(Collectors.toList());
+            return dcMo.getVmsOnDatacenter(maxObjects, token);
         } catch (InvalidParameterValueException | VmwareClientException | InvalidLocaleFaultMsg | InvalidLoginFaultMsg |
                  RuntimeFaultFaultMsg | URISyntaxException | InvalidPropertyFaultMsg | InvocationTargetException |
                  NoSuchMethodException | IllegalAccessException e) {

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

@@ -23,6 +23,7 @@
 import com.cloud.exception.ResourceUnavailableException;
 import com.cloud.hypervisor.vmware.VmwareDatacenterService;
 import com.cloud.user.Account;
+import com.cloud.utils.Pair;
 import com.cloud.utils.exception.CloudRuntimeException;
 import org.apache.cloudstack.api.APICommand;
 import org.apache.cloudstack.api.ApiConstants;
@@ -31,7 +32,6 @@
 import org.apache.cloudstack.api.BaseResponse;
 import org.apache.cloudstack.api.Parameter;
 import org.apache.cloudstack.api.ServerApiException;
-import org.apache.cloudstack.api.response.ListResponse;
 import org.apache.cloudstack.api.response.UnmanagedInstanceResponse;
 import org.apache.cloudstack.api.response.VmwareDatacenterResponse;
 import org.apache.cloudstack.vm.UnmanagedInstanceTO;
@@ -73,11 +73,10 @@ public class ListVmwareDcVmsCmd extends BaseListCmd {
     @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;
+    @Parameter(name = ApiConstants.TOKEN, type = CommandType.STRING,
+            description = "For listVmwareDcVms, if the maximum number of results (the `pagesize`) is exceeded, " +
+                    " a token is returned. This token can be used in subsequent calls to retrieve more results")
+    private String token;
 
     @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, description = "force retrieving new results, ignoring any cached data.")
     private Boolean forced;
@@ -94,16 +93,8 @@ public String getPassword() {
         return password;
     }
 
-    public Integer getPageSize() {
-        return pageSize;
-    }
-
-    public Integer getPageNumber() {
-        return pageNumber;
-    }
-
-    public boolean isForced() {
-        return forced == null ? true : forced;
+    public String getToken() {
+        return token;
     }
 
     public String getDatacenterName() {
@@ -118,7 +109,8 @@ public Long getExistingVcenterId() {
     public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException, NetworkRuleConflictException {
         checkParameters();
         try {
-            List<UnmanagedInstanceTO> vms = _vmwareDatacenterService.listVMsInDatacenter(this);
+            Pair<String, List<UnmanagedInstanceTO>> results = _vmwareDatacenterService.listVMsInDatacenter(this);
+            List<UnmanagedInstanceTO> vms = results.second();
             List<BaseResponse> baseResponseList = new ArrayList<>();
             if (CollectionUtils.isNotEmpty(vms)) {
                 for (UnmanagedInstanceTO vmwareVm : vms) {
@@ -130,9 +122,10 @@ public void execute() throws ResourceUnavailableException, InsufficientCapacityE
             if (CollectionUtils.isEmpty(pagingList)) {
                 pagingList = baseResponseList;
             }
-            ListResponse<BaseResponse> response = new ListResponse<>();
+            VmwarRequestReponse<BaseResponse> response = new VmwarRequestReponse<>();
             response.setResponses(pagingList, baseResponseList.size());
             response.setResponseName(getCommandName());
+            response.setToken(results.first());
             setResponseObject(response);
         } catch (CloudRuntimeException e) {
             String errorMsg = String.format("Error retrieving VMs from VMware VC: %s", e.getMessage());

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

@@ -0,0 +1,33 @@
+// 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.zone;
+
+import org.apache.cloudstack.api.ResponseObject;
+import org.apache.cloudstack.api.response.ListResponse;
+
+public class VmwarRequestReponse <T extends ResponseObject> extends ListResponse<T> {
+    private transient String token;
+
+    public String getToken() {
+        return token;
+    }
+
+    public void setToken(String token) {
+        this.token = token;
+    }
+}