org.apache.log.output
Class AbstractTarget

java.lang.Object
  extended by org.apache.log.output.AbstractTarget
All Implemented Interfaces:
ErrorAware, LogTarget, Closeable
Direct Known Subclasses:
AbstractJDBCTarget, AbstractJMSTarget, AbstractOutputTarget, AbstractWrappingTarget, MemoryTarget, PriorityFilteringTarget

public abstract class AbstractTarget
extends java.lang.Object
implements LogTarget, ErrorAware, Closeable

Abstract target.

Author:
Avalon Development Team, Peter Donald

Field Summary
private static ErrorHandler DEFAULT_ERROR_HANDLER
           
private  ErrorHandler m_errorHandler
           
private  boolean m_isOpen
           
 
Constructor Summary
AbstractTarget()
          AbstractTarget constructor.
AbstractTarget(ErrorHandler errorHandler)
          AbstractTarget constructor.
 
Method Summary
 void close()
          Shutdown target.
protected abstract  void doProcessEvent(LogEvent event)
          Process a log event, via formatting and outputting it.
protected  ErrorHandler getErrorHandler()
          Helper method to retrieve ErrorHandler for subclasses.
protected  boolean isOpen()
          Return the open state of the target.
protected  void open()
          Startup log session.
 void processEvent(LogEvent event)
          Process a log event, via formatting and outputting it.
 void setErrorHandler(ErrorHandler errorHandler)
          Provide component with ErrorHandler.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_ERROR_HANDLER

private static final ErrorHandler DEFAULT_ERROR_HANDLER

m_errorHandler

private ErrorHandler m_errorHandler

m_isOpen

private boolean m_isOpen
Constructor Detail

AbstractTarget

public AbstractTarget()
AbstractTarget constructor.


AbstractTarget

public AbstractTarget(ErrorHandler errorHandler)
AbstractTarget constructor.

Parameters:
errorHandler - the error handler
Method Detail

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)
Provide component with ErrorHandler.

Specified by:
setErrorHandler in interface ErrorAware
Parameters:
errorHandler - the errorHandler

isOpen

protected boolean isOpen()
Return the open state of the target.

Returns:
TRUE if the target is open else FALSE

open

protected void open()
Startup log session.


processEvent

public void processEvent(LogEvent event)
Process a log event, via formatting and outputting it.

Specified by:
processEvent in interface LogTarget
Parameters:
event - the log event

doProcessEvent

protected abstract void doProcessEvent(LogEvent event)
                                throws java.lang.Exception
Process a log event, via formatting and outputting it. This should be overidden by subclasses.

Parameters:
event - the log event
Throws:
java.lang.Exception - if an event processing error occurs

close

public void close()
Shutdown target. Attempting to write to target after close() will cause errors to be logged.

Specified by:
close in interface Closeable

getErrorHandler

protected final ErrorHandler getErrorHandler()
Helper method to retrieve ErrorHandler for subclasses.

Returns:
the ErrorHandler