public interface

ErrorHandler

implements OptionHandler
org.apache.log4j.spi.ErrorHandler
Known Indirect Subclasses

Class Overview

Appenders may delegate their error handling to ErrorHandlers.

Error handling is a particularly tedious to get right because by definition errors are hard to predict and to reproduce.

Please take the time to contact the author in case you discover that errors are not properly handled. You are most welcome to suggest new error handling policies or criticize existing policies.

Summary

Public Methods
abstract void error(String message)
This method is normally used to just print the error message passed as a parameter.
abstract void error(String message, Exception e, int errorCode)
Equivalent to the error(String, Exception, int, LoggingEvent) with the the event parameteter set to null.
abstract void error(String message, Exception e, int errorCode, LoggingEvent event)
This method is invoked to handle the error.
abstract void setAppender(Appender appender)
Set the appender for which errors are handled.
abstract void setBackupAppender(Appender appender)
Set the appender to falkback upon in case of failure.
abstract void setLogger(Logger logger)
Add a reference to a logger to which the failing appender might be attached to.
[Expand]
Inherited Methods
From interface org.apache.log4j.spi.OptionHandler

Public Methods

public abstract void error (String message)

This method is normally used to just print the error message passed as a parameter.

public abstract void error (String message, Exception e, int errorCode)

Equivalent to the error(String, Exception, int, LoggingEvent) with the the event parameteter set to null.

public abstract void error (String message, Exception e, int errorCode, LoggingEvent event)

This method is invoked to handle the error.

Parameters
message The message assoicated with the error.
e The Exption that was thrown when the error occured.
errorCode The error code associated with the error.
event The logging event that the failing appender is asked to log.

public abstract void setAppender (Appender appender)

Set the appender for which errors are handled. This method is usually called when the error handler is configured.

public abstract void setBackupAppender (Appender appender)

Set the appender to falkback upon in case of failure.

public abstract void setLogger (Logger logger)

Add a reference to a logger to which the failing appender might be attached to. The failing appender will be searched and replaced only in the loggers you add through this method.

Parameters
logger One of the loggers that will be searched for the failing appender in view of replacement.