/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2015 ForgeRock AS.
 */
package org.forgerock.openam.audit;

import org.forgerock.audit.AuditService;
import org.forgerock.json.resource.ConnectionFactory;

/**
 * Responsible for creating and initializing instances of {@link AuditService} and its associated
 * {@link ConnectionFactory}.
 *
 * @since 13.0.0
 */
public interface AuditServiceProvider {

    /**
     * Get the audit service for the specified realm. If no audit service exists for the given realm, the default
     * audit service will be returned. This audit service will never be {@code null}.
     *
     * @param realm The realm for which the audit service is required.
     * @return the requested audit service.
     */
    AMAuditService getAuditService(String realm);

    /**
     * Get the default audit service, which is not associated with a specific realm.
     * This audit service will never be {@code null}.
     *
     * @return the requested audit service.
     */
    AMAuditService getDefaultAuditService();
}
