Merge branch 'serial' into 'master'

Added device filter using serial number.

Closes product-iots#908

See merge request entgra/carbon-device-mgt!759

components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceManagementService.java

@@ -269,6 +269,12 @@ public interface DeviceManagementService {
             @QueryParam("ownership")
             @Size(max = 45)
                     String ownership,
+            @ApiParam(
+                    name = "serialNumber",
+                    value = "The serial number of the device.",
+                    required = false)
+            @QueryParam("serialNumber")
+                    String serialNumber,
             @ApiParam(
                     name = "status",
                     value = "Provide the device status details, such as active or inactive.",

components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/impl/DeviceManagementServiceImpl.java

@@ -172,6 +172,7 @@ public class DeviceManagementServiceImpl implements DeviceManagementService {
             @QueryParam("userPattern") String userPattern,
             @QueryParam("role") String role,
             @QueryParam("ownership") String ownership,
+            @QueryParam("serialNumber") String serialNumber,
             @QueryParam("status") List<String> status,
             @QueryParam("groupId") int groupId,
             @QueryParam("since") String since,
@@ -205,6 +206,9 @@ public class DeviceManagementServiceImpl implements DeviceManagementService {
                 RequestValidationUtil.validateOwnershipType(ownership);
                 request.setOwnership(ownership);
             }
+            if (StringUtils.isNotBlank(serialNumber)) {
+                request.setSerialNumber(serialNumber);
+            }
             if (status != null && !status.isEmpty()) {
                 boolean isStatusEmpty = true;
                 for (String statusString : status){

components/device-mgt/org.wso2.carbon.device.mgt.api/src/test/java/org/wso2/carbon/device/mgt/jaxrs/service/impl/DeviceManagementServiceImplTest.java

@@ -175,7 +175,8 @@ public class DeviceManagementServiceImplTest {
                 .toReturn(this.deviceAccessAuthorizationService);
         Response response = this.deviceManagementService
                 .getDevices(TEST_DEVICE_NAME, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null, DEFAULT_ROLE, DEFAULT_OWNERSHIP,
-                         DEFAULT_STATUS_LIST, 1, null, null, false, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 1, null, null, false,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.BAD_REQUEST.getStatusCode());
     }
 
@@ -194,19 +195,23 @@ public class DeviceManagementServiceImplTest {
 
         Response response = this.deviceManagementService
                 .getDevices(null, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null, DEFAULT_ROLE, DEFAULT_OWNERSHIP,
-                         DEFAULT_STATUS_LIST, 1, null, null, false, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 1, null, null, false,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.OK.getStatusCode());
         response = this.deviceManagementService
                 .getDevices(TEST_DEVICE_NAME, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null, null, DEFAULT_OWNERSHIP,
-                         DEFAULT_STATUS_LIST, 1, null, null, false, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 1, null, null, false,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.OK.getStatusCode());
         response = this.deviceManagementService
                 .getDevices(TEST_DEVICE_NAME, TEST_DEVICE_TYPE, null, null, null, DEFAULT_OWNERSHIP,
-                         DEFAULT_STATUS_LIST, 1, null, null, false, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 1, null, null, false,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.OK.getStatusCode());
         response = this.deviceManagementService
                 .getDevices(TEST_DEVICE_NAME, TEST_DEVICE_TYPE, null, null, null, DEFAULT_OWNERSHIP,
-                         DEFAULT_STATUS_LIST, 1, null, null, true, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 1, null, null, true,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.OK.getStatusCode());
     }
 
@@ -319,7 +324,7 @@ public class DeviceManagementServiceImplTest {
                 .toReturn(this.deviceManagementProviderService);
         Mockito.when(deviceAccessAuthorizationService.isDeviceAdminUser()).thenReturn(true);
         deviceManagementService.getDevices(null, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null,
-                                           DEFAULT_ROLE, DEFAULT_OWNERSHIP, DEFAULT_STATUS_LIST, 1,
+                                           DEFAULT_ROLE, DEFAULT_OWNERSHIP, null, DEFAULT_STATUS_LIST, 1,
                                            null, null, false, 10, 5);
     }
 
@@ -339,11 +344,11 @@ public class DeviceManagementServiceImplTest {
 
         Response response = this.deviceManagementService
                 .getDevices(null, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null, DEFAULT_ROLE, DEFAULT_OWNERSHIP
-                        , DEFAULT_STATUS_LIST, 1, null, null, false, 10, 5);
+                        , null, DEFAULT_STATUS_LIST, 1, null, null, false, 10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.OK.getStatusCode());
         response = this.deviceManagementService
                 .getDevices(null, TEST_DEVICE_TYPE, null, DEFAULT_USERNAME, DEFAULT_ROLE, DEFAULT_OWNERSHIP
-                        , DEFAULT_STATUS_LIST, 1, null, null, false, 10, 5);
+                        , null, DEFAULT_STATUS_LIST, 1, null, null, false, 10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.OK.getStatusCode());
     }
 
@@ -365,7 +370,8 @@ public class DeviceManagementServiceImplTest {
 
         Response response = this.deviceManagementService
                 .getDevices(null, TEST_DEVICE_TYPE, "newuser", null, DEFAULT_ROLE, DEFAULT_OWNERSHIP,
-                            DEFAULT_STATUS_LIST, 0, null, null, false, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 0, null, null, false,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.UNAUTHORIZED.getStatusCode());
         Mockito.reset(this.deviceAccessAuthorizationService);
     }
@@ -386,15 +392,18 @@ public class DeviceManagementServiceImplTest {
 
         Response response = this.deviceManagementService
                 .getDevices(null, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null, DEFAULT_ROLE, DEFAULT_OWNERSHIP,
-                            DEFAULT_STATUS_LIST, 0, null, ifModifiedSince, false, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 0, null, ifModifiedSince, false,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.NOT_MODIFIED.getStatusCode());
         response = this.deviceManagementService
                 .getDevices(null, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null, DEFAULT_ROLE, DEFAULT_OWNERSHIP,
-                            DEFAULT_STATUS_LIST, 0, null, ifModifiedSince, true, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 0, null, ifModifiedSince, true,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.NOT_MODIFIED.getStatusCode());
         response = this.deviceManagementService
                 .getDevices(null, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null, DEFAULT_ROLE, DEFAULT_OWNERSHIP,
-                            DEFAULT_STATUS_LIST, 0, null, "ErrorModifiedSince", false, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 0, null, "ErrorModifiedSince",
+                        false, 10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.BAD_REQUEST.getStatusCode());
     }
 
@@ -414,15 +423,18 @@ public class DeviceManagementServiceImplTest {
 
         Response response = this.deviceManagementService
                 .getDevices(null, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null, DEFAULT_ROLE, DEFAULT_OWNERSHIP,
-                         DEFAULT_STATUS_LIST, 0, since, null, false, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 0, since, null, false,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.OK.getStatusCode());
         response = this.deviceManagementService
                 .getDevices(null, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null, DEFAULT_ROLE, DEFAULT_OWNERSHIP,
-                         DEFAULT_STATUS_LIST, 0, since, null, true, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 0, since, null, true,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.OK.getStatusCode());
         response = this.deviceManagementService
                 .getDevices(null, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null, DEFAULT_ROLE, DEFAULT_OWNERSHIP,
-                         DEFAULT_STATUS_LIST, 0, "ErrorSince", null, false, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 0, "ErrorSince", null, false,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.BAD_REQUEST.getStatusCode());
     }
 
@@ -444,7 +456,8 @@ public class DeviceManagementServiceImplTest {
 
         Response response = this.deviceManagementService
                 .getDevices(null, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null, DEFAULT_ROLE, DEFAULT_OWNERSHIP,
-                         DEFAULT_STATUS_LIST, 1, null, null, false, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 1, null, null, false,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.INTERNAL_SERVER_ERROR.getStatusCode());
         Mockito.reset(this.deviceManagementProviderService);
     }
@@ -466,7 +479,8 @@ public class DeviceManagementServiceImplTest {
 
         Response response = this.deviceManagementService
                 .getDevices(null, TEST_DEVICE_TYPE, DEFAULT_USERNAME, null, DEFAULT_ROLE, DEFAULT_OWNERSHIP,
-                         DEFAULT_STATUS_LIST, 1, null, null, false, 10, 5);
+                        null, DEFAULT_STATUS_LIST, 1, null, null, false,
+                        10, 5);
         Assert.assertEquals(response.getStatus(), Response.Status.INTERNAL_SERVER_ERROR.getStatusCode());
         Mockito.reset(this.deviceAccessAuthorizationService);
     }

components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/PaginationRequest.java

@@ -40,6 +40,7 @@ public class PaginationRequest {
     private String ownerRole;
     private Date since;
     private String filter;
+    private String serialNumber;
     private Map<String, Object> property = new HashMap<>();
     private List<String> statusList = new ArrayList<>();
     private OperationLogFilters operationLogFilters = new OperationLogFilters();
@@ -153,6 +154,10 @@ public class PaginationRequest {
         return this.property.get(key);
     }
 
+    public String getSerialNumber() { return serialNumber; }
+
+    public void setSerialNumber(String serialNumber) { this.serialNumber = serialNumber; }
+
     public Map<String, Object> getProperties() {
         Map<String, Object> temp = new HashMap<>();
         temp.putAll(property);

components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/dao/impl/device/GenericDeviceDAOImpl.java

@@ -67,6 +67,9 @@ public class GenericDeviceDAOImpl extends AbstractDeviceDAOImpl {
         boolean isStatusProvided = false;
         Date since = request.getSince();
         boolean isSinceProvided = false;
+        String serial = request.getSerialNumber();
+        boolean isSerialProvided = false;
+
 
         try {
             Connection conn = getConnection();
@@ -87,10 +90,19 @@ public class GenericDeviceDAOImpl extends AbstractDeviceDAOImpl {
                     "d.DESCRIPTION, " +
                     "d.NAME, " +
                     "d.DEVICE_IDENTIFICATION, " +
-                    "t.NAME AS DEVICE_TYPE " +
+                    "t.NAME AS DEVICE_TYPE ";
-                    "FROM DM_DEVICE d, DM_DEVICE_TYPE t ";
+
-
+            if (serial != null) {
-            sql = sql + " WHERE DEVICE_TYPE_ID = t.ID AND d.TENANT_ID = ?";
+                sql = sql + "FROM DM_DEVICE d, DM_DEVICE_TYPE t, DM_DEVICE_INFO i " +
+                        "WHERE DEVICE_TYPE_ID = t.ID " +
+                        "AND d.ID= i.DEVICE_ID " +
+                        "AND i.KEY_FIELD = 'serial' " +
+                        "AND i.VALUE_FIELD = ? " +
+                        "AND d.TENANT_ID = ? ";
+                isSerialProvided = true;
+            } else {
+                sql = sql + "FROM DM_DEVICE d, DM_DEVICE_TYPE t WHERE DEVICE_TYPE_ID = t.ID AND d.TENANT_ID = ? ";
+            }
             //Add query for last updated timestamp
             if (since != null) {
                 sql = sql + " AND d.LAST_UPDATED_TIMESTAMP > ?";
@@ -128,6 +140,9 @@ public class GenericDeviceDAOImpl extends AbstractDeviceDAOImpl {
 
             try (PreparedStatement stmt = conn.prepareStatement(sql)) {
                 int paramIdx = 1;
+                if (isSerialProvided) {
+                    stmt.setString(paramIdx++, serial);
+                }
                 stmt.setInt(paramIdx++, tenantId);
                 if (isSinceProvided) {
                     stmt.setTimestamp(paramIdx++, new Timestamp(since.getTime()));

components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/dao/impl/device/OracleDeviceDAOImpl.java

@@ -68,6 +68,8 @@ public class OracleDeviceDAOImpl extends AbstractDeviceDAOImpl {
         boolean isStatusProvided = false;
         Date since = request.getSince();
         boolean isSinceProvided = false;
+        String serial = request.getSerialNumber();
+        boolean isSerialProvided = false;
 
         try {
             conn = getConnection();
@@ -88,9 +90,19 @@ public class OracleDeviceDAOImpl extends AbstractDeviceDAOImpl {
                     "d.DESCRIPTION, " +
                     "d.NAME, " +
                     "d.DEVICE_IDENTIFICATION, " +
-                    "t.NAME AS DEVICE_TYPE " +
+                    "t.NAME AS DEVICE_TYPE ";
-                    "FROM DM_DEVICE d, " +
+
-                    "DM_DEVICE_TYPE t WHERE DEVICE_TYPE_ID = t.ID AND d.TENANT_ID = ?";
+            if (serial != null) {
+                sql = sql + "FROM DM_DEVICE d, DM_DEVICE_TYPE t, DM_DEVICE_INFO i " +
+                        "WHERE DEVICE_TYPE_ID = t.ID " +
+                        "AND d.ID= i.DEVICE_ID " +
+                        "AND i.KEY_FIELD = 'serial' " +
+                        "AND i.VALUE_FIELD = ? " +
+                        "AND d.TENANT_ID = ? ";
+                isSerialProvided = true;
+            } else {
+                sql = sql + "FROM DM_DEVICE d, DM_DEVICE_TYPE t WHERE DEVICE_TYPE_ID = t.ID AND d.TENANT_ID = ? ";
+            }
             //Add query for last updated timestamp
             if (since != null) {
                 sql = sql + " AND d.LAST_UPDATED_TIMESTAMP > ?";
@@ -128,6 +140,9 @@ public class OracleDeviceDAOImpl extends AbstractDeviceDAOImpl {
 
             try (PreparedStatement stmt = conn.prepareStatement(sql)) {
                 int paramIdx = 1;
+                if (isSerialProvided) {
+                    stmt.setString(paramIdx++, serial);
+                }
                 stmt.setInt(paramIdx++, tenantId);
                 if (isSinceProvided) {
                     stmt.setTimestamp(paramIdx++, new Timestamp(since.getTime()));

components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/dao/impl/device/PostgreSQLDeviceDAOImpl.java

@@ -67,6 +67,8 @@ public class PostgreSQLDeviceDAOImpl extends AbstractDeviceDAOImpl {
         boolean isStatusProvided = false;
         Date since = request.getSince();
         boolean isSinceProvided = false;
+        String serial = request.getSerialNumber();
+        boolean isSerialProvided = false;
 
         try {
             conn = getConnection();
@@ -87,11 +89,19 @@ public class PostgreSQLDeviceDAOImpl extends AbstractDeviceDAOImpl {
                     "d.DESCRIPTION, " +
                     "d.NAME, " +
                     "d.DEVICE_IDENTIFICATION, " +
-                    "t.NAME AS DEVICE_TYPE " +
+                    "t.NAME AS DEVICE_TYPE ";
-                    "FROM DM_DEVICE d, " +
+
-                    "DM_DEVICE_TYPE t " +
+            if (serial != null) {
+                sql = sql + "FROM DM_DEVICE d, DM_DEVICE_TYPE t, DM_DEVICE_INFO i " +
                         "WHERE DEVICE_TYPE_ID = t.ID " +
-                    "AND d.TENANT_ID = ?";
+                        "AND d.ID= i.DEVICE_ID " +
+                        "AND i.KEY_FIELD = 'serial' " +
+                        "AND i.VALUE_FIELD = ? " +
+                        "AND d.TENANT_ID = ? ";
+                isSerialProvided = true;
+            } else {
+                sql = sql + "FROM DM_DEVICE d, DM_DEVICE_TYPE t WHERE DEVICE_TYPE_ID = t.ID AND d.TENANT_ID = ? ";
+            }
             //Add the query for device-type
             if (deviceType != null && !deviceType.isEmpty()) {
                 sql = sql + " AND t.NAME = ?";
@@ -124,6 +134,9 @@ public class PostgreSQLDeviceDAOImpl extends AbstractDeviceDAOImpl {
 
             try (PreparedStatement stmt = conn.prepareStatement(sql)) {
                 int paramIdx = 1;
+                if (isSerialProvided) {
+                    stmt.setString(paramIdx++, serial);
+                }
                 stmt.setInt(paramIdx++, tenantId);
                 if (isDeviceTypeProvided) {
                     stmt.setString(paramIdx++, deviceType);

components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/dao/impl/device/SQLServerDeviceDAOImpl.java

@@ -69,6 +69,8 @@ public class SQLServerDeviceDAOImpl extends AbstractDeviceDAOImpl {
         boolean isStatusProvided = false;
         Date since = request.getSince();
         boolean isSinceProvided = false;
+        String serial = request.getSerialNumber();
+        boolean isSerialProvided = false;
 
         try {
             conn = getConnection();
@@ -89,8 +91,19 @@ public class SQLServerDeviceDAOImpl extends AbstractDeviceDAOImpl {
                     "d.DESCRIPTION, " +
                     "d.NAME, " +
                     "d.DEVICE_IDENTIFICATION, " +
-                    "t.NAME AS DEVICE_TYPE " +
+                    "t.NAME AS DEVICE_TYPE ";
-                    "FROM DM_DEVICE d, DM_DEVICE_TYPE t WHERE DEVICE_TYPE_ID = t.ID AND d.TENANT_ID = ?";
+
+            if (serial != null) {
+                sql = sql + "FROM DM_DEVICE d, DM_DEVICE_TYPE t, DM_DEVICE_INFO i " +
+                        "WHERE DEVICE_TYPE_ID = t.ID " +
+                        "AND d.ID= i.DEVICE_ID " +
+                        "AND i.KEY_FIELD = 'serial' " +
+                        "AND i.VALUE_FIELD = ? " +
+                        "AND d.TENANT_ID = ? ";
+                isSerialProvided = true;
+            } else {
+                sql = sql + "FROM DM_DEVICE d, DM_DEVICE_TYPE t WHERE DEVICE_TYPE_ID = t.ID AND d.TENANT_ID = ? ";
+            }
             //Add query for last updated timestamp
             if (since != null) {
                 sql = sql + " AND d.LAST_UPDATED_TIMESTAMP > ?";
@@ -128,6 +141,9 @@ public class SQLServerDeviceDAOImpl extends AbstractDeviceDAOImpl {
 
             try (PreparedStatement stmt = conn.prepareStatement(sql)) {
                 int paramIdx = 1;
+                if (isSerialProvided) {
+                    stmt.setString(paramIdx++, serial);
+                }
                 stmt.setInt(paramIdx++, tenantId);
                 if (isSinceProvided) {
                     stmt.setTimestamp(paramIdx++, new Timestamp(since.getTime()));