001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2015 ForgeRock AS.
015 */
016package org.forgerock.audit.filter;
017
018import org.forgerock.json.JsonValue;
019
020/**
021 * Interface that represents and audit filter.
022 */
023public interface Filter {
024    /**
025     * Runs a filter on the given audit event. The filter can modify the contents of the audit event.
026     * @param auditTopic The topic the audit event is for.
027     * @param auditEvent The audit event.
028     */
029    void doFilter(final String auditTopic, final JsonValue auditEvent);
030}