Class AbstractTarget

java.lang.Object
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 Object implements LogTarget, ErrorAware, Closeable
Abstract target.
Author:
Avalon Development Team, Peter Donald

  • Field Details

    • DEFAULT_ERROR_HANDLER

      private static final ErrorHandler DEFAULT_ERROR_HANDLER

    • m_errorHandler

      private ErrorHandler m_errorHandler
      ErrorHandler used by target to delegate Error handling

    • m_isOpen

      private boolean m_isOpen
      Flag indicating that log session is finished (aka target has been closed)

  • Constructor Details

    • AbstractTarget

      public AbstractTarget()
      AbstractTarget constructor.

    • AbstractTarget

      public AbstractTarget(ErrorHandler errorHandler)
      AbstractTarget constructor.
      Parameters:
      errorHandler - the error handler

  • Method Details

    • 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 Exception
      Process a log event, via formatting and outputting it. This should be overidden by subclasses.
      Parameters:
      event - the log event
      Throws:
      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