Package org.apache.log.output
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
Abstract target.
- Author:
- Avalon Development Team, Peter Donald
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final ErrorHandler
private ErrorHandler
private boolean
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractTarget constructor.AbstractTarget
(ErrorHandler errorHandler) AbstractTarget constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Shutdown target.protected abstract void
doProcessEvent
(LogEvent event) Process a log event, via formatting and outputting it.protected final ErrorHandler
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.
-
Field Details
-
DEFAULT_ERROR_HANDLER
-
m_errorHandler
-
m_isOpen
private boolean m_isOpen
-
-
Constructor Details
-
AbstractTarget
public AbstractTarget()AbstractTarget constructor. -
AbstractTarget
AbstractTarget constructor.- Parameters:
errorHandler
- the error handler
-
-
Method Details
-
setErrorHandler
Provide component with ErrorHandler.- Specified by:
setErrorHandler
in interfaceErrorAware
- 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
Process a log event, via formatting and outputting it.- Specified by:
processEvent
in interfaceLogTarget
- Parameters:
event
- the log event
-
doProcessEvent
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. -
getErrorHandler
Helper method to retrieve ErrorHandler for subclasses.- Returns:
- the ErrorHandler
-