[Core] Added item metadata infrastructure

bundles/core/org.eclipse.smarthome.core.test/src/test/java/org/eclipse/smarthome/core/internal/items/MetadataRegistryImplTest.java

@@ -0,0 +1,123 @@
+/**
+ * Copyright (c) 2014,2018 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.eclipse.smarthome.core.internal.items;
+
+import static org.junit.Assert.*;
+import static org.mockito.ArgumentMatchers.*;
+import static org.mockito.Mockito.*;
+import static org.mockito.MockitoAnnotations.initMocks;
+
+import java.util.Collections;
+
+import org.eclipse.smarthome.core.common.registry.ProviderChangeListener;
+import org.eclipse.smarthome.core.items.Item;
+import org.eclipse.smarthome.core.items.ManagedItemProvider;
+import org.eclipse.smarthome.core.items.ManagedMetadataProvider;
+import org.eclipse.smarthome.core.items.Metadata;
+import org.eclipse.smarthome.core.items.MetadataKey;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Mock;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.ServiceEvent;
+import org.osgi.framework.ServiceListener;
+import org.osgi.framework.ServiceReference;
+
+/**
+ * @author Simon Kaufmann - initial contribution and API
+ */
+public class MetadataRegistryImplTest {
+
+    private static final String ITEM_NAME = "itemName";
+
+    @SuppressWarnings("rawtypes")
+    private @Mock ServiceReference managedProviderRef;
+    private @Mock BundleContext bundleContext;
+    private @Mock ManagedItemProvider itemProvider;
+    private @Mock ManagedMetadataProvider managedProvider;
+    private @Mock Item item;
+
+    private ServiceListener providerTracker;
+
+    private MetadataRegistryImpl registry;
+
+    private ProviderChangeListener<Item> providerChangeListener;
+
+    @Before
+    @SuppressWarnings("unchecked")
+    public void setup() throws Exception {
+        initMocks(this);
+
+        when(bundleContext.getService(same(managedProviderRef))).thenReturn(managedProvider);
+
+        when(item.getName()).thenReturn(ITEM_NAME);
+
+        registry = new MetadataRegistryImpl();
+
+        registry.setManagedItemProvider(itemProvider);
+        registry.setManagedProvider(managedProvider);
+        registry.activate(bundleContext);
+
+        ArgumentCaptor<ServiceListener> captor = ArgumentCaptor.forClass(ServiceListener.class);
+        verify(bundleContext).addServiceListener(captor.capture(), any());
+        providerTracker = captor.getValue();
+        providerTracker.serviceChanged(new ServiceEvent(ServiceEvent.REGISTERED, managedProviderRef));
+
+        ArgumentCaptor<ProviderChangeListener<Item>> captorChangeListener = ArgumentCaptor
+                .forClass(ProviderChangeListener.class);
+        verify(itemProvider).addProviderChangeListener(captorChangeListener.capture());
+        providerChangeListener = captorChangeListener.getValue();
+    }
+
+    @Test
+    public void testManagedItemProviderChangeListenerRegistration() {
+        verify(itemProvider).addProviderChangeListener(any());
+        verifyNoMoreInteractions(itemProvider);
+
+        registry.unsetManagedItemProvider(itemProvider);
+        verify(itemProvider).removeProviderChangeListener(any());
+        verifyNoMoreInteractions(itemProvider);
+    }
+
+    @Test
+    public void testRemoved() {
+        providerChangeListener.removed(itemProvider, item);
+        verify(managedProvider).removeItemMetadata(eq(ITEM_NAME));
+    }
+
+    @Test
+    public void testGet_empty() throws Exception {
+        MetadataKey key = new MetadataKey("namespace", "itemName");
+
+        Metadata res = registry.get(key);
+        assertNull(res);
+    }
+
+    @Test
+    public void testGet() throws Exception {
+        MetadataKey key = new MetadataKey("namespace", "itemName");
+        registry.added(managedProvider, new Metadata(key, "value", Collections.emptyMap()));
+        registry.added(managedProvider,
+                new Metadata(new MetadataKey("other", "itemName"), "other", Collections.emptyMap()));
+        registry.added(managedProvider,
+                new Metadata(new MetadataKey("namespace", "other"), "other", Collections.emptyMap()));
+
+        Metadata res = registry.get(key);
+        assertNotNull(res);
+        assertEquals("value", res.getValue());
+        assertEquals("namespace", res.getUID().getNamespace());
+        assertEquals("itemName", res.getUID().getItemName());
+    }
+
+}

bundles/core/org.eclipse.smarthome.core.test/src/test/java/org/eclipse/smarthome/core/items/MetadataKeyTest.java

@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) 2014,2018 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.eclipse.smarthome.core.items;
+
+import static org.junit.Assert.assertEquals;
+
+import org.junit.Test;
+
+/**
+ * @author Simon Kaufmann - initial contribution and API
+ */
+public class MetadataKeyTest {
+
+    @Test
+    public void testGetNamespace() {
+        assertEquals("namespace", new MetadataKey("namespace", "itemName").getNamespace());
+    }
+
+    @Test
+    public void testGetItemName() {
+        assertEquals("itemName", new MetadataKey("namespace", "itemName").getItemName());
+    }
+
+}

bundles/core/org.eclipse.smarthome.core.thing.test/src/test/java/org/eclipse/smarthome/core/thing/ThingUIDTest.java

