01: // Copyright 2004, 2005 The Apache Software Foundation
02: //
03: // Licensed under the Apache License, Version 2.0 (the "License");
04: // you may not use this file except in compliance with the License.
05: // You may obtain a copy of the License at
06: //
07: // http://www.apache.org/licenses/LICENSE-2.0
08: //
09: // Unless required by applicable law or agreed to in writing, software
10: // distributed under the License is distributed on an "AS IS" BASIS,
11: // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: // See the License for the specific language governing permissions and
13: // limitations under the License.
14:
15: package org.apache.hivemind;
16:
17: import org.apache.commons.logging.Log;
18:
19: /**
20: * Interface for handling recoverable errors. Recoverable errors are often
21: * caused by improper configuration data in a module descriptor. Implementations
22: * of this interface can either be brittle (throw an ApplicationRuntimeException
23: * immediately) or "mellow" and just log the exception (with the expectation that
24: * a more drastic failure may follow later).
25: *
26: * @author Howard Lewis Ship
27: */
28: public interface ErrorHandler {
29: /**
30: * Handle a recoverable error. May use the log to log the error (and location),
31: * or may throw a runtime exception (probably ApplicationRuntimeException).
32: *
33: * @param log the log used for logging the error
34: * @param message the message to display
35: * @param location location associated with the error if known (possibly null)
36: * @param cause the underlying exception that caused the error if known (possibly null)
37: */
38: public void error(Log log, String message, Location location,
39: Throwable cause);
40: }
|