jasenerrorhandler.java

来自「spam source codejasen-0.9jASEN - java An」· Java 代码 · 共 73 行

/*
 * @(#)JasenErrorHandler.java	5/11/2004
 *
 * Copyright (c) 2004, 2005  jASEN.org
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in
 *      the documentation and/or other materials provided with the distribution.
 *
 *   3. The names of the authors may not be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 *
 *   4. Any modification or additions to the software must be contributed back
 *      to the project.
 *
 *   5. Any investigation or reverse engineering of source code or binary to
 *      enable emails to bypass the filters, and hence inflict spam and or viruses
 *      onto users who use or do not use jASEN could subject the perpetrator to
 *      criminal and or civil liability.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JASEN.ORG,
 * OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package org.jasen.interfaces;

/**
 * <P>
 * 	Provides externalisation of internal, unexpected errors.
 * </P>
 * <p>
 * 	Most exceptions which may occur for valid reasons within jASEN are thrown back to the calling application,
 *  however there are a few limited cases where an exception should not break the execution of a scan.
 * </p>
 * <p>
 * 	In such cases, the exception is passed to the error handler defined for the engine, and can then be handled
 *  externally (logged, discarded etc)
 * </p>
 * <p>
 * 	The default error handler for the engine is the SystemErrorHandler which simple prints error traces to System.err
 * </p>
 * <p>
 * 	NOTE: Because of the synchronous nature of this error reporting, it is VERY important that implementors do not 
 *  block for a long period of time on the handleException method.  
 * 	<br/>
 * 	If so, the entire engine may block while waiting for the notification to exit
 * </p>
 * @author Jason Polites
 */
public interface JasenErrorHandler
{
    /**
     * Called when an internal and unexpected, or inert error is thrown
     * @param e
     */
    public void handleException(Exception e);
}