listNics API: added optional networkId parameter allowing to list nics by network id for the specific vm

Alena Prokharchyk · Alena Prokharchyk · commit 647ea6e2d0b8 · 2014-01-06T17:09:14.000-08:00
diff --git a/api/src/org/apache/cloudstack/api/command/user/vm/ListNicsCmd.java b/api/src/org/apache/cloudstack/api/command/user/vm/ListNicsCmd.java
@@ -19,8 +19,6 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import org.apache.log4j.Logger;
-
 import org.apache.cloudstack.api.APICommand;
 import org.apache.cloudstack.api.ApiCommandJobType;
 import org.apache.cloudstack.api.ApiConstants;
@@ -29,9 +27,11 @@
 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.NetworkResponse;
 import org.apache.cloudstack.api.response.NicResponse;
 import org.apache.cloudstack.api.response.UserVmResponse;
 import org.apache.cloudstack.context.CallContext;
+import org.apache.log4j.Logger;
 
 import com.cloud.exception.ConcurrentOperationException;
 import com.cloud.exception.InsufficientCapacityException;
@@ -55,6 +55,9 @@ public class ListNicsCmd extends BaseListCmd {
     @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "the ID of the vm")
     private Long vmId;
 
+    @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "list nic of the specific vm's network")
+    private Long networkId;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -79,6 +82,10 @@ public Long getVmId() {
         return vmId;
     }
 
+    public Long getNetworkId() {
+        return networkId;
+    }
+
     @Override
     public long getEntityOwnerId() {
         Account caller = CallContext.current().getCallingAccount();
diff --git a/engine/api/src/org/apache/cloudstack/engine/orchestration/service/NetworkOrchestrationService.java b/engine/api/src/org/apache/cloudstack/engine/orchestration/service/NetworkOrchestrationService.java
@@ -208,7 +208,7 @@ void implementNetworkElementsAndResources(DeployDestination dest, ReservationCon
 
     boolean isSecondaryIpSetForNic(long nicId);
 
-    List<? extends Nic> listVmNics(Long vmId, Long nicId);
+    List<? extends Nic> listVmNics(long vmId, Long nicId, Long networkId);
 
     Nic savePlaceholderNic(Network network, String ip4Address, String ip6Address, Type vmType);
 
diff --git a/engine/orchestration/src/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java b/engine/orchestration/src/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java
diff --git a/engine/schema/src/com/cloud/vm/dao/NicDao.java b/engine/schema/src/com/cloud/vm/dao/NicDao.java
@@ -61,7 +61,7 @@ public interface NicDao extends GenericDao<NicVO, Long> {
 
     NicVO findByIp4AddressAndNetworkIdAndInstanceId(long networkId, long instanceId, String ip4Address);
 
-    List<NicVO> listByVmIdAndNicId(Long vmId, Long nicId);
+    List<NicVO> listByVmIdAndNicIdAndNtwkId(long vmId, Long nicId, Long networkId);
 
     NicVO findByIp4AddressAndVmId(String ip4Address, long instance);
 
diff --git a/engine/schema/src/com/cloud/vm/dao/NicDaoImpl.java b/engine/schema/src/com/cloud/vm/dao/NicDaoImpl.java
@@ -244,10 +244,17 @@ public NicVO findByIp4AddressAndNetworkIdAndInstanceId(long networkId, long inst
     }
 
     @Override
-    public List<NicVO> listByVmIdAndNicId(Long vmId, Long nicId) {
+    public List<NicVO> listByVmIdAndNicIdAndNtwkId(long vmId, Long nicId, Long networkId) {
         SearchCriteria<NicVO> sc = AllFieldsSearch.create();
         sc.setParameters("instance", vmId);
-        sc.setParameters("nicid", nicId);
+
+        if (nicId != null) {
+            sc.setParameters("nicid", nicId);
+        }
+
+        if (networkId != null) {
+            sc.setParameters("network", networkId);
+        }
         return listBy(sc);
     }
 
diff --git a/server/src/com/cloud/network/NetworkServiceImpl.java b/server/src/com/cloud/network/NetworkServiceImpl.java
@@ -3988,17 +3988,18 @@ public Network getNetwork(String networkUuid) {
     public List<? extends Nic> listNics(ListNicsCmd cmd) {
         Account caller = CallContext.current().getCallingAccount();
         Long nicId = cmd.getNicId();
-        Long vmId = cmd.getVmId();
+        long vmId = cmd.getVmId();
+        Long networkId = cmd.getNetworkId();
 
         UserVmVO userVm = _userVmDao.findById(vmId);
 
         if (userVm == null) {
             InvalidParameterValueException ex = new InvalidParameterValueException("Virtual mahine id does not exist");
-            ex.addProxyObject(vmId.toString(), "vmId");
+            ex.addProxyObject(Long.valueOf(vmId).toString(), "vmId");
             throw ex;
         }
         _accountMgr.checkAccess(caller, null, true, userVm);
-        return _networkMgr.listVmNics(vmId, nicId);
+        return _networkMgr.listVmNics(vmId, nicId, networkId);
     }
 
     public List<NetworkGuru> getNetworkGurus() {
diff --git a/server/test/com/cloud/vpc/MockNetworkManagerImpl.java b/server/test/com/cloud/vpc/MockNetworkManagerImpl.java
@@ -803,7 +803,7 @@ public boolean releaseSecondaryIpFromNic(long ipAddressId) {
     }
 
     @Override
-    public List<? extends Nic> listVmNics(Long vmId, Long nicId) {
+    public List<? extends Nic> listVmNics(long vmId, Long nicId, Long networkId) {
         // TODO Auto-generated method stub
         return null;
     }

Original file line number	Diff line number	Diff line change
`@@ -803,7 +803,7 @@ public boolean releaseSecondaryIpFromNic(long ipAddressId) {`
`803`	`803`	`}`
`804`	`804`
`805`	`805`	`@Override`
`806`		`- public List<? extends Nic> listVmNics(Long vmId, Long nicId) {`
	`806`	`+ public List<? extends Nic> listVmNics(long vmId, Long nicId, Long networkId) {`
`807`	`807`	`// TODO Auto-generated method stub`
`808`	`808`	`return null;`
`809`	`809`	`}`