ICredential.cs

#region License
/* ************************************************************
 *
 *    @author Couchbase <info@couchbase.com>
 *    @copyright 2025 Couchbase, Inc.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 *
 * ************************************************************/
#endregion

using System.Net.Http.Headers;

namespace Couchbase.AnalyticsClient.HTTP;

/// <summary>
/// Represents a credential used to authenticate HTTP requests to the analytics service.
/// </summary>
/// <remarks>
/// Implementations should pre-compute the <see cref="AuthorizationHeader"/> value at
/// construction time for efficiency, since credential instances are immutable.
/// </remarks>
public interface ICredential
{
    /// <summary>
    /// The Authorization header value for this credential, or <c>null</c> if
    /// authentication is handled outside HTTP headers (e.g. mTLS).
    /// </summary>
    AuthenticationHeaderValue? AuthorizationHeader { get; }
}