@@ -36,4 +36,14 @@ public void testTwoSegments() {
         assertEquals("gaga", t.getId());
         assertEquals("fake::gaga", t.getAsString());
     }
+
+    @Test
+    public void testGetBridgeIds() {
+        ThingTypeUID thingType = new ThingTypeUID("fake", "type");
+        ThingUID t = new ThingUID(thingType, new ThingUID("fake", "something", "bridge"), "thing");
+
+        assertEquals("fake:type:bridge:thing", t.getAsString());
+        assertEquals(1, t.getBridgeIds().size());
+        assertEquals("bridge", t.getBridgeIds().get(0));
+    }
 }

bundles/core/org.eclipse.smarthome.core.thing/src/main/java/org/eclipse/smarthome/core/thing/ChannelUID.java

@@ -12,7 +12,12 @@
  */
 package org.eclipse.smarthome.core.thing;
 
-import java.util.Arrays;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
 
 /**
  * {@link ChannelUID} represents a unique identifier for channels.
@@ -22,6 +27,7 @@
  * @author Dennis Nobel - Added channel group id
  * @author Kai Kreuzer - Changed creation of channels to not require a thing type
  */
+@NonNullByDefault
 public class ChannelUID extends UID {
 
     private static final String CHANNEL_GROUP_SEPERATOR = "#";
@@ -98,17 +104,13 @@ public ChannelUID(String bindingId, String thingTypeId, String thingId, String g
         super(bindingId, thingTypeId, thingId, getChannelId(groupId, id));
     }
 
-    private static String[] getArray(ThingUID thingUID, String groupId, String id) {
-        String[] result = new String[thingUID.getSegments().length + 1];
-        for (int i = 0; i < thingUID.getSegments().length; i++) {
-            result[i] = thingUID.getSegments()[i];
-        }
-        result[result.length - 1] = getChannelId(groupId, id);
-
-        return result;
+    private static List<String> getArray(ThingUID thingUID, @Nullable String groupId, String id) {
+        List<String> ret = new ArrayList<>(thingUID.getAllSegments());
+        ret.add(getChannelId(groupId, id));
+        return ret;
     }
 
-    private static String getChannelId(String groupId, String id) {
+    private static String getChannelId(@Nullable String groupId, String id) {
         return groupId != null ? groupId + CHANNEL_GROUP_SEPERATOR + id : id;
     }
 
@@ -118,8 +120,8 @@ private static String getChannelId(String groupId, String id) {
      * @return id
      */
     public String getId() {
-        String[] segments = getSegments();
-        return segments[segments.length - 1];
+        List<String> segments = getAllSegments();
+        return segments.get(segments.size() - 1);
     }
 
     /**
@@ -128,27 +130,24 @@ public String getId() {
      * @return id id without group id
      */
     public String getIdWithoutGroup() {
-        String[] segments = getSegments();
         if (!isInGroup()) {
-            return segments[segments.length - 1];
+            return getId();
         } else {
-            return segments[segments.length - 1].split(CHANNEL_GROUP_SEPERATOR)[1];
+            return getId().split(CHANNEL_GROUP_SEPERATOR)[1];
         }
     }
 
     public boolean isInGroup() {
-        String[] segments = getSegments();
-        return segments[segments.length - 1].contains(CHANNEL_GROUP_SEPERATOR);
+        return getId().contains(CHANNEL_GROUP_SEPERATOR);
     }
 
     /**
      * Returns the group id.
      *
      * @return group id or null if channel is not in a group
      */
-    public String getGroupId() {
-        String[] segments = getSegments();
-        return isInGroup() ? segments[segments.length - 1].split(CHANNEL_GROUP_SEPERATOR)[0] : null;
+    public @Nullable String getGroupId() {
+        return isInGroup() ? getId().split(CHANNEL_GROUP_SEPERATOR)[0] : null;
     }
 
     @Override
@@ -174,7 +173,8 @@ protected void validateSegment(String segment, int index, int length) {
      * @return the thing UID
      */
     public ThingUID getThingUID() {
-        return new ThingUID(Arrays.copyOfRange(getSegments(), 0, getSegments().length - 1));
+        List<@NonNull String> allSegments = getAllSegments();
+        return new ThingUID(allSegments.subList(0, allSegments.size() - 1).toArray(new String[allSegments.size() - 1]));
     }
 
 }

bundles/core/org.eclipse.smarthome.core.thing/src/main/java/org/eclipse/smarthome/core/thing/ThingUID.java

@@ -173,12 +173,8 @@ public ThingTypeUID getThingTypeUID() {
      * @return list of bridge ids
      */
     public List<String> getBridgeIds() {
-        List<String> bridgeIds = new ArrayList<>();
-        String[] segments = getSegments();
-        for (int i = 2; i < segments.length - 1; i++) {
-            bridgeIds.add(segments[i]);
-        }
-        return bridgeIds;
+        List<String> allSegments = getAllSegments();
+        return allSegments.subList(2, allSegments.size() - 1);
     }
 
     /**
@@ -187,8 +183,8 @@ public List<String> getBridgeIds() {
      * @return id the id
      */
     public String getId() {
-        String[] segments = getSegments();
-        return segments[segments.length - 1];
+        List<String> segments = getAllSegments();
+        return segments.get(segments.size() - 1);
     }
 
     @Override