Package com.microstrategy.utils.log

Class XmlApiFileHandler

java.lang.Object

com.microstrategy.utils.log.Handler

com.microstrategy.utils.log.StreamHandler

com.microstrategy.utils.log.XmlApiFileHandler

All Implemented Interfaces:

Configurable, Redirectable

public class XmlApiFileHandler
extends StreamHandler
implements Redirectable

Since:

MicroStrategy Web 9.0.0

Constructor Summary

Constructors

Constructor	Description
XmlApiFileHandler()
XmlApiFileHandler(java.lang.String _fileName, boolean _append)

Method Summary

Modifier and Type	Method	Description
void	configure(java.lang.String propPrefix)	Requests the configurable object to configure itself.
void	publish(LogRecord record)
void	redirect(java.lang.String value)

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

XmlApiFileHandler

public XmlApiFileHandler()

XmlApiFileHandler

public XmlApiFileHandler(java.lang.String _fileName,
                         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 Handler

Parameters:

propPrefix - String The partial properties key.

redirect

public void redirect(java.lang.String value)

Specified by:

redirect in interface Redirectable

publish

public void publish(LogRecord record)

Overrides:

publish in class StreamHandler