Add optional name to payload of thing created message

docs/content/apis/dmf_api.md

@@ -52,12 +52,22 @@ Message Properties | Description
 content_type       | The content type of the payload                                                                      | String | true
 reply_to           | Exchange to reply to. The default is sp.direct.exchange which is bound to the sp_direct_queue | String | false
 
-Example headers
+Example headers and payload:
 
 Header                                                                             | MessageProperties
 ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------
 type=THING\_CREATED <br /> tenant=tenant123 <br /> thingId=abc  <br /> sender=Lwm2m | content\_type=application/json <br /> reply_to (optional) =sp.connector.replyTo
 
+Payload Template (optional):
+
+```json
+{
+    "name": "String"
+}
+```
+
+The "name" property specifies the name of the thing, which per default is the thing ID. This property is optional.
+
 ### UPDATE_ATTRIBUTES
 
 Message to update target attributes. This message can be send in response to a _REQUEST_ATTRIBUTES_UPDATE_ event, sent by hawkBit.
@@ -88,10 +98,12 @@ Payload Template:
         "exampleKey1" : "exampleValue1",
         "exampleKey2" : "exampleValue2"
     },
+    "name": "String",
     "mode": "String"
 }
 ```
 
+The "name" property specifies the name of the thing. This property is optional. <br />
 The "mode" property specifies the update mode that should be applied. This property is optional. Possible [mode](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfUpdateMode.java) values:
 
 Value           | Description

hawkbit-dmf/hawkbit-dmf-amqp/src/main/java/org/eclipse/hawkbit/amqp/AmqpMessageHandlerService.java

@@ -10,6 +10,7 @@
 
 import static org.eclipse.hawkbit.repository.RepositoryConstants.MAX_ACTION_COUNT;
 import static org.eclipse.hawkbit.tenancy.configuration.TenantConfigurationProperties.TenantConfigurationKey.MULTI_ASSIGNMENTS_ENABLED;
+import static org.springframework.util.StringUtils.hasText;
 
 import java.io.Serializable;
 import java.net.URI;
@@ -26,6 +27,7 @@
 import org.eclipse.hawkbit.dmf.amqp.api.MessageType;
 import org.eclipse.hawkbit.dmf.json.model.DmfActionUpdateStatus;
 import org.eclipse.hawkbit.dmf.json.model.DmfAttributeUpdate;
+import org.eclipse.hawkbit.dmf.json.model.DmfCreateThing;
 import org.eclipse.hawkbit.dmf.json.model.DmfUpdateMode;
 import org.eclipse.hawkbit.im.authentication.SpPermission.SpringEvalExpressions;
 import org.eclipse.hawkbit.im.authentication.TenantAwareAuthenticationDetails;
@@ -62,11 +64,9 @@
 import org.springframework.util.StringUtils;
 
 /**
- *
  * {@link AmqpMessageHandlerService} handles all incoming target interaction
  * AMQP messages (e.g. create target, check for updates etc.) for the queue
  * which is configured for the property hawkbit.dmf.rabbitmq.receiverQueue.
- *
  */
 public class AmqpMessageHandlerService extends BaseAmqpService {
 
@@ -82,9 +82,11 @@ public class AmqpMessageHandlerService extends BaseAmqpService {
 
     private final SystemSecurityContext systemSecurityContext;
 
+    private static final String THING_ID_NULL = "ThingId is null";
+
     /**
      * Constructor.
-     * 
+     *
      * @param rabbitTemplate
      *            for converting messages
      * @param amqpMessageDispatcherService
@@ -120,7 +122,6 @@ public AmqpMessageHandlerService(final RabbitTemplate rabbitTemplate,
      *            the message type
      * @param tenant
      *            the contentType of the message
-     * 
      * @return a message if <null> no message is send back to sender
      */
     @RabbitListener(queues = "${hawkbit.dmf.rabbitmq.receiverQueue:dmf_receiver}", containerFactory = "listenerContainerFactory")
@@ -132,7 +133,7 @@ public Message onMessage(final Message message,
 
     /**
      * * Executed if a amqp message arrives.
-     * 
+     *
      * @param message
      *            the message
      * @param type
@@ -192,27 +193,43 @@ private static void setTenantSecurityContext(final String tenantId) {
     }
 
     /**
-     * Method to create a new target or to find the target if it already exists.
+     * Method to register a new target.
      *
-     * @param targetID
-     *            the ID of the target/thing
-     * @param ip
-     *            the ip of the target/thing
+     * @param message
+     *            the message that contains the target/thing
+     * @param virtualHost
+     *            the virtual host
      */
     private void registerTarget(final Message message, final String virtualHost) {
-        final String thingId = getStringHeaderKey(message, MessageHeaderKey.THING_ID, "ThingId is null");
+        final String thingId = getStringHeaderKey(message, MessageHeaderKey.THING_ID, THING_ID_NULL);
         final String replyTo = message.getMessageProperties().getReplyTo();
+        String name = null;
+        final Target target;
 
         if (StringUtils.isEmpty(replyTo)) {
             logAndThrowMessageError(message, "No ReplyTo was set for the createThing message.");
         }
 
         try {
             final URI amqpUri = IpUtil.createAmqpUri(virtualHost, replyTo);
-            final Target target = controllerManagement.findOrRegisterTargetIfItDoesNotExist(thingId, amqpUri);
+            if (message.toString().contains("name")) {
+                checkContentTypeJson(message);
+                // Check whether name property set
+                final DmfCreateThing targetProperties = convertMessage(message, DmfCreateThing.class);
+                // Will be true if "name" properly in body and not just contained in some
+                // attributes
+                if (hasText(targetProperties.getName())) {
+                    name = targetProperties.getName();
+                    target = controllerManagement.findOrRegisterTargetIfItDoesNotExist(thingId, amqpUri, name);
+                } else {
+                    target = controllerManagement.findOrRegisterTargetIfItDoesNotExist(thingId, amqpUri);
+                }
+            } else {
+                target = controllerManagement.findOrRegisterTargetIfItDoesNotExist(thingId, amqpUri);
+            }
             LOG.debug("Target {} reported online state.", thingId);
             sendUpdateCommandToTarget(target);
-        } catch (EntityAlreadyExistsException e) {
+        } catch (final EntityAlreadyExistsException e) {
             throw new AmqpRejectAndDontRequeueException("Target already registered, message will be ignored!", e);
         }
     }
@@ -294,7 +311,12 @@ private void handleIncomingEvent(final Message message) {
 
     private void updateAttributes(final Message message) {
         final DmfAttributeUpdate attributeUpdate = convertMessage(message, DmfAttributeUpdate.class);
-        final String thingId = getStringHeaderKey(message, MessageHeaderKey.THING_ID, "ThingId is null");
+        final String thingId = getStringHeaderKey(message, MessageHeaderKey.THING_ID, THING_ID_NULL);
+
+        // If new name provided in body, then change the name
+        if (hasText(attributeUpdate.getName())) {
+            controllerManagement.updateControllerName(thingId, attributeUpdate.getName());
+        }
 
         controllerManagement.updateControllerAttributes(thingId, attributeUpdate.getAttributes(),
                 getUpdateMode(attributeUpdate));

hawkbit-dmf/hawkbit-dmf-amqp/src/test/java/org/eclipse/hawkbit/amqp/AmqpMessageHandlerServiceTest.java

@@ -1,6 +1,6 @@
 /**
  * Copyright (c) 2015 Bosch Software Innovations GmbH and others.
- *
+ * 
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -14,6 +14,7 @@
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyLong;
 import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
@@ -36,6 +37,7 @@
 import org.eclipse.hawkbit.dmf.json.model.DmfActionUpdateStatus;
 import org.eclipse.hawkbit.dmf.json.model.DmfAttributeUpdate;
 import org.eclipse.hawkbit.dmf.json.model.DmfDownloadResponse;
+import org.eclipse.hawkbit.dmf.json.model.DmfCreateThing;
 import org.eclipse.hawkbit.dmf.json.model.DmfUpdateMode;
 import org.eclipse.hawkbit.repository.ArtifactManagement;
 import org.eclipse.hawkbit.repository.ControllerManagement;
@@ -135,6 +137,9 @@ public class AmqpMessageHandlerServiceTest {
     @Captor
     private ArgumentCaptor<UpdateMode> modeCaptor;
 
+    @Captor
+    private ArgumentCaptor<String> targetNameCaptor;
+
     @Before
     @SuppressWarnings({ "rawtypes", "unchecked" })
     public void before() throws Exception {
@@ -193,6 +198,62 @@ public void createThing() {
 
     }
 
+    @Test
+    @Description("Tests the creation of a target/thing with specified name by calling the same method that incoming RabbitMQ messages would access.")
+    public void createThingWithName() {
+        final String knownThingId = "2";
+        final MessageProperties messageProperties = createMessageProperties(MessageType.THING_CREATED);
+        messageProperties.setHeader(MessageHeaderKey.THING_ID, knownThingId);
+        final DmfCreateThing targetProperties = new DmfCreateThing();
+        targetProperties.setName("NonDefaultTargetName");
+
+        final Message message = messageConverter.toMessage(targetProperties, messageProperties);
+
+        final Target targetMock = mock(Target.class);
+
+        final ArgumentCaptor<String> targetIdCaptor = ArgumentCaptor.forClass(String.class);
+        final ArgumentCaptor<URI> uriCaptor = ArgumentCaptor.forClass(URI.class);
+        final ArgumentCaptor<String> targetNameCaptor = ArgumentCaptor.forClass(String.class);
+
+        when(controllerManagementMock.findOrRegisterTargetIfItDoesNotExist(targetIdCaptor.capture(),
+                uriCaptor.capture(), targetNameCaptor.capture())).thenReturn(targetMock);
+        when(controllerManagementMock.findOldestActiveActionByTarget(any())).thenReturn(Optional.empty());
+
+        amqpMessageHandlerService.onMessage(message, MessageType.THING_CREATED.name(), TENANT, "vHost");
+
+        assertThat(targetIdCaptor.getValue()).as("Thing id is wrong").isEqualTo(knownThingId);
+        assertThat(uriCaptor.getValue().toString()).as("Uri is not right").isEqualTo("amqp://vHost/MyTest");
+        assertThat(targetNameCaptor.getValue()).as("Thing name is not right").isEqualTo(targetProperties.getName());
+    }
+
+    @Test
+    @Description("Tests the creation of a target/thing without name but with body by calling the same method that incoming RabbitMQ messages would access.")
+    public void createThingWithBodyWithoutName() {
+        final String knownThingId = "3";
+        final MessageProperties messageProperties = createMessageProperties(MessageType.THING_CREATED);
+        messageProperties.setHeader(MessageHeaderKey.THING_ID, knownThingId);
+        final DmfAttributeUpdate attributeUpdate = new DmfAttributeUpdate();
+        // put "fake" name in the attributes to also test this behaviour, name
+        // should still be default (=targetId)
+        attributeUpdate.getAttributes().put("name", "testValue1");
+
+        final Message message = amqpMessageHandlerService.getMessageConverter().toMessage(attributeUpdate,
+                messageProperties);
+
+        final Target targetMock = mock(Target.class);
+
+        final ArgumentCaptor<String> targetIdCaptor = ArgumentCaptor.forClass(String.class);
+        final ArgumentCaptor<URI> uriCaptor = ArgumentCaptor.forClass(URI.class);
+        when(controllerManagementMock.findOrRegisterTargetIfItDoesNotExist(targetIdCaptor.capture(),
+                uriCaptor.capture())).thenReturn(targetMock);
+        when(controllerManagementMock.findOldestActiveActionByTarget(any())).thenReturn(Optional.empty());
+
+        amqpMessageHandlerService.onMessage(message, MessageType.THING_CREATED.name(), TENANT, "vHost");
+
+        assertThat(targetIdCaptor.getValue()).as("Thing id is wrong").isEqualTo(knownThingId);
+        assertThat(uriCaptor.getValue().toString()).as("Uri is not right").isEqualTo("amqp://vHost/MyTest");
+    }
+
     @Test
     @Description("Tests the target attribute update by calling the same method that incoming RabbitMQ messages would access.")
     public void updateAttributes() {
@@ -219,6 +280,35 @@ public void updateAttributes() {
 
     }
 
+    @Test
+    @Description("Tests the target attribute update with name update by calling the same method that incoming RabbitMQ messages would access.")
+    public void updateAttributesWithName() {
+        final String knownThingId = "1";
+        final MessageProperties messageProperties = createMessageProperties(MessageType.EVENT);
+        messageProperties.setHeader(MessageHeaderKey.THING_ID, knownThingId);
+        messageProperties.setHeader(MessageHeaderKey.TOPIC, "UPDATE_ATTRIBUTES");
+        final DmfAttributeUpdate attributeUpdate = new DmfAttributeUpdate();
+        attributeUpdate.getAttributes().put("testKey1", "testValue1");
+        attributeUpdate.getAttributes().put("testKey2", "testValue2");
+        attributeUpdate.setName("UpdatedTargetName");
+
+        final Message message = amqpMessageHandlerService.getMessageConverter().toMessage(attributeUpdate,
+                messageProperties);
+
+        when(controllerManagementMock.updateControllerAttributes(targetIdCaptor.capture(), attributesCaptor.capture(),
+                modeCaptor.capture())).thenReturn(null);
+        doNothing().when(controllerManagementMock).updateControllerName(targetIdCaptor.capture(), targetNameCaptor.capture());
+
+        amqpMessageHandlerService.onMessage(message, MessageType.EVENT.name(), TENANT, "vHost");
+
+        // verify
+        assertThat(targetIdCaptor.getValue()).as("Thing id is wrong").isEqualTo(knownThingId);
+        assertThat(attributesCaptor.getValue()).as("Attributes is not right")
+                .isEqualTo(attributeUpdate.getAttributes());
+        assertThat(targetNameCaptor.getValue()).as("Thing name is wrong").isEqualTo(attributeUpdate.getName());
+
+    }
+
     @Test
     @Description("Verifies that the update mode is retrieved from the UPDATE_ATTRIBUTES message and passed to the controller management.")
     public void attributeUpdateModes() {

hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfAttributeUpdate.java

@@ -1,6 +1,6 @@
 /**
  * Copyright (c) 2015 Bosch Software Innovations GmbH and others.
- *
+ * 
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -29,6 +29,9 @@ public class DmfAttributeUpdate {
     @JsonProperty
     private DmfUpdateMode mode;
 
+    @JsonProperty
+    private String name;
+
     public DmfUpdateMode getMode() {
         return mode;
     }
@@ -41,4 +44,12 @@ public Map<String, String> getAttributes() {
         return attributes;
     }
 
+    public String getName() {
+        return name;
+    }
+
+    public void setName(final String name) {
+        this.name = name;
+    }
+
 }

hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfCreateThing.java

@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) 2019 Bosch Software Innovations GmbH and others.
+ * 
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.eclipse.hawkbit.dmf.json.model;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * JSON representation of the Attribute THING_CREATED message.
+ */
+@JsonInclude(Include.NON_NULL)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class DmfCreateThing {
+
+    @JsonProperty
+    private String name;
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(final String name) {
+        this.name = name;
+    }
+
+}