Package org.apache.log.output
Class AbstractOutputTarget
java.lang.Object
org.apache.log.output.AbstractTarget
org.apache.log.output.AbstractOutputTarget
- All Implemented Interfaces:
ErrorAware
,LogTarget
,Closeable
- Direct Known Subclasses:
DatagramOutputTarget
,NullOutputLogTarget
,ServletOutputLogTarget
,SMTPOutputLogTarget
,SocketOutputTarget
,StreamTarget
,WriterTarget
Abstract output target.
Any new output target that is writing to a single connected
resource should extend this class directly or indirectly.
- Author:
- Avalon Development Team, Peter Donald
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionParameterless constructor.AbstractOutputTarget
(Formatter formatter) Creation of a new abstract output target instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Shutdown target.protected void
doProcessEvent
(LogEvent event) Process a log event.private String
Helper method to format an event into a string, using the formatter if available.protected Formatter
Returns the Formatter.private String
getHead()
Helper method to retrieve head for log session.private String
getTail()
Helper method to retrieve tail for log session.protected void
open()
Startup log session.protected void
Abstract method to write data.private void
Helper method to write out log head.private void
Helper method to write out log tail.Methods inherited from class org.apache.log.output.AbstractTarget
getErrorHandler, isOpen, processEvent, setErrorHandler
-
Field Details
-
m_formatter
Formatter for target.
-
-
Constructor Details
-
AbstractOutputTarget
public AbstractOutputTarget()Parameterless constructor. -
AbstractOutputTarget
Creation of a new abstract output target instance.- Parameters:
formatter
- the formatter to apply
-
-
Method Details
-
getFormatter
Returns the Formatter. -
write
Abstract method to write data.- Parameters:
data
- the data to be output
-
doProcessEvent
Process a log event.- Specified by:
doProcessEvent
in classAbstractTarget
- Parameters:
event
- the event to process
-
open
protected void open()Startup log session.- Overrides:
open
in classAbstractTarget
-
close
public void close()Shutdown target. Attempting to write to target after close() will cause errors to be logged.- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classAbstractTarget
-
format
Helper method to format an event into a string, using the formatter if available.- Parameters:
event
- the LogEvent- Returns:
- the formatted string
-
writeHead
private void writeHead()Helper method to write out log head. The head initiates a session of logging. -
writeTail
private void writeTail()Helper method to write out log tail. The tail completes a session of logging. -
getHead
Helper method to retrieve head for log session. TODO: Extract from formatter- Returns:
- the head string
-
getTail
Helper method to retrieve tail for log session. TODO: Extract from formatter- Returns:
- the head string
-