com.facebook.logging.log4j

Class CustodianLog4JDailyRollingFileAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

org.apache.log4j.WriterAppender

org.apache.log4j.FileAppender

com.facebook.logging.log4j.CustodianLog4JDailyRollingFileAppender

All Implemented Interfaces:

org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler

public class CustodianLog4JDailyRollingFileAppender
extends org.apache.log4j.FileAppender

CustodianDailyRollingFileAppender is based on org.apache.log4j.appender.DailyRollingFileAppender so most of the configuration options can be taken from the documentation on that class.

Field Summary

Fields inherited from class org.apache.log4j.FileAppender

bufferedIO, bufferSize, fileAppend, fileName

Fields inherited from class org.apache.log4j.WriterAppender

encoding, immediateFlush, qw

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

Constructors

Constructor and Description
CustodianLog4JDailyRollingFileAppender() The default constructor does nothing.
CustodianLog4JDailyRollingFileAppender(org.apache.log4j.Layout layout, String filename, String datePattern) Instantiate a CustodianDailyRollingFileAppender and open the file designated by filename.

Method Summary

Methods

Modifier and Type	Method and Description
void	activateOptions()
protected void	cleanupAndRollOver()
String	getCompressBackups()
String	getDatePattern() Returns the value of the DatePattern option.
String	getMaxNumberOfDays()
void	setCompressBackups(String compressBackups)
void	setDatePattern(String pattern) The DatePattern takes a string in the same format as expected by SimpleDateFormat.
void	setMaxNumberOfDays(String maxNumberOfDays)
protected void	subAppend(org.apache.log4j.spi.LoggingEvent event) This method differentiates DailyRollingFileAppender from its super class.

Methods inherited from class org.apache.log4j.FileAppender

closeFile, getAppend, getBufferedIO, getBufferSize, getFile, reset, setAppend, setBufferedIO, setBufferSize, setFile, setFile, setQWForFiles

Methods inherited from class org.apache.log4j.WriterAppender

append, checkEntryConditions, close, closeWriter, createWriter, getEncoding, getImmediateFlush, requiresLayout, setEncoding, setErrorHandler, setImmediateFlush, setWriter, shouldFlush, writeFooter, writeHeader

Methods inherited from class org.apache.log4j.AppenderSkeleton

addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustodianLog4JDailyRollingFileAppender

public CustodianLog4JDailyRollingFileAppender()

The default constructor does nothing.

CustodianLog4JDailyRollingFileAppender

public CustodianLog4JDailyRollingFileAppender(org.apache.log4j.Layout layout,
                                      String filename,
                                      String datePattern)
                                       throws IOException

Instantiate a CustodianDailyRollingFileAppender and open the file designated by filename. The opened filename will become the ouput destination for this appender.

Throws:

IOException

Method Detail

setDatePattern

public void setDatePattern(String pattern)

The DatePattern takes a string in the same format as expected by SimpleDateFormat. This options determines the rollover schedule.

getDatePattern

public String getDatePattern()

Returns the value of the DatePattern option.

activateOptions

public void activateOptions()

Specified by:

activateOptions in interface org.apache.log4j.spi.OptionHandler

Overrides:

activateOptions in class org.apache.log4j.FileAppender

subAppend

protected void subAppend(org.apache.log4j.spi.LoggingEvent event)

This method differentiates DailyRollingFileAppender from its super class. Before actually logging, this method will check whether it is time to do a rollover. If it is, it will schedule the next rollover time and then rollover.

Overrides:

subAppend in class org.apache.log4j.WriterAppender

getCompressBackups

public String getCompressBackups()

setCompressBackups

public void setCompressBackups(String compressBackups)

getMaxNumberOfDays

public String getMaxNumberOfDays()

setMaxNumberOfDays

public void setMaxNumberOfDays(String maxNumberOfDays)

cleanupAndRollOver

protected void cleanupAndRollOver()
                           throws IOException

Throws:

IOException