Merge branch 'move-delete-device-api' into 'master'

Move permanently delete device API to device-mgt admin interface

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

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

@@ -901,12 +901,7 @@ public interface DeviceManagementService {
                     required = true)
             @PathParam("device-id")
             @Size(max = 45)
-                    String deviceId,
+                    String deviceId);
-            @ApiParam(
-            name = "permanentDelete",
-            value = "Boolean flag indicating whether to permanently delete the device.",
-            required = false)
-            @QueryParam("permanentDelete") boolean permanentDelete);
 
     @GET
     @Path("/{type}/{id}/features")

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

@@ -15,6 +15,22 @@
  *   specific language governing permissions and limitations
  *   under the License.
  *
+ *
+ *   Copyright (c) 2019, Entgra (pvt) Ltd. (https://entgra.io) All Rights Reserved.
+ *
+ *   Entgra (Pvt) Ltd. 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.wso2.carbon.device.mgt.jaxrs.service.api.admin;
 
@@ -76,6 +92,12 @@ import java.util.List;
                         description = "Update the ownership of the device",
                         key = "perm:admin:devices:update-enrollment",
                         permissions = {"/device-mgt/admin/devices/update-enrollment"}
+                ),
+                @Scope(
+                        name = "Permanently Delete the device specified by device id",
+                        description = "Permanently Delete the device specified by device id",
+                        key = "perm:devices:permanent-delete",
+                        permissions = {"/device-mgt/admin/devices/permanent-delete"}
                 )
         }
 )
@@ -225,4 +247,72 @@ public interface DeviceManagementAdminService {
                     value = "List of device identifiers.",
                     required = true)
                     List<String> deviceIdentifiers);
+
+    @DELETE
+    @Path("/type/{device-type}/id/{device-id}")
+    @ApiOperation(
+            produces = MediaType.APPLICATION_JSON,
+            consumes = MediaType.APPLICATION_JSON,
+            httpMethod = "DELETE",
+            value = "Permanently remove the Device Specified by the Device ID",
+            notes = "Returns the status of the permanently deleted device operation and the details of the deleted device.",
+            tags = "Device Management",
+            extensions = {
+                    @Extension(properties = {
+                            @ExtensionProperty(name = Constants.SCOPE, value = "perm:devices:permanent-delete")
+                    })
+            }
+    )
+    @ApiResponses(
+            value = {
+                    @ApiResponse(
+                            code = 200,
+                            message = "OK. \n Successfully deleted the device permanently.",
+                            response = Device.class,
+                            responseHeaders = {
+                                    @ResponseHeader(
+                                            name = "Content-Type",
+                                            description = "The content type of the body"),
+                                    @ResponseHeader(
+                                            name = "ETag",
+                                            description = "Entity Tag of the response resource.\n" +
+                                                          "Used by caches, or in conditional requests."),
+                                    @ResponseHeader(
+                                            name = "Last-Modified",
+                                            description = "Date and time the resource has been modified the last time.\n" +
+                                                          "Used by caches, or in conditional requests."),
+                            }),
+                    @ApiResponse(
+                            code = 304,
+                            message = "Not Modified. Empty body because the client already has the latest " +
+                                      "version of the requested resource."),
+                    @ApiResponse(
+                            code = 400,
+                            message = "Bad Request. \n Invalid request or validation error.",
+                            response = ErrorResponse.class),
+                    @ApiResponse(
+                            code = 404,
+                            message = "Not Found. \n No device is found under the provided type and id.",
+                            response = ErrorResponse.class),
+                    @ApiResponse(
+                            code = 500,
+                            message = "Internal Server Error. \n " +
+                                      "Server error occurred while retrieving information requested device.",
+                            response = ErrorResponse.class)
+            })
+    Response deleteDevicePermanently(
+            @ApiParam(
+                    name = "device-type",
+                    value = "The device type, such as ios, android, or windows.",
+                    required = true)
+            @PathParam("device-type")
+            @Size(max = 45)
+                    String deviceType,
+            @ApiParam(
+                    name = "device-id",
+                    value = "The device identifier of the device.",
+                    required = true)
+            @PathParam("device-id")
+            @Size(max = 45)
+                    String deviceId);
 }

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

@@ -105,7 +105,6 @@ import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
-import java.util.Map;
 
 @Path("/devices")
 @Produces(MediaType.APPLICATION_JSON)
