75 lines
2.1 KiB
PHP
75 lines
2.1 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
*
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
|
*
|
|
* @license AGPL-3.0
|
|
*
|
|
* This code is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
* as published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License, version 3,
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
*
|
|
*/
|
|
namespace OCP\Files\ObjectStore;
|
|
|
|
use OCP\Files\NotFoundException;
|
|
|
|
/**
|
|
* Interface IObjectStore
|
|
*
|
|
* @package OCP\Files\ObjectStore
|
|
* @since 7.0.0
|
|
*/
|
|
interface IObjectStore {
|
|
|
|
/**
|
|
* @return string the container or bucket name where objects are stored
|
|
* @since 7.0.0
|
|
*/
|
|
public 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
|
|
* @throws NotFoundException if file does not exist
|
|
* @since 7.0.0
|
|
*/
|
|
public 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
|
|
* @since 7.0.0
|
|
*/
|
|
public 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
|
|
* @since 7.0.0
|
|
*/
|
|
public function deleteObject($urn);
|
|
|
|
/**
|
|
* Check if an object exists in the object store
|
|
*
|
|
* @param string $urn
|
|
* @return bool
|
|
* @since 16.0.0
|
|
*/
|
|
public function objectExists($urn);
|
|
}
|