org.jwall.audit.EventProcessorPipeline Maven / Gradle / Ivy

Go to download
/*
 *  Copyright (C) 2007-2014 Christian Bockermann 
 *
 *  This file is part of the  web-audit  library.
 *
 *  web-audit library is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The  web-audit  library 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see .
 *
 */
package org.jwall.audit;

import org.jwall.audit.Event;
import org.jwall.audit.EventProcessor;
import org.jwall.audit.EventProcessorException;


/**
 * This interface defines an abstract event processor pipeline. Processors
 * can subscribe to this pipeline to act upon an event.
 * 
 * @author Christian Bockermann <[email protected]>
 *
 * @param 
 */
public interface EventProcessorPipeline {
	
	
	/**
	 * 
	 * 
	 * @param event
	 * @throws EventProcessorException
	 */
	public void process( E event ) throws EventProcessorException;
	
	
	/**
	 * Register a new event processor in this pipeline. The processor may specify a priority,
	 * signaling at which position it wants to be inserted. Processing is done from low numbers
	 * to high numbers.
	 * 
	 * Priorities smaller than 1 and larger than 10 are reserved to internal processors. Registering
	 * a non-internal processor with invalid priority will register that processor with the nearest
	 * valid priority value.
	 * 
	 * @param priority The priority with which this processor is inserted into the pipeline.
	 * @param proc The new processor to be added to the pipeline.
	 */
	public void register( Double priority , EventProcessor proc );
	
	
	/**
	 * Unregister the given processor from this pipeline.
	 * 
	 * @param proc The processor to remove from the pipeline.
	 */
	public void unregister( EventProcessor proc );
	
	
	public Double getPriority( EventProcessor proc );
}