Package org.apache.juli
Class FileHandler
- java.lang.Object
-
- java.util.logging.Handler
-
- org.apache.juli.FileHandler
-
- Direct Known Subclasses:
AsyncFileHandler
public class FileHandler extends Handler
Implementation of Handler that appends log messages to a file named {prefix}{date}{suffix} in a configured directory.The following configuration properties are available:
directory- The directory where to create the log file. If the path is not absolute, it is relative to the current working directory of the application. The Apache Tomcat configuration files usually specify an absolute path for this property,${catalina.base}/logsDefault value:logsrotatable- Iftrue, the log file will be rotated on the first write past midnight and the filename will be{prefix}{date}{suffix}, where date is yyyy-MM-dd. Iffalse, the file will not be rotated and the filename will be{prefix}{suffix}. Default value:trueprefix- The leading part of the log file name. Default value:juli.suffix- The trailing part of the log file name. Default value:.logbufferSize- Configures buffering. The value of0uses system default buffering (typically an 8K buffer will be used). A value of<0forces a writer flush upon each log write. A value>0uses a BufferedOutputStream with the defined value but note that the system default buffering will also be applied. Default value:-1encoding- Character set used by the log file. Default value: empty string, which means to use the system default character set.level- The level threshold for this Handler. See thejava.util.logging.Levelclass for the possible levels. Default value:ALLfilter- Thejava.util.logging.Filterimplementation class name for this Handler. Default value: unsetformatter- Thejava.util.logging.Formatterimplementation class name for this Handler. Default value:org.apache.juli.OneLineFormattermaxDays- The maximum number of days to keep the log files. If the specified value is<=0then the log files will be kept on the file system forever, otherwise they will be kept the specified maximum days. Default value:-1.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classFileHandler.ThreadFactory
-
Field Summary
Fields Modifier and Type Field Description static intDEFAULT_BUFFER_SIZEstatic intDEFAULT_MAX_DAYSprotected ReadWriteLockwriterLockLock used to control access to the writer.
-
Constructor Summary
Constructors Constructor Description FileHandler()FileHandler(String directory, String prefix, String suffix)FileHandler(String directory, String prefix, String suffix, Integer maxDays)FileHandler(String directory, String prefix, String suffix, Integer maxDays, Boolean rotatable, Integer bufferSize)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Close the currently open log file (if any).protected voidcloseWriter()voidflush()Flush the writer.voidopen()Open the new log file for the date specified bydate.protected voidopenWriter()voidpublish(LogRecord record)Format and publish aLogRecord.-
Methods inherited from class java.util.logging.Handler
getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError, setEncoding, setErrorManager, setFilter, setFormatter, setLevel
-
-
-
-
Field Detail
-
DEFAULT_MAX_DAYS
public static final int DEFAULT_MAX_DAYS
- See Also:
- Constant Field Values
-
DEFAULT_BUFFER_SIZE
public static final int DEFAULT_BUFFER_SIZE
- See Also:
- Constant Field Values
-
writerLock
protected final ReadWriteLock writerLock
Lock used to control access to the writer.
-
-
Method Detail
-
publish
public void publish(LogRecord record)
Format and publish aLogRecord.
-
close
public void close()
Close the currently open log file (if any).
-
closeWriter
protected void closeWriter()
-
open
public void open()
Open the new log file for the date specified bydate.
-
openWriter
protected void openWriter()
-
-