// Copyright (C) 2026, The Duplicati Team
// https://duplicati.com, hello@duplicati.com
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

using System;
using System.Threading;
using System.Threading.Tasks;

namespace Duplicati.Library.Interface
{
    /// <summary>
    /// An interface a backend may implement if it supports object locking operations.
    /// </summary>
    public interface ILockingBackend : IBackend
    {
        /// <summary>
        /// Gets the expiration time for the immutable object lock on a remote file, if one is set.
        /// </summary>
        /// <param name="remotename">The remote filename, relative to the root.</param>
        /// <param name="cancellationToken">Token to cancel the operation.</param>
        /// <returns>The UTC time when the object lock expires, or <c>null</c> if not set or unknown.</returns>
        Task<DateTime?> GetObjectLockUntilAsync(string remotename, CancellationToken cancellationToken);

        /// <summary>
        /// Applies or updates the immutable object lock for a remote file.
        /// </summary>
        /// <param name="remotename">The remote filename, relative to the root.</param>
        /// <param name="lockUntilUtc">The UTC time until which the object lock should remain in effect.</param>
        /// <param name="cancellationToken">Token to cancel the operation.</param>
        Task SetObjectLockUntilAsync(string remotename, DateTime lockUntilUtc, CancellationToken cancellationToken);
    }
}