/*
 * jPOS Project [http://jpos.org]
 * Copyright (C) 2000-2023 jPOS Software SRL
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.jpos.iso;

import org.jpos.util.LogEvent;

/**
 * An ISOFilter has the oportunity to modify an incoming or
 * outgoing ISOMsg that is about to go thru an ISOChannel.
 * It also has the chance to Veto by throwing an Exception
 * @author <a href="mailto:apr@cs.com.uy">Alejandro P. Revilla</a>
 * @version $Revision$ $Date$
 */
public interface ISOFilter {
    class VetoException extends ISOException {

        private static final long serialVersionUID = -4640160572663583113L;
        public VetoException () {
            super();
        }
        public VetoException (String detail) {
            super(detail);
        }
        public VetoException (Exception nested) {
            super(nested);
        }
        public VetoException (String detail, Exception nested) {
            super(detail, nested);
        }
    }
    /**
     * @param channel current ISOChannel instance
     * @param m ISOMsg to filter
     * @param evt LogEvent
     * @return an ISOMsg (possibly parameter m)
     * @throws VetoException
     */
    ISOMsg filter(ISOChannel channel, ISOMsg m, LogEvent evt)
        throws VetoException;
}
