Package com.microstrategy.utils.log

Class DatedFileHandler

java.lang.Object

com.microstrategy.utils.log.Handler

com.microstrategy.utils.log.StreamHandler

com.microstrategy.utils.log.FileHandler

com.microstrategy.utils.log.DatedFileHandler

All Implemented Interfaces:

Configurable

public class DatedFileHandler
extends FileHandler

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from class com.microstrategy.utils.log.FileHandler

append, baseFileName, fileInitialized, fileRef, logFileName, logNumber, maxFileCount, maxFileSize

Constructor Summary

Constructors

Constructor	Description
DatedFileHandler()
DatedFileHandler(java.lang.String baseFileName, int maxFileSize, int maxFileCount, boolean append)

Method Summary

Modifier and Type	Method	Description
void	configure(java.lang.String propPrefix)	Requests the configurable object to configure itself.
protected void	createRealFileName(boolean isFirstTime)
protected void	setLogFileName()

Methods inherited from class com.microstrategy.utils.log.FileHandler

getFinalName, getLogFileName, isFileInitialized, publish, setBaseFileName, setNewLogFile, setupFile, writeToNextFile

Methods inherited from class com.microstrategy.utils.log.StreamHandler

close, finalize, flush, getWriter, setEncoding, setOutputStream

Methods inherited from class com.microstrategy.utils.log.Handler

getEncoding, getEncodingSchemeSetting, getException, getFilter, getFilterSetting, getFormatter, getFormatterSetting, getLevel, getLevelSetting, getStringSettingWithDefaultValue, isLoggable, setException, setFilter, setFormatter, setLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

DatedFileHandler

public DatedFileHandler()

DatedFileHandler

public DatedFileHandler(java.lang.String baseFileName,
                        int maxFileSize,
                        int maxFileCount,
                        boolean append)

Method Detail

configure

public void configure(java.lang.String propPrefix)

Description copied from interface: Configurable

Requests the configurable object to configure itself. The "partial properties key" is a parameter of this method. It allows different pluggable logger components to configure themselves without knowing their parent. For example let's assume we have in the logger.properties file a handler named "fileH". Then for the handler itself the prefix will be the "fileH". For the formatter of this handler the prefix will be "fileH.formatter". For the filter of this handler the prefix will be "fileH.filter". And so on. Here is the simplified handler creation workflow:

• A handler is created based on the corresponding class property ("fileH.class" in our example).
• The handler's configure method is called with it's name as a prefix ("fileH" in our example).
• Inside this method the handler reads it's configuration properties and configures itself. Among other things it creates child components. For example it will read the "fileH.filter" property, which defines the filter class name and will create corresponding object.
• For each child component the handler will call it's configure method passing proper prefix. For example for the filter the prefix will be "fileH.filter".

Specified by:

configure in interface Configurable

Overrides:

configure in class FileHandler

Parameters:

propPrefix - String The partial properties key.

setLogFileName

protected void setLogFileName()

Overrides:

setLogFileName in class FileHandler

createRealFileName

protected void createRealFileName(boolean isFirstTime)

Overrides:

createRealFileName in class FileHandler