Tyler Gill
38883285ee
By changing to IEnumerable, it is possible to iterate only a portion of the list, which is useful when not all entries are needed (e.g., when testing a connection). All existing backends have been updated, and any which were able to be changed to yield return results in a straightforward way now do. Many backends had a try/catch in the List() method. Due to the fact that yield returns can't be placed within a try/catch block, these have been refactored to either scope the try/catch to the parts that (should) be the only places throwing exceptions, so that exceptions are still caught and handled. Note that lazy evaluation may cause some changes in behavior - exceptions that were previously thrown at the point of invokation of List() may now be thrown while it is being enumerated. I believe this will not be problematic though, as the only well-known exception seems to be FolderMissingException, which should be thrown by Test(), but TestList() attempts to enumerate the list to force this exception. Any places that require the legacy behavior can get it by simply converting the lazy enumerable to a List()
103 lines
4.1 KiB
C#
103 lines
4.1 KiB
C#
#region Disclaimer / License
|
|
// Copyright (C) 2015, The Duplicati Team
|
|
// http://www.duplicati.com, info@duplicati.com
|
|
//
|
|
// This library is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU Lesser General Public
|
|
// License as published by the Free Software Foundation; either
|
|
// version 2.1 of the License, or (at your option) any later version.
|
|
//
|
|
// This library 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
|
|
// Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
// License along with this library; if not, write to the Free Software
|
|
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
//
|
|
#endregion
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Text;
|
|
|
|
namespace Duplicati.Library.Interface
|
|
{
|
|
/// <summary>
|
|
/// The interface all backends must implement.
|
|
/// The classes that implements this interface MUST also
|
|
/// implement a default constructor and a construtor that
|
|
/// has the signature new(string url, Dictionary<string, string> options).
|
|
/// The default constructor is used to construct an instance
|
|
/// so the DisplayName and other values can be read.
|
|
/// The other constructor is used to do the actual work.
|
|
/// An instance is never reused.
|
|
/// </summary>
|
|
public interface IBackend : IDisposable
|
|
{
|
|
/// <summary>
|
|
/// The localized name to display for this backend
|
|
/// </summary>
|
|
string DisplayName { get;}
|
|
|
|
/// <summary>
|
|
/// The protocol key, eg. ftp, http or ssh
|
|
/// </summary>
|
|
string ProtocolKey { get; }
|
|
|
|
/// <summary>
|
|
/// Enumerates a list of files found on the remote location
|
|
/// </summary>
|
|
/// <returns>The list of files</returns>
|
|
IEnumerable<IFileEntry> List();
|
|
|
|
/// <summary>
|
|
/// Puts the content of the file to the url passed
|
|
/// </summary>
|
|
/// <param name="remotename">The remote filename, relative to the URL</param>
|
|
/// <param name="filename">The local filename</param>
|
|
void Put(string remotename, string filename);
|
|
|
|
/// <summary>
|
|
/// Downloads a file with the remote data
|
|
/// </summary>
|
|
/// <param name="remotename">The remote filename, relative to the URL</param>
|
|
/// <param name="filename">The local filename</param>
|
|
void Get(string remotename, string filename);
|
|
|
|
/// <summary>
|
|
/// Deletes the specified file
|
|
/// </summary>
|
|
/// <param name="remotename">The remote filename, relative to the URL</param>
|
|
void Delete(string remotename);
|
|
|
|
/// <summary>
|
|
/// Gets a list of supported commandline arguments
|
|
/// </summary>
|
|
IList<ICommandLineArgument> SupportedCommands { get; }
|
|
|
|
/// <summary>
|
|
/// A localized description of the backend, for display in the usage information
|
|
/// </summary>
|
|
string Description { get; }
|
|
|
|
/// <summary>
|
|
/// The purpose of this method is to test the connection to the remote backend.
|
|
/// If any problem is encountered, this method should throw an exception.
|
|
/// If the encountered problem is a missing target "folder",
|
|
/// this method should throw a <see cref="FolderMissingException"/>.
|
|
/// </summary>
|
|
void Test();
|
|
|
|
/// <summary>
|
|
/// The purpose of this method is to create the underlying "folder".
|
|
/// This method will be invoked if the <see cref="Test"/> method throws a
|
|
/// <see cref="FolderMissingException"/>.
|
|
/// Backends that have no "folder" concept should not throw
|
|
/// a <see cref="FolderMissingException"/> during <see cref="Test"/>,
|
|
/// and this method should throw a <see cref="MissingMethodException"/>.
|
|
/// </summary>
|
|
void CreateFolder();
|
|
}
|
|
}
|