You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
100 lines
2.5 KiB
100 lines
2.5 KiB
<?php |
|
/** |
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
|
* |
|
* @author Björn Schießle <bjoern@schiessle.org> |
|
* @author Joas Schilling <coding@schilljs.com> |
|
* @author Morris Jobke <hey@morrisjobke.de> |
|
* |
|
* @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\Encryption; |
|
|
|
use OC\Encryption\Exceptions\ModuleDoesNotExistsException; |
|
use OC\Encryption\Exceptions\ModuleAlreadyExistsException; |
|
|
|
/** |
|
* This class provides access to files encryption apps. |
|
* |
|
* @since 8.1.0 |
|
*/ |
|
interface IManager { |
|
|
|
/** |
|
* Check if encryption is available (at least one encryption module needs to be enabled) |
|
* |
|
* @return bool true if enabled, false if not |
|
* @since 8.1.0 |
|
*/ |
|
public function isEnabled(); |
|
|
|
/** |
|
* Registers an callback function which must return an encryption module instance |
|
* |
|
* @param string $id |
|
* @param string $displayName |
|
* @param callable $callback |
|
* @throws ModuleAlreadyExistsException |
|
* @since 8.1.0 |
|
*/ |
|
public function registerEncryptionModule($id, $displayName, callable $callback); |
|
|
|
/** |
|
* Unregisters an encryption module |
|
* |
|
* @param string $moduleId |
|
* @since 8.1.0 |
|
*/ |
|
public function unregisterEncryptionModule($moduleId); |
|
|
|
/** |
|
* get a list of all encryption modules |
|
* |
|
* @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
* @since 8.1.0 |
|
*/ |
|
public function getEncryptionModules(); |
|
|
|
|
|
/** |
|
* get a specific encryption module |
|
* |
|
* @param string $moduleId Empty to get the default module |
|
* @return IEncryptionModule |
|
* @throws ModuleDoesNotExistsException |
|
* @since 8.1.0 |
|
*/ |
|
public function getEncryptionModule($moduleId = ''); |
|
|
|
/** |
|
* get default encryption module Id |
|
* |
|
* @return string |
|
* @since 8.1.0 |
|
*/ |
|
public function getDefaultEncryptionModuleId(); |
|
|
|
/** |
|
* set default encryption module Id |
|
* |
|
* @param string $moduleId |
|
* @return string |
|
* @since 8.1.0 |
|
*/ |
|
public function setDefaultEncryptionModule($moduleId); |
|
|
|
}
|
|
|