Refactoring of Save Device With Credentials

application/src/main/java/org/thingsboard/server/controller/ControllerConstants.java

@@ -177,50 +177,45 @@ public class ControllerConstants {
             "   \"eventType\":\"DEBUG_RULE_CHAIN\",\n" + DEBUG_FILTER_OBJ + MARKDOWN_CODE_BLOCK_END;
 
     protected static final String IS_BOOTSTRAP_SERVER_PARAM_DESCRIPTION = "A Boolean value representing the Server SecurityInfo for future Bootstrap client mode settings. Values: 'true' for Bootstrap Server; 'false' for Lwm2m Server. ";
+
     protected static final String DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_DESCRIPTION =
-            "   {\n\"class org.thingsboard.server.common.data.Device\":{\n" +
+                    "{\n" +
+                    "  \"device\": {\n" +
+                    "    \"name\": \"LwRpk00000000\",\n" +
+                    "    \"type\": \"lwm2mProfileRpk\"\n" +
+                    "  },\n" +
+                    "  \"credentials\": {\n" +
                     "    \"id\": \"null\",\n" +
-            "           \"createdTime\":0,\n" +
+                    "    \"createdTime\": 0,\n" +
-            "           \"additionalInfo\":\"null\",\n" +
+                    "    \"deviceId\": \"null\",\n" +
-            "           \"tenantId\":\"null\",\n" +
+                    "    \"credentialsType\": \"LWM2M_CREDENTIALS\",\n" +
-            "           \"customerId\":\"null\",\n" +
+                    "    \"credentialsId\": \"LwRpk00000000\",\n" +
-            "           \"name\":\"LwRpk00000000\",\n" +
+                    "    \"credentialsValue\": {\n" +
-            "           \"type\":\"lwm2mProfileRpk\",\n" +
+                    "      \"client\": {\n" +
-            "           \"label\":\"null\",\"" +
+                    "        \"endpoint\": \"LwRpk00000000\",\n" +
-            "           \"deviceProfileId\":\"null\",\n" +
+                    "        \"securityConfigClientMode\": \"RPK\",\n" +
-            "           \"deviceData\":\"null\",\n" +
+                    "        \"key\": \"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\"\n" +
-            "           \"firmwareId\":\"null\",\n" +
-            "           \"softwareId\":\"null\"\n" +
                     "      },\n" +
-            "   \"class org.thingsboard.server.common.data.security.DeviceCredentials\":{\n" +
+                    "      \"bootstrap\": {\n" +
-            "       \"class_DeviceCredentials1\":{\n" +
+                    "        \"bootstrapServer\": {\n" +
-            "           \"id\":\"null\",\n" +
+                    "          \"securityMode\": \"RPK\",\n" +
-            "           \"createdTime\":0,\n" +
+                    "          \"clientPublicKeyOrId\": \"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\",\n" +
-            "           \"deviceId\":\"null|',\n" +
+                    "          \"clientSecretKey\": \"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgd9GAx7yZW37autew5KZykn4IgRpge/tZSjnudnZJnMahRANCAARQQHE2X9Fxgk2byaT3ULJVeggmJE5gOVdxJKorp7lsMfA5bhmI3aU2ddqXIXQnHDwxsDK2cMwRFfICNrlUQx5V\"\n" +
-            "           \"credentialsType\":\"LWM2M_CREDENTIALS\",\n" +
-            "           \"credentialsId\":\"LwRpk00000000\",\n" +
-            "           \"credentialsValue\":{\n" +
-            "               \"client\":{\n" +
-            "                   \"endpoint\":\"LwRpk00000000\",\n" +
-            "                   \"securityConfigClientMode\":\"RPK\",\n" +
-            "                   \"key\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\"\n" +
                     "        },\n" +
-            "               \"bootstrap\":{\n" +
+                    "        \"lwm2mServer\": {\n" +
-            "                   \"bootstrapServer\":{\n" +
+                    "          \"securityMode\": \"RPK\",\n" +
-            "                       \"securityMode\":\"RPK\",\n" +
+                    "          \"clientPublicKeyOrId\": \"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\",\n" +
-            "                       \"clientPublicKeyOrId\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\",\n" +
+                    "          \"clientSecretKey\": \"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgd9GAx7yZW37autew5KZykn4IgRpge/tZSjnudnZJnMahRANCAARQQHE2X9Fxgk2byaT3ULJVeggmJE5gOVdxJKorp7lsMfA5bhmI3aU2ddqXIXQnHDwxsDK2cMwRFfICNrlUQx5V\"\n" +
-            "                       \"clientSecretKey\":\"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgd9GAx7yZW37autew5KZykn4IgRpge/tZSjnudnZJnMahRANCAARQQHE2X9Fxgk2byaT3ULJVeggmJE5gOVdxJKorp7lsMfA5bhmI3aU2ddqXIXQnHDwxsDK2cMwRFfICNrlUQx5V\"" +
-            "                   },\n" +
-            "                   \"lwm2mServer\":{\n" +
-            "                       \"securityMode\":\"RPK\",\n" +
-            "                       \"clientPublicKeyOrId\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\",\n" +
-            "                       \"clientSecretKey\":\"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgd9GAx7yZW37autew5KZykn4IgRpge/tZSjnudnZJnMahRANCAARQQHE2X9Fxgk2byaT3ULJVeggmJE5gOVdxJKorp7lsMfA5bhmI3aU2ddqXIXQnHDwxsDK2cMwRFfICNrlUQx5V\"\n" +
                     "        }\n" +
                     "      }\n" +
                     "    }\n" +
                     "  }\n" +
                     "}";
 
+    protected static final String DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_DESCRIPTION_MARKDOWN =
+            MARKDOWN_CODE_BLOCK_START + DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_DESCRIPTION + MARKDOWN_CODE_BLOCK_END;
+
+
     protected static final String FILTER_VALUE_TYPE = NEW_LINE + "## Value Type and Operations" + NEW_LINE +
             "Provides a hint about the data type of the entity field that is defined in the filter key. " +
             "The value type impacts the list of possible operations that you may use in the corresponding predicate. For example, you may use 'STARTS_WITH' or 'END_WITH', but you can't use 'GREATER_OR_EQUAL' for string values." +

application/src/main/java/org/thingsboard/server/controller/DeviceController.java

@@ -15,6 +15,7 @@
  */
 package org.thingsboard.server.controller;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.common.util.concurrent.FutureCallback;
 import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
@@ -46,6 +47,7 @@ import org.thingsboard.server.common.data.Device;
 import org.thingsboard.server.common.data.DeviceInfo;
 import org.thingsboard.server.common.data.EntitySubtype;
 import org.thingsboard.server.common.data.EntityType;
+import org.thingsboard.server.common.data.SaveDeviceWithCredentialsRequest;
 import org.thingsboard.server.common.data.Tenant;
 import org.thingsboard.server.common.data.audit.ActionType;
 import org.thingsboard.server.common.data.device.DeviceSearchQuery;
@@ -83,6 +85,7 @@ import javax.annotation.Nullable;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.UUID;
 import java.util.stream.Collectors;
 
@@ -96,6 +99,8 @@ import static org.thingsboard.server.controller.ControllerConstants.DEVICE_PROFI
 import static org.thingsboard.server.controller.ControllerConstants.DEVICE_SORT_PROPERTY_ALLOWABLE_VALUES;
 import static org.thingsboard.server.controller.ControllerConstants.DEVICE_TEXT_SEARCH_DESCRIPTION;
 import static org.thingsboard.server.controller.ControllerConstants.DEVICE_TYPE_DESCRIPTION;
+import static org.thingsboard.server.controller.ControllerConstants.DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_DESCRIPTION;
+import static org.thingsboard.server.controller.ControllerConstants.DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_DESCRIPTION_MARKDOWN;
 import static org.thingsboard.server.controller.ControllerConstants.EDGE_ASSIGN_ASYNC_FIRST_STEP_DESCRIPTION;
 import static org.thingsboard.server.controller.ControllerConstants.EDGE_ASSIGN_RECEIVE_STEP_DESCRIPTION;
 import static org.thingsboard.server.controller.ControllerConstants.EDGE_ID_PARAM_DESCRIPTION;
@@ -198,7 +203,37 @@ public class DeviceController extends BaseController {
                     null, created ? ActionType.ADDED : ActionType.UPDATED, e);
             throw handleException(e);
         }
