de.ipk_gatersleben.bit.bi.edal.primary_data.file.implementation

Class CustomDailyRollingFileAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

org.apache.log4j.WriterAppender

org.apache.log4j.FileAppender

de.ipk_gatersleben.bit.bi.edal.primary_data.file.implementation.CustomDailyRollingFileAppender

All Implemented Interfaces:

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

public class CustomDailyRollingFileAppender
extends org.apache.log4j.FileAppender

CustomDailyRollingFileAppender is based on 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
CustomDailyRollingFileAppender() The default constructor does nothing.
CustomDailyRollingFileAppender(org.apache.log4j.Layout layout, java.lang.String filename, java.lang.String datePattern) Instantiate a DailyRollingFileAppender and open the file designated by filename.

Method Summary

Modifier and Type	Method and Description
void	activateOptions()
protected void	cleanupAndRollOver() This method checks to see if we're exceeding the number of log backups that we are supposed to keep, and if so, deletes the offending files.
java.lang.String	getCompressBackups()
java.lang.String	getDatePattern() Returns the value of the DatePattern option.
int	getMaxDays()
java.lang.String	getMaxNumberOfDays()
void	makePath(java.lang.String filename)
void	setCompressBackups(java.lang.String compressBackups)
void	setDatePattern(java.lang.String pattern) The DatePattern takes a string in the same format as expected by SimpleDateFormat.
void	setFile(java.lang.String filename) Make sure the directory structure for the file exists Based on JBoss DailyRollingFileAppender, org.jboss.logging.appender.DailyRollingFileAppender
void	setMaxNumberOfDays(java.lang.String maxNumberOfDays)
boolean	shouldCompress()
protected void	subAppend(org.apache.log4j.spi.LoggingEvent event) This method differentiates CustomDailyRollingFileAppender from its super class.

Methods inherited from class org.apache.log4j.FileAppender

closeFile, getAppend, getBufferedIO, getBufferSize, getFile, reset, setAppend, setBufferedIO, setBufferSize, 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

CustomDailyRollingFileAppender

public CustomDailyRollingFileAppender()

The default constructor does nothing.

CustomDailyRollingFileAppender

public CustomDailyRollingFileAppender(org.apache.log4j.Layout layout,
                                      java.lang.String filename,
                                      java.lang.String datePattern)
                               throws java.io.IOException

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

Parameters:

layout - the layout

filename - the file name

datePattern - the date pattern

Throws:

java.io.IOException - if failed

Method Detail

setFile

public void setFile(java.lang.String filename)

Make sure the directory structure for the file exists Based on JBoss DailyRollingFileAppender, org.jboss.logging.appender.DailyRollingFileAppender

Overrides:

setFile in class org.apache.log4j.FileAppender

makePath

public void makePath(java.lang.String filename)

setDatePattern

public void setDatePattern(java.lang.String pattern)

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

Parameters:

pattern - the date pattern to set

getDatePattern

public java.lang.String getDatePattern()

Returns the value of the DatePattern option.

Returns:

the date pattern

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 CustomDailyRollingFileAppender 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

cleanupAndRollOver

protected void cleanupAndRollOver()
                           throws java.io.IOException

This method checks to see if we're exceeding the number of log backups that we are supposed to keep, and if so, deletes the offending files. It then delegates to the rollover method to rollover to a new file if required.

Throws:

java.io.IOException - if rollover failed

getMaxNumberOfDays

public java.lang.String getMaxNumberOfDays()

getMaxDays

public int getMaxDays()

setMaxNumberOfDays

public void setMaxNumberOfDays(java.lang.String maxNumberOfDays)

shouldCompress

public boolean shouldCompress()

getCompressBackups

public java.lang.String getCompressBackups()

setCompressBackups

public void setCompressBackups(java.lang.String compressBackups)