| java.lang.Object | |||
| ↳ | com.microstrategy.utils.log.Handler | ||
| ↳ | com.microstrategy.utils.log.StreamHandler | ||
| ↳ | com.microstrategy.utils.log.FileHandler | ||
 Known Direct Subclasses
|
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| protected boolean | append | ||||||||||
| protected String | baseFileName | ||||||||||
| protected File | fileRef | ||||||||||
| protected String | logFileName | ||||||||||
| protected int | logNumber | ||||||||||
| protected int | maxFileCount | ||||||||||
| protected int | maxFileSize | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| FileHandler() | |||||||||||
| FileHandler(String baseFileName, int maxFileSize, int maxFileCount, boolean append) | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| synchronized void |
configure(String propPrefix)
Requests the configurable object to configure itself.
| ||||||||||
| synchronized String | getLogFileName() | ||||||||||
| void | publish(LogRecord record) | ||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| synchronized void | createRealFileName(boolean isFirstTime) | ||||||||||
| String | getFinalName(String newBaseFileName) | ||||||||||
| synchronized void | setBaseFileName(String baseFilename) | ||||||||||
| synchronized void | setLogFileName() | ||||||||||
| void | setNewLogFile(String fileName) | ||||||||||
| synchronized void | setupFile() | ||||||||||
| void | writeToNextFile() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.microstrategy.utils.log.StreamHandler
| |||||||||||
|
From class
com.microstrategy.utils.log.Handler
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
com.microstrategy.utils.log.Configurable
| |||||||||||
Fields
protected boolean append
protected String baseFileName
protected File fileRef
protected String logFileName
protected int logNumber
protected int maxFileCount
protected int maxFileSize
Public Constructors
public FileHandler ()
public FileHandler (String baseFileName, int maxFileSize, int maxFileCount, boolean append)
Public Methods
public synchronized void configure (String propPrefix)
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".
Parameters
| propPrefix | String The partial properties key. |
|---|