@@ -326,8 +325,7 @@ public class DeviceManagementServiceImpl implements DeviceManagementService {
     @Override
     @Path("/type/{device-type}/id/{device-id}")
     public Response deleteDevice(@PathParam("device-type") String deviceType,
-                                 @PathParam("device-id") String deviceId,
+                                 @PathParam("device-id") String deviceId) {
-                                 @QueryParam("permanentDelete") boolean permanentDelete) {
         DeviceManagementProviderService deviceManagementProviderService =
                 DeviceMgtAPIUtils.getDeviceManagementService();
         try {
@@ -336,16 +334,8 @@ public class DeviceManagementServiceImpl implements DeviceManagementService {
             if (persistedDevice == null) {
                 return Response.status(Response.Status.NOT_FOUND).build();
             }
-
+            boolean response = deviceManagementProviderService.disenrollDevice(deviceIdentifier);
-            boolean response;
-
-            if (permanentDelete) {
-                response = deviceManagementProviderService.deleteDevice(deviceIdentifier);
-            } else {
-                response = deviceManagementProviderService.disenrollDevice(deviceIdentifier);
-            }
             return Response.status(Response.Status.OK).entity(response).build();
-
         } catch (DeviceManagementException e) {
             String msg = "Error encountered while deleting device of type : " + deviceType + " and " +
                     "ID : " + deviceId;

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

@@ -15,28 +15,43 @@
  *   specific language governing permissions and limitations
  *   under the License.
  *
+ *
+ *   Copyright (c) 2019, Entgra (pvt) Ltd. (https://entgra.io) All Rights Reserved.
+ *
+ *   Entgra (Pvt) Ltd. 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.wso2.carbon.device.mgt.jaxrs.service.impl.admin;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-import org.apache.solr.common.StringUtils;
-import org.wso2.carbon.apimgt.integration.generated.client.publisher.StringUtil;
 import org.wso2.carbon.base.MultitenantConstants;
 import org.wso2.carbon.context.CarbonContext;
 import org.wso2.carbon.context.PrivilegedCarbonContext;
 import org.wso2.carbon.device.mgt.common.Device;
+import org.wso2.carbon.device.mgt.common.DeviceIdentifier;
 import org.wso2.carbon.device.mgt.common.DeviceManagementException;
 import org.wso2.carbon.device.mgt.common.InvalidDeviceException;
 import org.wso2.carbon.device.mgt.common.PaginationRequest;
 import org.wso2.carbon.device.mgt.common.UserNotFoundException;
+import org.wso2.carbon.device.mgt.core.service.DeviceManagementProviderService;
 import org.wso2.carbon.device.mgt.jaxrs.beans.DeviceList;
 import org.wso2.carbon.device.mgt.jaxrs.beans.ErrorResponse;
 import org.wso2.carbon.device.mgt.jaxrs.service.api.admin.DeviceManagementAdminService;
 import org.wso2.carbon.device.mgt.jaxrs.service.impl.util.RequestValidationUtil;
 import org.wso2.carbon.device.mgt.jaxrs.util.DeviceMgtAPIUtils;
 
-import javax.validation.constraints.Past;
 import javax.validation.constraints.Size;
 import javax.ws.rs.*;
 import javax.ws.rs.core.MediaType;
@@ -120,4 +135,28 @@ public class DeviceManagementAdminServiceImpl implements DeviceManagementAdminSe
             return Response.status(Response.Status.BAD_REQUEST).entity(msg).build();
         }
     }
+
+    @DELETE
+    @Override
+    @Path("/type/{device-type}/id/{device-id}")
+    public Response deleteDevicePermanently(@PathParam("device-type") String deviceType,
+                                 @PathParam("device-id") String deviceId) {
+        DeviceManagementProviderService deviceManagementProviderService =
+                DeviceMgtAPIUtils.getDeviceManagementService();
+        try {
+            DeviceIdentifier deviceIdentifier = new DeviceIdentifier(deviceId, deviceType);
+            Device persistedDevice = deviceManagementProviderService.getDevice(deviceIdentifier, true);
+            if (persistedDevice == null) {
+                return Response.status(Response.Status.NOT_FOUND).build();
+            }
+            boolean response = deviceManagementProviderService.deleteDevice(deviceIdentifier);
+            return Response.status(Response.Status.OK).entity(response).build();
+        } catch (DeviceManagementException e) {
+            String msg = "Error encountered while permanently deleting device of type : " + deviceType + " and " +
+                         "ID : " + deviceId;
+            log.error(msg, e);
+            return Response.status(Response.Status.BAD_REQUEST)
+                    .entity(new ErrorResponse.ErrorResponseBuilder().setMessage(msg).build()).build();
+        }
+    }
 }

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

@@ -481,8 +481,7 @@ public class DeviceManagementServiceImplTest {
     public void testDeleteDevice() {
         PowerMockito.stub(PowerMockito.method(DeviceMgtAPIUtils.class, "getDeviceManagementService"))
                 .toReturn(this.deviceManagementProviderService);
-        Response response = this.deviceManagementService.deleteDevice(TEST_DEVICE_TYPE, UUID.randomUUID().toString()
+        Response response = this.deviceManagementService.deleteDevice(TEST_DEVICE_TYPE, UUID.randomUUID().toString());
-                , false);
         Assert.assertEquals(response.getStatus(), Response.Status.OK.getStatusCode());
     }
 
@@ -492,8 +491,7 @@ public class DeviceManagementServiceImplTest {
                 .toReturn(this.deviceManagementProviderService);
         Mockito.when(this.deviceManagementProviderService
                 .getDevice(Mockito.any(DeviceIdentifier.class), Mockito.anyBoolean())).thenReturn(null);
-        Response response = this.deviceManagementService.deleteDevice(TEST_DEVICE_TYPE, UUID.randomUUID().toString()
+        Response response = this.deviceManagementService.deleteDevice(TEST_DEVICE_TYPE, UUID.randomUUID().toString());
-                , false);
         Assert.assertEquals(response.getStatus(), Response.Status.NOT_FOUND.getStatusCode());
         Mockito.reset(this.deviceManagementProviderService);
     }
@@ -504,8 +502,7 @@ public class DeviceManagementServiceImplTest {
                 .toReturn(this.deviceManagementProviderService);
         Mockito.when(this.deviceManagementProviderService.disenrollDevice(Mockito.any(DeviceIdentifier.class)))
                 .thenThrow(new DeviceManagementException());
-        Response response = this.deviceManagementService.deleteDevice(TEST_DEVICE_TYPE, UUID.randomUUID().toString()
+        Response response = this.deviceManagementService.deleteDevice(TEST_DEVICE_TYPE, UUID.randomUUID().toString());
-                , false);
         Assert.assertEquals(response.getStatus(), Response.Status.BAD_REQUEST.getStatusCode());
         Mockito.reset(this.deviceManagementProviderService);
     }