+    }
 
+    @ApiOperation(value = "Create Device (saveDevice) with credentials ",
+            notes = "Create or update the Device. When creating device, platform generates Device Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address). " +
+                    "Requires to provide the Device Credentials object as well. Useful to create device and credentials in one request. " +
+                    "You may find the example of LwM2M device and RPK credentials below: \n\n" +
+                    DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_DESCRIPTION_MARKDOWN +
+                    TENANT_OR_CUSTOMER_AUTHORITY_PARAGRAPH)
+    @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
+    @RequestMapping(value = "/device-with-credentials", method = RequestMethod.POST)
+    @ResponseBody
+    public Device saveDeviceWithCredentials(@ApiParam(value = "The JSON object with device and credentials. See method description above for example.")
+                                            @RequestBody SaveDeviceWithCredentialsRequest deviceAndCredentials) throws ThingsboardException {
+        Device device = checkNotNull(deviceAndCredentials.getDevice());
+        DeviceCredentials credentials = checkNotNull(deviceAndCredentials.getCredentials());
+        try {
+            device.setTenantId(getCurrentUser().getTenantId());
+            checkEntity(device.getId(), device, Resource.DEVICE);
+            Device savedDevice = deviceService.saveDeviceWithCredentials(device, credentials);
+            checkNotNull(savedDevice);
+            tbClusterService.onDeviceUpdated(savedDevice, device);
+            logEntityAction(savedDevice.getId(), savedDevice,
+                    savedDevice.getCustomerId(),
+                    device.getId() == null ? ActionType.ADDED : ActionType.UPDATED, null);
+
+            return savedDevice;
+        } catch (Exception e) {
+            logEntityAction(emptyId(EntityType.DEVICE), device,
+                    null, device.getId() == null ? ActionType.ADDED : ActionType.UPDATED, e);
+            throw handleException(e);
+        }
     }
 
     private void onDeviceCreatedOrUpdated(Device savedDevice, Device oldDevice, boolean updated, SecurityUser user) {

application/src/main/java/org/thingsboard/server/controller/Lwm2mController.java

@@ -19,6 +19,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
 import io.swagger.annotations.ApiOperation;
 import io.swagger.annotations.ApiParam;
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -28,6 +29,7 @@ import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.RestController;
 import org.thingsboard.server.common.data.Device;
 import org.thingsboard.server.common.data.EntityType;
+import org.thingsboard.server.common.data.SaveDeviceWithCredentialsRequest;
 import org.thingsboard.server.common.data.audit.ActionType;
 import org.thingsboard.server.common.data.exception.ThingsboardException;
 import org.thingsboard.server.common.data.lwm2m.ServerSecurityConfig;
@@ -46,6 +48,10 @@ import static org.thingsboard.server.controller.ControllerConstants.TENANT_OR_CU
 @TbCoreComponent
 @RequestMapping("/api")
 public class Lwm2mController extends BaseController {
+
+    @Autowired
+    private DeviceController deviceController;
+
     public static final String IS_BOOTSTRAP_SERVER = "isBootstrapServer";
 
 
@@ -66,41 +72,14 @@ public class Lwm2mController extends BaseController {
         }
     }
 
-    @ApiOperation(value = "Create Device (saveDevice) with credentials ",
+    @ApiOperation(hidden = true, value = "Save device with credentials (Deprecated)")
-            notes = "\nCreate new Device  with credentials (example with security mode: RPK\n" +
-                    "\nRequestBody is the Map<Class<?>, Object>:\n" +
-                    "\nThe first param of this map: Device\n"+
-                    "\n-- key1 = \"class org.thingsboard.server.common.data.Device\" - value1 = \"new Device()\"\n" +
-                    "\nThe second param of this map: Device credentials\n" +
-                    "\n-- key2 = \"class org.thingsboard.server.common.data.security.DeviceCredentials\" - value2 = \"new DeviceCredentials()\"\n" +
-                    "\n- Example of the RequestBody with security mode: RPK:\n" +
-                    "\n- " + DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_DESCRIPTION + "\n" +
-                    "\nWhen creating new device, platform generates Device Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address).\n" +
-                    "\nAfter creating new device Device DeviceCredentials is added to new Device."
-                    + TENANT_OR_CUSTOMER_AUTHORITY_PARAGRAPH)
     @PreAuthorize("hasAnyAuthority('TENANT_ADMIN', 'CUSTOMER_USER')")
     @RequestMapping(value = "/lwm2m/device-credentials", method = RequestMethod.POST)
     @ResponseBody
-    public Device saveDeviceWithCredentials(@ApiParam(value = DEVICE_WITH_DEVICE_CREDENTIALS_PARAM_DESCRIPTION)
+    public Device saveDeviceWithCredentials(@RequestBody Map<Class<?>, Object> deviceWithDeviceCredentials) throws ThingsboardException {
-                                            @RequestBody(required = false) Map<Class<?>, Object> deviceWithDeviceCredentials) throws ThingsboardException {
         ObjectMapper mapper = new ObjectMapper();
         Device device = checkNotNull(mapper.convertValue(deviceWithDeviceCredentials.get(Device.class), Device.class));
         DeviceCredentials credentials = checkNotNull(mapper.convertValue(deviceWithDeviceCredentials.get(DeviceCredentials.class), DeviceCredentials.class));
-        try {
+        return deviceController.saveDeviceWithCredentials(new SaveDeviceWithCredentialsRequest(device, credentials));
-            device.setTenantId(getCurrentUser().getTenantId());
-            checkEntity(device.getId(), device, Resource.DEVICE);
-            Device savedDevice = deviceService.saveDeviceWithCredentials(device, credentials);
-            checkNotNull(savedDevice);
-            tbClusterService.onDeviceUpdated(savedDevice, device);
-            logEntityAction(savedDevice.getId(), savedDevice,
-                    savedDevice.getCustomerId(),
-                    device.getId() == null ? ActionType.ADDED : ActionType.UPDATED, null);
-
-            return savedDevice;
-        } catch (Exception e) {
-            logEntityAction(emptyId(EntityType.DEVICE), device,
-                    null, device.getId() == null ? ActionType.ADDED : ActionType.UPDATED, e);
-            throw handleException(e);
-        }
     }
 }

common/data/src/main/java/org/thingsboard/server/common/data/SaveDeviceWithCredentialsRequest.java

@@ -0,0 +1,32 @@
+/**
+ * Copyright © 2016-2021 The Thingsboard Authors
+ *
+ * Licensed 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.thingsboard.server.common.data;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Data;
+import org.thingsboard.server.common.data.security.DeviceCredentials;
+
+@ApiModel
+@Data
+public class SaveDeviceWithCredentialsRequest {
+
+    @ApiModelProperty(position = 1, value = "The JSON with device entity.", required = true)
+    private final Device device;
+    @ApiModelProperty(position = 2, value = "The JSON with credentials entity.", required = true)
+    private final DeviceCredentials credentials;
+
+}

common/data/src/main/java/org/thingsboard/server/common/data/lwm2m/ServerSecurityConfig.java

@@ -22,23 +22,23 @@ import lombok.Data;
 @ApiModel
 @Data
 public class ServerSecurityConfig {
-    @ApiModelProperty(position = 1, value = "Is Bootstrap Server.", example = "true", readOnly = true)
+    @ApiModelProperty(position = 1, value = "Is Bootstrap Server", example = "true", readOnly = true)
     boolean bootstrapServerIs = true;
-    @ApiModelProperty(position = 2, value = "Host No Security.", example = "0.0.0.0", readOnly = true)
+    @ApiModelProperty(position = 2, value = "Host for 'No Security' mode", example = "0.0.0.0", readOnly = true)
     String host;
-    @ApiModelProperty(position = 3, value = "Port No Security.", example = "5687", readOnly = true)
+    @ApiModelProperty(position = 3, value = "Port for 'No Security' mode", example = "5687", readOnly = true)
     Integer port;
-    @ApiModelProperty(position = 4, value = "Host Security.", example = "0.0.0.0", readOnly = true)
+    @ApiModelProperty(position = 4, value = "Host for 'Security' mode (DTLS)", example = "0.0.0.0", readOnly = true)
     String securityHost;
-    @ApiModelProperty(position = 5, value = "Port Security.", example = "5688", readOnly = true)
+    @ApiModelProperty(position = 5, value = "Port for 'Security' mode (DTLS)", example = "5688", readOnly = true)
     Integer securityPort;
-    @ApiModelProperty(position = 5, value = "Server short Id.", example = "111", readOnly = true)
+    @ApiModelProperty(position = 5, value = "Server short Id", example = "111", readOnly = true)
     Integer serverId = 111;
-    @ApiModelProperty(position = 7, value = "Client Hold Off Time.", example = "1", readOnly = true)
+    @ApiModelProperty(position = 7, value = "Client Hold Off Time", example = "1", readOnly = true)
     Integer clientHoldOffTime = 1;
-    @ApiModelProperty(position = 8, value = "Server Public Key (formar base64).", example = "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n" +
+    @ApiModelProperty(position = 8, value = "Server Public Key (base64 encoded)", example = "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n" +
             "+44sgk3c8g0LotfMpLlZJPhPwJ6ipXV+O1r7IZUjBs3LNA==", readOnly = true)
     String serverPublicKey;
-    @ApiModelProperty(position = 9, value = "Bootstrap Server Account Timeout.", example = "0", readOnly = true)
+    @ApiModelProperty(position = 9, value = "Bootstrap Server Account Timeout", example = "0", readOnly = true)
     Integer bootstrapServerAccountTimeout = 0;
 }

rest-client/src/main/java/org/thingsboard/rest/client/RestClient.java

@@ -57,6 +57,7 @@ import org.thingsboard.server.common.data.EntityViewInfo;
 import org.thingsboard.server.common.data.Event;
 import org.thingsboard.server.common.data.OtaPackage;
 import org.thingsboard.server.common.data.OtaPackageInfo;
+import org.thingsboard.server.common.data.SaveDeviceWithCredentialsRequest;
 import org.thingsboard.server.common.data.TbResource;
 import org.thingsboard.server.common.data.TbResourceInfo;
 import org.thingsboard.server.common.data.Tenant;
@@ -1131,10 +1132,8 @@ public class RestClient implements ClientHttpRequestInterceptor, Closeable {
 
     public Optional<Device> saveDeviceWithCredentials(Device device, DeviceCredentials credentials) {
         try {
-            Map<Class<?>, Object> deviceCredentials = new ConcurrentHashMap<>();
+            SaveDeviceWithCredentialsRequest request = new SaveDeviceWithCredentialsRequest(device, credentials);
-            deviceCredentials.put(Device.class, device);
+            ResponseEntity<Device> deviceOpt = restTemplate.postForEntity(baseURL + "/api/device-with-credentials", request, Device.class);
-            deviceCredentials.put(DeviceCredentials.class, credentials);
-            ResponseEntity<Device> deviceOpt = restTemplate.postForEntity(baseURL + "/api/lwm2m/device-credentials", deviceCredentials, Device.class);
             return Optional.ofNullable(deviceOpt.getBody());
         } catch (HttpClientErrorException exception) {
             if (exception.getStatusCode() == HttpStatus.NOT_FOUND) {
@@ -1145,7 +1144,6 @@ public class RestClient implements ClientHttpRequestInterceptor, Closeable {
         }
     }
 
-
     public PageData<Device> getTenantDevices(String type, PageLink pageLink) {
         Map<String, String> params = new HashMap<>();
         params.put("type", type);