summaryrefslogtreecommitdiffstats
path: root/lib/public/files/objectstore/iobjectstore.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/files/objectstore/iobjectstore.php')
-rw-r--r--lib/public/files/objectstore/iobjectstore.php33
1 files changed, 33 insertions, 0 deletions
diff --git a/lib/public/files/objectstore/iobjectstore.php b/lib/public/files/objectstore/iobjectstore.php
new file mode 100644
index 00000000000..b2c5a9da134
--- /dev/null
+++ b/lib/public/files/objectstore/iobjectstore.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace OCP\Files\ObjectStore;
+
+interface IObjectStore {
+
+ /**
+ * @return string the container or bucket name where objects are stored
+ */
+ function getStorageId();
+
+ /**
+ * @param string $urn the unified resource name used to identify the object
+ * @return resource stream with the read data
+ * @throws Exception when something goes wrong, message will be logged
+ */
+ function readObject($urn);
+
+ /**
+ * @param string $urn the unified resource name used to identify the object
+ * @param resource $stream stream with the data to write
+ * @throws Exception when something goes wrong, message will be logged
+ */
+ function writeObject($urn, $stream);
+
+ /**
+ * @param string $urn the unified resource name used to identify the object
+ * @return void
+ * @throws Exception when something goes wrong, message will be logged
+ */
+ function deleteObject($urn);
+
+} \ No newline at end of file