com.protomatter.syslog.xml
Class FileLog_Helper

java.lang.Object
  |
  +--com.protomatter.syslog.xml.BasicLogger_Helper
        |
        +--com.protomatter.syslog.xml.FileLog_Helper

All Implemented Interfaces:

XMLConfigHelper

public class FileLog_Helper

extends BasicLogger_Helper

XML configuration helper for FileLog.

Constructor Summary

FileLog_Helper()

Method Summary

void	configure(java.lang.Object o, org.jdom.Element e) Configure this logger given the XML element.
org.jdom.Element	getConfiguration(java.lang.Object o, org.jdom.Element element) Encode the given object's configuration into the given XML element.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileLog_Helper

public FileLog_Helper()

Method Detail

configure

public void configure(java.lang.Object o,
                      org.jdom.Element e)
               throws SyslogInitException

Configure this logger given the XML element. The <Logger> element should look like this:

  <Logger class="com.protomatter.syslog.FileLog" >

    <!--
     Config params from BasicLogger_Helper can
     get inserted here.
    -->

    <fileName>FileName</fileName>
    <append>true|false</append>
    <autoFlush>true|false</autoFlush>

  </Logger>
  

Element

name	value	required
fileName	The filename to write log entries to.	yes
append	true or false -- decide if the file should be appended to (or overwritten).	no (default is true)
autoFlush	true or false -- decide if we should flush the output buffer all the time or not. If this is set to false (the default), logging will be fast, but if set to true it will always be up-to-date.	no (default is false)

Overrides:

configure in class BasicLogger_Helper

Following copied from class: com.protomatter.syslog.xml.BasicLogger_Helper

See Also:

SimpleSyslogTextFormatter_Helper.configure(Object,Element), HTMLSyslogTextFormatter_Helper.configure(Object,Element), SimpleLogPolicy_Helper.configure(Object,Element), PerClassPolicy_Helper.configure(Object,Element)

getConfiguration

public org.jdom.Element getConfiguration(java.lang.Object o,
                                         org.jdom.Element element)

Description copied from interface: XMLConfigHelper

Encode the given object's configuration into the given XML element.

Overrides:

getConfiguration in class BasicLogger_Helper