namespace Core.Blueprint.Mongo
{
    /// <summary>
    /// Represents the context for interacting with MongoDB, providing access to connection-related information,
    /// such as the connection string, database name, and audience for authentication.
    /// </summary>
    public interface IMongoContext
    {
        /// <summary>
        /// Gets the connection string used to connect to the MongoDB instance.
        /// </summary>
        /// <returns>A string representing the MongoDB connection string.</returns>
        string GetConnectionString();

        /// <summary>
        /// Gets the name of the MongoDB database.
        /// </summary>
        /// <returns>A string representing the MongoDB database name.</returns>
        string GetDatabasename();

        /// <summary>
        /// Gets the audience (resource identifier) used for MongoDB authentication.
        /// </summary>
        /// <returns>A string representing the MongoDB audience (typically the resource identifier for authentication).</returns>
        string GetAudience();

        /// <summary>
        /// Gets or sets the MongoDB connection string used to connect to the database.
        /// </summary>
        /// <value>A string representing the MongoDB connection string.</value>
        string ConnectionString { get; set; }

        /// <summary>
        /// Gets or sets the name of the MongoDB database.
        /// </summary>
        /// <value>A string representing the MongoDB database name.</value>
        string Databasename { get; set; }

        /// <summary>
        /// Gets or sets the audience (resource identifier) for MongoDB authentication.
        /// </summary>
        /// <value>A string representing the MongoDB audience (resource identifier for authentication).</value>
        string Audience { get; set; }
    }
}