|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.log4j.AppenderSkeleton
org.apache.log4j.WriterAppender
org.apache.log4j.FileAppender
org.opensaml.log.RollingFileAppender
public class RollingFileAppender
A minor refactoring of Log4J's DailyRollingFileAppender. The log4j appender does not provide an easy mechanism for having a file name of name.date.extension, instead it wants to do name.extension.date which on some platforms can be a pain. This appender is meant to handle this case. The file appender will create a file called filename.extension, then it will roll over the files to filename.date.extension. The default date pattern is "'.'yyyy-MM-dd" (i.e. daily roll over) and the default file extnsion is '.log'.
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 | |
---|---|
RollingFileAppender()
Default constructor |
|
RollingFileAppender(org.apache.log4j.Layout layout,
java.lang.String filename,
java.lang.String datePattern,
java.lang.String fileExtension)
Constructor. |
Method Summary | |
---|---|
void |
activateOptions()
|
java.lang.String |
getDatePattern()
Returns the value of the DatePattern option. |
java.lang.String |
getFileExtension()
Gets the extension post-pended to the file name. |
void |
setDatePattern(java.lang.String pattern)
The DatePattern takes a string in the same format as expected by SimpleDateFormat . |
void |
setFileExtension(java.lang.String extension)
Sets the extension post-pended to the file name. |
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, 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 |
---|
public RollingFileAppender()
public RollingFileAppender(org.apache.log4j.Layout layout, java.lang.String filename, java.lang.String datePattern, java.lang.String fileExtension) throws java.io.IOException
layout
- the log entry layout patternfilename
- the file namedatePattern
- the date pattern used to determine rolling behaviorfileExtension
- the file extension to post-pend to log file name
java.io.IOException
- thrown if the file can not be createdMethod Detail |
---|
public java.lang.String getFileExtension()
public void setFileExtension(java.lang.String extension)
extension
- the log file's extensionpublic void setDatePattern(java.lang.String pattern)
SimpleDateFormat
. This options
determines the rollover schedule.
pattern
- the rollover date patternpublic java.lang.String getDatePattern()
public void activateOptions()
activateOptions
in interface org.apache.log4j.spi.OptionHandler
activateOptions
in class org.apache.log4j.FileAppender
protected void subAppend(org.apache.log4j.spi.LoggingEvent event)
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.
subAppend
in class org.apache.log4j.WriterAppender
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |