001    // Copyright 2004, 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.hivemind;
016    
017    import org.apache.commons.logging.Log;
018    
019    /**
020     * Interface for handling recoverable errors.  Recoverable errors are often
021     * caused by improper configuration data in a module descriptor. Implementations
022     * of this interface can either be brittle (throw an ApplicationRuntimeException
023     * immediately) or "mellow" and just log the exception (with the expectation that
024     * a more drastic failure may follow later).
025     *
026     * @author Howard Lewis Ship
027     */
028    public interface ErrorHandler
029    {
030            /**
031             * Handle a recoverable error. May use the log to log the error (and location),
032             * or may throw a runtime exception (probably ApplicationRuntimeException).
033             * 
034             * @param log the log used for logging the error
035             * @param message the message to display
036             * @param location location associated with the error if known (possibly null)
037             * @param cause the underlying exception that caused the error if known (possibly null)
038             */
039            public void error(Log log, String message, Location location, Throwable cause);
040    }