KeycloakClient.cs

using Microsoft.Extensions.Logging;
using NETCore.Keycloak.Client.Exceptions;
using NETCore.Keycloak.Client.HttpClients.Abstraction;

namespace NETCore.Keycloak.Client.HttpClients.Implementation;

/// <inheritdoc cref="IKeycloakClient"/>
// ReSharper disable once InconsistentNaming
public sealed class KeycloakClient : IKeycloakClient
{
    /// <inheritdoc cref="IKeycloakClient.Auth"/>
    public IKcAuth Auth { get; }

    /// <inheritdoc cref="IKeycloakClient.AttackDetection"/>
    public IKcAttackDetection AttackDetection { get; }

    /// <inheritdoc cref="IKeycloakClient.ClientInitialAccess"/>
    public IKcClientInitialAccess ClientInitialAccess { get; }

    /// <inheritdoc cref="IKeycloakClient.Users"/>
    public IKcUsers Users { get; }

    /// <inheritdoc cref="IKeycloakClient.RoleMappings"/>
    public IKcRoleMappings RoleMappings { get; }

    /// <inheritdoc cref="IKeycloakClient.Roles"/>
    public IKcRoles Roles { get; }

    /// <inheritdoc cref="IKeycloakClient.ClientRoleMappings"/>
    public IKcClientRoleMappings ClientRoleMappings { get; }

    /// <inheritdoc cref="IKeycloakClient.ClientScopes"/>
    public IKcClientScopes ClientScopes { get; }

    /// <inheritdoc cref="IKeycloakClient.Clients"/>
    public IKcClients Clients { get; }

    /// <inheritdoc cref="IKeycloakClient.Groups"/>
    public IKcGroups Groups { get; }

    /// <inheritdoc cref="IKeycloakClient.ProtocolMappers"/>
    public IKcProtocolMappers ProtocolMappers { get; }

    /// <inheritdoc cref="IKeycloakClient.ScopeMappings"/>
    public IKcScopeMappings ScopeMappings { get; }

    /// <inheritdoc cref="IKeycloakClient.Organizations"/>
    public IKcOrganizations Organizations { get; }

    /// <summary>
    /// Initializes a new instance of the <see cref="KeycloakClient"/> class.
    /// Provides access to various Keycloak API services through respective clients.
    /// </summary>
    /// <param name="baseUrl">
    /// The base URL of the Keycloak server.
    /// Example: <c>http://localhost:8080</c>.
    /// The trailing slash, if present, will be automatically removed.
    /// </param>
    /// <param name="logger">
    /// An optional logger instance for logging activities.
    /// If not provided, logging will be disabled. See <see cref="ILogger"/>.
    /// </param>
    /// <exception cref="KcException">Thrown if the <paramref name="baseUrl"/> is null, empty, or contains only whitespace.</exception>
    public KeycloakClient(string baseUrl, ILogger logger = null)
    {
        if ( string.IsNullOrWhiteSpace(baseUrl) )
        {
            throw new KcException($"{nameof(baseUrl)} is required");
        }

        // Remove the trailing slash from the base URL if it exists.
        baseUrl = baseUrl.EndsWith("/", StringComparison.Ordinal)
            ? baseUrl.Remove(baseUrl.Length - 1, 1)
            : baseUrl;

        // Define the admin API base URL for realm-specific administrative operations.
        var adminUrl = $"{baseUrl}/admin/realms";

        // Initialize various Keycloak API clients with their respective base URLs and logger.
        Auth = new KcAuth($"{baseUrl}/realms", logger);
        AttackDetection = new KcAttackDetection(adminUrl, logger);
        ClientInitialAccess = new KcClientInitialAccess(adminUrl, logger);
        Users = new KcUsers(adminUrl, logger);
        Roles = new KcRoles(adminUrl, logger);
        ClientRoleMappings = new KcClientRoleMappings(adminUrl, logger);
        ClientScopes = new KcClientScopes(adminUrl, logger);
        Clients = new KcClients(adminUrl, logger);
        Groups = new KcGroups(adminUrl, logger);
        ProtocolMappers = new KcProtocolMappers(adminUrl, logger);
        ScopeMappings = new KcScopeMappings(adminUrl, logger);
        RoleMappings = new KcRoleMappings(adminUrl, logger);
        Organizations = new KcOrganizations(adminUrl, logger);
    }
}