com.github.cafaudit.service.core.AuditChannel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of caf-audit Show documentation
The newest version!
/*
 * Copyright 2015-2024 Open Text.
 *
 * 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.
 */
package com.github.cafaudit.service.core;

import com.github.cafaudit.service.core.healthcheck.HealthResult;

import static com.github.cafaudit.service.core.internal.AuditNewEventFactory.createNewEvent;
import java.io.IOException;

public interface AuditChannel extends AutoCloseable
{
    /**
     * Prepares the auditing infrastructure to receive events for the specified application.
     *
     * @param applicationId the identifier of the application
     * @throws java.io.IOException if an error is encountered
     */
    void declareApplication(String applicationId) throws IOException;

    /**
     * Creates an object which can be used for preparing and sending an audit event.
     *
     * @return an audit event builder
     */
    default AuditEventBuilder createEventBuilder()
    {
        return createEventBuilder(createNewEvent());
    }

    /**
     * Creates an object which can be used for preparing and sending an audit event.
     *
     * @param coreMetadataProvider provides values for the core system-provided metadata
     * @return an audit event builder
     */
    AuditEventBuilder createEventBuilder(AuditCoreMetadataProvider coreMetadataProvider);

    /**
     * Checks the current state of the auditing infrastructure.
     * @return the status and any relevant error messages if unhealthy.
     */
    default HealthResult healthCheck() {
        return HealthResult.HEALTHY;
    }
}