Initial commit of persistence extensions

bundles/core/org.eclipse.smarthome.core.persistence/src/main/java/org/eclipse/smarthome/core/persistence/HistoricItem.java

@@ -27,23 +27,23 @@ public interface HistoricItem {
 
     /**
      * returns the timestamp of the persisted item
-     * 
+     *
      * @return the timestamp of the item
      */
     Date getTimestamp();
 
     /**
      * returns the current state of the item
-     * 
+     *
      * @return the current state
      */
-    public State getState();
+    State getState();
 
     /**
      * returns the name of the item
-     * 
+     *
      * @return the name of the item
      */
-    public String getName();
+    String getName();
 
 }

bundles/core/org.eclipse.smarthome.core.persistence/src/main/java/org/eclipse/smarthome/core/persistence/ModifiablePersistenceService.java

@@ -0,0 +1,47 @@
+/**
+ * Copyright (c) 2014-2015 openHAB UG (haftungsbeschraenkt) 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.smarthome.core.persistence;
+
+import java.util.Date;
+
+import org.eclipse.smarthome.core.items.Item;
+
+/**
+ * This class provides an interface to the a {@link PersistenceService} to allow data to be stored
+ * at a specific time. This allows bindings that interface to devices that store data internally,
+ * and then periodically provide it to the server to be accommodated.
+ *
+ * @author Chris Jackson - Initial implementation and API
+ *
+ */
+public interface ModifiablePersistenceService extends QueryablePersistenceService {
+    /**
+     * <p>
+     * Stores the historic item value. This allows the item, time and value to be specified.
+     * </p>
+     * <p>
+     * Implementors should keep in mind that all registered {@link PersistenceService}s are called synchronously. Hence
+     * long running operations should be processed asynchronously. E.g. <code>store</code> adds things to a queue which
+     * is processed by some asynchronous workers (Quartz Job, Thread, etc.).
+     * </p>
+     *
+     * @param item the data to be stored
+     * @param date the date of the record
+     */
+    void store(Item item, Date date);
+
+    /**
+     * Removes data associated with an item from a persistence service.
+     * If all data is removed for the specified item, the persistence service should free any resources associated with
+     * the item (eg. remove any tables or delete files from the storage).
+     *
+     * @param filter the filter to apply to the data removal
+     * @return true if the query executed successfully
+     */
+    boolean remove(FilterCriteria filter);
+}

bundles/core/org.eclipse.smarthome.core.persistence/src/main/java/org/eclipse/smarthome/core/persistence/PersistenceItemInfo.java

@@ -0,0 +1,36 @@
+/**
+ * Copyright (c) 2014-2015 openHAB UG (haftungsbeschraenkt) 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.smarthome.core.persistence;
+
+/**
+ * This class provides information about an item that is stored in a persistence service.
+ * It is used to return information about the item to the system
+ *
+ * @author Chris Jackson - Initial contribution
+ *
+ */
+public interface PersistenceItemInfo {
+    /**
+     * Returns the item name.
+     * It should be noted that the item name is as stored in the persistence service and as such may not be linked to an
+     * item. This may be the case if the item was removed from the system, but data still exists in the persistence
+     * service.
+     *
+     * @return Item name
+     */
+    String getName();
+
+    /**
+     * Returns the number of rows of data associated with the item
+     * Note that this should be used as a guide to the amount of data and may note be 100% accurate. If accurate
+     * information is required, the {@link QueryablePersistenceService#query} method should be used.
+     *
+     * @return count of the number of rows of data.
+     */
+    Integer getRows();
+}

bundles/core/org.eclipse.smarthome.core.persistence/src/main/java/org/eclipse/smarthome/core/persistence/QueryablePersistenceService.java

@@ -7,20 +7,34 @@
  */
 package org.eclipse.smarthome.core.persistence;
 
+import java.util.Set;
+
+import org.eclipse.smarthome.core.items.Item;
+
 /**
  * A queryable persistence service which can be used to store and retrieve
  * data from openHAB. This is most likely some kind of database system.
  *
  * @author Kai Kreuzer - Initial contribution and API
+ * @author Chris Jackson - Added getItems method
  */
 public interface QueryablePersistenceService extends PersistenceService {
 
     /**
      * Queries the {@link PersistenceService} for data with a given filter criteria
-     * 
+     *
      * @param filter the filter to apply to the query
      * @return a time series of items
      */
     Iterable<HistoricItem> query(FilterCriteria filter);
 
+    /**
+     * Returns a list of items that are stored in the persistence service
+     *
+     * This is returned as a string to allow the persistence service to return items that are no long available as an
+     * ESH {@link Item}.
+     *
+     * @return list of strings of item names contained in the store
+     */
+    Set<PersistenceItemInfo> getItems();
 }

bundles/io/org.eclipse.smarthome.io.rest.core/META-INF/MANIFEST.MF

@@ -40,6 +40,7 @@ Import-Package: com.google.common.base,
  org.eclipse.smarthome.io.rest,
  org.eclipse.smarthome.io.rest.core.item,
  org.eclipse.smarthome.io.rest.core.thing,
+ org.openhab.core.items,
  org.osgi.framework,
  org.osgi.service.cm,
  org.osgi.service.component,

bundles/io/org.eclipse.smarthome.io.rest.core/src/main/java/org/eclipse/smarthome/io/rest/core/persistence/PersistenceItemInfoBean.java

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) 2014-2015 openHAB UG (haftungsbeschraenkt) 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.smarthome.io.rest.core.persistence;
+
+/**
+ * This is a java bean that is used to serialize information about items in a persistence service to JSON.
+ *
+ * @author Chris Jackson - Initial Contribution
+ *
+ */
+public class PersistenceItemInfoBean {
+    PersistenceItemInfoBean() {
+    }
+
+    /**
+     * The name of the item in the persistence service
+     */
+    public String name;
+
+    /**
+     * The number of rows of data in the persistence store for the item
+     */
+    public Integer rows;
+}