001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.log;
020
021import java.util.Collection;
022
023/**
024 * SPI for contributing additional {@link AuditLogEvent} implementations.
025 *
026 * <p>External modules register their event classes by declaring an implementation in
027 * {@code META-INF/services/org.jpos.log.AuditLogEventProvider}; the
028 * {@link AuditLogEventRegistry} discovers and merges them with the built-in mappings
029 * via {@link java.util.ServiceLoader}.</p>
030 *
031 * <p>Type ids must be unique. Providers must not reuse any of the built-in ids
032 * ({@code warn}, {@code start}, {@code stop}, {@code deploy}, {@code undeploy},
033 * {@code msg}, {@code shutdown}, {@code deploy-activity}, {@code throwable},
034 * {@code license}, {@code sysinfo}, {@code connect}, {@code disconnect},
035 * {@code listen}, {@code session-start}, {@code session-end}, {@code txn}).</p>
036 *
037 * @since 3.0.0
038 */
039public interface AuditLogEventProvider {
040    /**
041     * Returns the {@link AuditLogEventType} mappings contributed by this provider.
042     *
043     * @return the type mappings contributed by this provider; must not be {@code null}.
044     */
045    Collection<AuditLogEventType> types();
046}