b6eb952ac6
Failure to prepare the storage during backend or auth mechanism manipulation will throw an InsufficientDataForMeaningfulAnswerException, which is propagated to StorageNotAvailableException in the filesystem layer via the FailedStorage helper class. When a storage is unavailable not due to failure, but due to insufficient data being available, a special 'indeterminate' status is returned to the configuration UI.
67 lines
2.1 KiB
PHP
67 lines
2.1 KiB
PHP
<?php
|
|
/**
|
|
* @author Robin McCorkell <rmccorkell@owncloud.com>
|
|
*
|
|
* @copyright Copyright (c) 2015, ownCloud, Inc.
|
|
* @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 OCA\Files_External\Lib;
|
|
|
|
use \OCP\Files\Storage;
|
|
use \OCA\Files_External\Lib\StorageConfig;
|
|
use \OCA\Files_External\Lib\InsufficientDataForMeaningfulAnswerException;
|
|
use \OCP\Files\StorageNotAvailableException;
|
|
|
|
/**
|
|
* Trait for objects that can modify StorageConfigs and wrap Storages
|
|
*
|
|
* When a storage implementation is being prepared for use, the StorageConfig
|
|
* is passed through manipulateStorageConfig() to update any parameters as
|
|
* necessary. After the storage implementation has been constructed, it is
|
|
* passed through wrapStorage(), potentially replacing the implementation with
|
|
* a wrapped storage that changes its behaviour.
|
|
*
|
|
* Certain configuration options need to be set before the implementation is
|
|
* constructed, while others are retrieved directly from the storage
|
|
* implementation and so need a wrapper to be modified.
|
|
*/
|
|
trait StorageModifierTrait {
|
|
|
|
/**
|
|
* Modify a StorageConfig parameters
|
|
*
|
|
* @param StorageConfig $storage
|
|
* @throws InsufficientDataForMeaningfulAnswerException
|
|
* @throws StorageNotAvailableException
|
|
*/
|
|
public function manipulateStorageConfig(StorageConfig &$storage) {
|
|
}
|
|
|
|
/**
|
|
* Wrap a Storage if necessary
|
|
*
|
|
* @param Storage $storage
|
|
* @return Storage
|
|
* @throws InsufficientDataForMeaningfulAnswerException
|
|
* @throws StorageNotAvailableException
|
|
*/
|
|
public function wrapStorage(Storage $storage) {
|
|
return $storage;
|
|
}
|
|
|
|
}
|
|
|