summaryrefslogtreecommitdiffstats
path: root/lib/public/files/objectstore/iobjectstore.php
blob: b2c5a9da134ddc1119fba479e3adccfbf6fb3432 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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);

}